new OGMNeoQuery(labelopt)
Constructs a query object with an label.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
label |
string |
<optional> |
The query to filter nodes that have to be returned. |
- Source:
Members
label :string
Type:
- string
- Source:
whereObject :OGMNeoWhere
Type:
- Source:
Methods
(static) create(labelopt) → {OGMNeoQuery}
Convenience method that creates a query object with an label.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
label |
string |
<optional> |
The query to filter nodes that have to be returned. |
- Source:
Returns:
Created query with label.
- Type
- OGMNeoQuery
ascOrderBy(properties) → {OGMNeoQuery}
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
- OGMNeoQuery
countCypher() → {string}
Return cypher query string for count that represents this query.
- Source:
Returns:
Cypher count match string.
- Type
- string
descOrderBy(properties) → {OGMNeoQuery}
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
- OGMNeoQuery
limit(value) → {OGMNeoQuery}
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
- OGMNeoQuery
matchCypher() → {string}
Return ONLY MATCH cypher statement string that represents this query.
- Source:
Returns:
Cypher match query.
- Type
- string
queryCypher() → {string}
Return full cypher query string related to this query.
- Source:
Returns:
Cypher query.
- Type
- string
return(properties) → {OGMNeoQuery}
Add the properties that must be returned in the objects.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
string | array | The properties that must to be returned. |
- Source:
Returns:
This instance of query.
- Type
- OGMNeoQuery