Home Reference Source

Typedef

Static Public Summary
public
public

Query options object
public

Relationship definition object

Static Public

Properties:

NameTypeAttributeDescription
start String
  • optional

Reference to the start node (defaults to 'n')
end String

Reference to the end node
singular Boolean
  • optional

Only one result per record is returned (eg. when using scalar values or by using collect)

public QueryOptions: Object source

Query options object

Properties:

NameTypeAttributeDescription
parameters Object<String, *>
  • optional

Parameters used in the query.
variable String
  • optional

The variable used to identify the Node in the query, 'n' by default.
variables Array
  • optional

All variables used in the query that should be added to the results.
where String | Array
  • optional

The where clause, arrays are joined by the 'AND' operator.
limit Number
  • optional

The maximum number of results to be returned
with String
  • optional

The name of relationship to include, use the dot-notation to include multiple levels
with Array
  • optional

An array of names of relationships to include
with Object<String, Boolean|Object>
  • optional

Relationships to include (true) or exclude (false) or filter(object)
links Object<String, NodeLink>
  • optional

Linked results to connect to this model

public RelationshipDefinition: object source

Relationship definition object

Properties:

NameTypeAttributeDescription
Model Node | function

Relationship.Model
type string

Relationship.type
direction string

Relationship.direction
singular boolean

Relationship.singular