GraphDB Utils API

Classes

GraphDBDocument

GraphDBDocumentArray ⇐ Array

GraphDBModel

Functions

createGraphDBModel(schema, schemaOptions) ⇒ GraphDBModel | function

Typedefs

SchemaOptions

GraphDBPropertyOptions

GraphDBDocument

Kind: global class

• GraphDBDocument
  • .data ⇒ Object
  • .schema ⇒ Object
  • .schemaOptions ⇒ GDSchemaOptions
  • .get(path) ⇒ undefined | GraphDBDocument | string | number | boolean
  • .set(path, obj) ⇒ undefined | GraphDBDocument | string | number | boolean
  • .markModified(key)
  • .populate(path) ⇒ Promise.<GraphDBDocument>
  • .toJSON() ⇒ object

graphDBDocument.data ⇒ Object

Get the document data.

Kind: instance property of GraphDBDocument

graphDBDocument.schema ⇒ Object

Get the document's model schema.

Kind: instance property of GraphDBDocument

graphDBDocument.schemaOptions ⇒ GDSchemaOptions

Get the document's model schemaOptions.

Kind: instance property of GraphDBDocument

graphDBDocument.get(path) ⇒ undefined | GraphDBDocument | string | number | boolean

Get a property of the document using path.

Kind: instance method of GraphDBDocument

Param	Type
path	string

Example

`doc.get('organization.primary_contact')`

graphDBDocument.set(path, obj) ⇒ undefined | GraphDBDocument | string | number | boolean

Set a property of the document using path.

Kind: instance method of GraphDBDocument

Param	Type
path	string
obj	*

Example

`doc.get('organization.primary_contact')`

graphDBDocument.markModified(key)

Kind: instance method of GraphDBDocument

Param	Type	Description
key	Array.<string> | string	The external key to mark modified.

graphDBDocument.populate(path) ⇒ Promise.<GraphDBDocument>

Populate a field by path, and return this GraphDBDocument.

Kind: instance method of GraphDBDocument

Param	Type	Description
path	string	Path to the field that will be populated, i.e. account.primary_contact

graphDBDocument.toJSON() ⇒ object

Override default JSON.stringify behavior.

Kind: instance method of GraphDBDocument

GraphDBDocumentArray ⇐ Array

Kind: global class
Extends: Array

• GraphDBDocumentArray ⇐ Array
  • new GraphDBDocumentArray()
  • .populate(path) ⇒ Promise.<GraphDBDocumentArray>
  • .populateMultiple(paths) ⇒ Promise.<GraphDBDocumentArray>

new GraphDBDocumentArray()

Performance optimized for multiple populates.

graphDBDocumentArray.populate(path) ⇒ Promise.<GraphDBDocumentArray>

populate a single property for every document.

Kind: instance method of GraphDBDocumentArray

Param	Type	Description
path	string	e.g. 'primary_contact'

graphDBDocumentArray.populateMultiple(paths) ⇒ Promise.<GraphDBDocumentArray>

Populate multiple properties for every document. Breadth first populate for combining queries.

Kind: instance method of GraphDBDocumentArray

Param	Type	Description
paths	Array.<string>	e.g. ['primary_contact', 'organization']

GraphDBModel

Kind: global class

• GraphDBModel
  • new GraphDBModel(data)
  • .createDocument(data) ⇒ GraphDBDocument
  • .generateCreationQuery(id, data) ⇒ Promise.<{footer: string, instanceName: string, innerQueryBodies: Array.<string>, header: string, queryBody: string}>
  • .findById(id, options) ⇒ Promise.<GraphDBDocument>
  • .findOne(filter, [options]) ⇒ Promise.<GraphDBDocument>
  • .findOneAndUpdate(filter, update) ⇒ Promise.<GraphDBDocument>
  • .findByIdAndUpdate(id, update) ⇒ Promise.<GraphDBDocument>
  • .findOneAndDelete(filter) ⇒ Promise.<GraphDBDocument>
  • .findByIdAndDelete(id) ⇒ Promise.<GraphDBDocument>

new GraphDBModel(data)

Create a document based on the model. Note: The constructor does not comply OOP since it is dynamically generated. Same as GraphDBModel.createDocument

Param	Type	Description
data	object	The data / properties in the new document

graphDBModel.createDocument(data) ⇒ GraphDBDocument

Create a document based on the model. Identical to Model(data)

Kind: instance method of GraphDBModel

