new OGMNeoRelationQuery(typeopt)
Constructs a query object with a relation type.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
type |
string |
<optional> |
null | The relation name to filter. |
- Source:
Members
type :string
Relation type name constraint.
Type:
- string
- Source:
Methods
(static) create(typeopt) → {OGMNeoRelationQuery}
Convenience method that creates a query object with a relation type.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
type |
string |
<optional> |
null | The relation name to filter. |
- Source:
Returns:
Created query.
- Type
- OGMNeoRelationQuery
ascOrderBy(properties) → {OGMNeoRelationQuery}
Add ASCENDING order by clause to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties in order to order by for. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
descOrderBy(properties) → {OGMNeoRelationQuery}
Add DESCENDING order by clause to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties in order to order by for. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
endNode(nodeId, label) → {OGMNeoRelationQuery}
Add ID and Label constraints to the endNode.
Parameters:
| Name | Type | Description |
|---|---|---|
nodeId |
integer | Node id constraint. |
label |
string | Label constraint. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
endNodeWhere(where) → {OGMNeoRelationQuery}
Add endNode where constraint to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
where |
OGMNeoWhere | The query constraints that will be applied to endNode properties. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
limit(value) → {OGMNeoRelationQuery}
Add limit constraint to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
integer | The max number of values that should be returned. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
matchCypher() → {string}
Builde cypher match cypher clause.
- Source:
Returns:
This return an match cypher based on this query.
- Type
- string
relationWhere(where) → {OGMNeoRelationQuery}
Add relation where constraint to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
where |
OGMNeoWhere | The query constraints that will be applied to relation properties. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
returnEndNode(properties) → {OGMNeoRelationQuery}
Propreties that must be returned for the end node.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties that can be a string if was just one or an array of string for many. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
returnRelationNode(properties) → {OGMNeoRelationQuery}
Propreties that must be returned for the relation node.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties that can be a string if was just one or an array of string for many. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
returnStartNode(properties) → {OGMNeoRelationQuery}
Propreties that must be returned for the start node.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties that can be a string if was just one or an array of string for many. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
startNode(nodeId, label) → {OGMNeoRelationQuery}
Add ID and Label constraints to the startNode.
Parameters:
| Name | Type | Description |
|---|---|---|
nodeId |
integer | Node id constraint. |
label |
string | Label constraint. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
startNodeWhere(where) → {OGMNeoRelationQuery}
Add startNode where constraint to this query object.
Parameters:
| Name | Type | Description |
|---|---|---|
where |
OGMNeoWhere | The query constraints that will be applied to startNode properties. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoRelationQuery
whereCypher() → {string}
Build cypher where cypher clause.
- Source:
Returns:
This return an match cypher based on this query.
- Type
- string