Build a Query object.
**Queries are built with {module:datastore#createQuery} and .**
[Datastore Queries]http://goo.gl/Cag0r6
Package
@google-cloud/datastore!
Constructors
(constructor)(scope, kinds)
constructor(scope?: Datastore | Transaction, kinds?: string[] | null);
Constructs a new instance of the Query
class
Parameters
Type | Name | Description |
---|
Datastore | Transaction | scope |
|
string[] | null | kinds |
|
(constructor)(scope, namespace, kinds)
constructor(scope?: Datastore | Transaction, namespace?: string | null, kinds?: string[]);
Constructs a new instance of the Query
class
Parameters
Type | Name | Description |
---|
Datastore | Transaction | scope |
|
string | null | namespace |
|
string[] | kinds |
|
Properties
endVal
endVal: string | Buffer | null;
Property Value
Type | Description |
---|
string | Buffer | null | |
filters
Property Value
groupByVal
Property Value
kinds
Property Value
limitVal
Property Value
namespace
namespace?: string | null;
Property Value
Type | Description |
---|
string | null | |
offsetVal
Property Value
orders
Property Value
scope
scope?: Datastore | Transaction;
Property Value
Type | Description |
---|
Datastore | Transaction | |
selectVal
Property Value
startVal
startVal: string | Buffer | null;
Property Value
Type | Description |
---|
string | Buffer | null | |
Methods
end(end)
end(end: string | Buffer): this;
Parameter
Type | Name | Description |
---|
string | Buffer | end |
|
Returns
Type | Description |
---|
this | {Query}
|
filter(property, value)
filter(property: string, value: {}): Query;
Parameters
Type | Name | Description |
---|
string | property |
|
{} | value |
|
Returns
filter(property, operator, value)
filter(property: string, operator: Operator, value: {}): Query;
Parameters
Type | Name | Description |
---|
string | property |
|
Operator | operator |
|
{} | value |
|
Returns
groupBy(fieldNames)
groupBy(fieldNames: string | string[]): this;
Group query results by a list of properties.
Parameter
Type | Name | Description |
---|
string | string[] | fieldNames |
|
Returns
Type | Description |
---|
this | {Query}
|
hasAncestor(key)
hasAncestor(key: Key): this;
Parameter
Type | Name | Description |
---|
Key | key |
Key object to filter by.
|
Returns
Type | Description |
---|
this | {Query}
|
limit(n)
Parameter
Type | Name | Description |
---|
number | n |
The number of results to limit the query to.
|
Returns
Type | Description |
---|
this | {Query}
|
offset(n)
Parameter
Type | Name | Description |
---|
number | n |
The offset to start from after the start cursor.
|
Returns
Type | Description |
---|
this | {Query}
|
order(property, options)
order(property: string, options?: OrderOptions): this;
Parameters
Type | Name | Description |
---|
string | property |
The property to order by.
|
OrderOptions | options |
Options object.
|
Returns
Type | Description |
---|
this | {Query}
|
run(options)
run(options?: RunQueryOptions): Promise<RunQueryResponse>;
Parameter
Type | Name | Description |
---|
RunQueryOptions | options |
|
Returns
Type | Description |
---|
Promise<RunQueryResponse> | |
run(options, callback)
run(options: RunQueryOptions, callback: RunQueryCallback): void;
Parameters
Type | Name | Description |
---|
RunQueryOptions | options |
|
RunQueryCallback | callback |
|
Returns
run(callback)
run(callback: RunQueryCallback): void;
Parameter
Type | Name | Description |
---|
RunQueryCallback | callback |
|
Returns
runStream(options)
runStream(options?: RunQueryStreamOptions): import("stream").Transform;
Run the query as a readable object stream.
Query#runStream
Parameter
Type | Name | Description |
---|
RunQueryStreamOptions | options |
Optional configuration. See for a complete list of options.
|
Returns
Type | Description |
---|
import("stream").internal.Transform | {stream}
|
select(fieldNames)
select(fieldNames: string | string[]): this;
Parameter
Type | Name | Description |
---|
string | string[] | fieldNames |
Properties to return from the matched entities.
|
Returns
Type | Description |
---|
this | {Query}
|
start(start)
start(start: string | Buffer): this;
Parameter
Type | Name | Description |
---|
string | Buffer | start |
|
Returns
Type | Description |
---|
this | {Query}
|