Param	Type	Description
data	object	The data / properties in the new document

graphDBModel.generateCreationQuery(id, data) ⇒ Promise.<{footer: string, instanceName: string, innerQueryBodies: Array.<string>, header: string, queryBody: string}>

Generate creation query.

Kind: instance method of GraphDBModel

Param	Type
id	number | string
data

graphDBModel.findById(id, options) ⇒ Promise.<GraphDBDocument>

Find an document by ID in the model.

Kind: instance method of GraphDBModel
See: GraphDBModel.find for further information

Param	Type	Description
id	string | number	ID of the document, usually represents as _id
options	Object

Example

// Same as

(await Model.find({_id: id}, {populates}))[0];

// Find one document with _id = 1 and populate

Model.findById(1, {populates: ['primary_contact']});

graphDBModel.findOne(filter, [options]) ⇒ Promise.<GraphDBDocument>

Find one document in the model.

Kind: instance method of GraphDBModel
See: GraphDBModel.find for further information

Param	Type	Description
filter	Object	The filter
[options]	Object

Example

// Same as

await (Model.find(filter, {populates}))[0];

// Find one document and populate

Model.findOne({age: 50}, {populates: ['primary_contact']});

graphDBModel.findOneAndUpdate(filter, update) ⇒ Promise.<GraphDBDocument>

Find one document and update.

Kind: instance method of GraphDBModel

Param	Type	Description
filter	Object	The filter
update	Object	The Update to the found document

Example

// Find a document has _id = 1 and update the primary_contact.first_name to 'Lester'

// The document has smaller id will be updated if it finds multiple matched documents.

const doc = await Model.findOneAndUpdate({_id: 1}, {primary_contact: {first_name: 'Lester'}});

graphDBModel.findByIdAndUpdate(id, update) ⇒ Promise.<GraphDBDocument>

Find one document by ID and update

Kind: instance method of GraphDBModel

Param	Type	Description
id	string | number	The identifier
update	Object	The Update to the found document

Example

// Find a document has id = 1 and update the primary_contact.first_name to 'Lester'

const doc = await Model.findByIdAndUpdate(1, {primary_contact: {first_name: 'Lester'}});

graphDBModel.findOneAndDelete(filter) ⇒ Promise.<GraphDBDocument>

Find one document matched to the filter and delete.

Kind: instance method of GraphDBModel
Returns: Promise.<GraphDBDocument> - - The deleted document.

Param	Type	Description
filter	Object	The filter

Example

// Find one document have primary_contact.first_name equal to 'Lester' and delete it.

// The document with smaller id will be deleted if found multiple documents.

const doc = await Model.findOneAndDelete({primary_contact: {first_name: 'Lester'}});

graphDBModel.findByIdAndDelete(id) ⇒ Promise.<GraphDBDocument>

Find one document by ID and delete it.

Kind: instance method of GraphDBModel
Returns: Promise.<GraphDBDocument> - - The deleted document.

Param	Type	Description
id	string | number	The identifier

Example

// Find one document has id 1 and delete it.

const doc = await Model.findByIdAndDelete(1);

createGraphDBModel(schema, schemaOptions) ⇒ GraphDBModel | function

Kind: global function

Param	Type	Description
schema	object.<string, (GraphDBPropertyOptions|String|Number|Date|NamedIndividual|Boolean)>	GraphDBPropertyOptions
schemaOptions	SchemaOptions

SchemaOptions

Kind: global typedef
Properties

Name	Type	Description
name	string	The prefix of the created documents' identifier. e.g. if name="primary_contact", the new created document will have id :primary_contact_1
rdfTypes	Array.<string>	The list of value in rdf:type. e.g. [Types.NamedIndividual, ":primary_contact"] => some_instance rdf:type owl:NamedIndividual, :primary_contact.

Example

{name: 'primary_contact', rdfTypes: [Types.NamedIndividual, ':primary_contact']}

GraphDBPropertyOptions

Kind: global typedef
Properties

Name	Type	Default	Description
type	String | Number | Date | NamedIndividual | Boolean		Data type,
[prefix]	string	"has_"	The prefix add to each predicate,
[suffix]	string	"s"	For array datatype only, the suffix append to the external key,
[internalKey]	string	null	The internal key, internal keys are used in GraphDB,
[externalKey]	string	null	The external key, external keys are used in javascript. (documents, filters, populates)
[onDelete]	string	"DeleteType.NON_CASCADE"	The delete operation on nested models, default to non cascade.