Datastore

google.datastore.v1. Datastore

Represents a Datastore

Constructor

new Datastore(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Datastore service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

allocateIds(request, callback) → {undefined}

Calls AllocateIds.

Parameters:
Name Type Description
request google.datastore.v1.IAllocateIdsRequest

AllocateIdsRequest message or plain object

callback google.datastore.v1.Datastore.AllocateIdsCallback

Node-style callback called with the error, if any, and AllocateIdsResponse

Returns:
Type Description
undefined

allocateIds(request) → {Promise.<google.datastore.v1.AllocateIdsResponse>}

Calls AllocateIds.

Parameters:
Name Type Description
request google.datastore.v1.IAllocateIdsRequest

AllocateIdsRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.AllocateIdsResponse>

Promise

beginTransaction(request, callback) → {undefined}

Calls BeginTransaction.

Parameters:
Name Type Description
request google.datastore.v1.IBeginTransactionRequest

BeginTransactionRequest message or plain object

callback google.datastore.v1.Datastore.BeginTransactionCallback

Node-style callback called with the error, if any, and BeginTransactionResponse

Returns:
Type Description
undefined

beginTransaction(request) → {Promise.<google.datastore.v1.BeginTransactionResponse>}

Calls BeginTransaction.

Parameters:
Name Type Description
request google.datastore.v1.IBeginTransactionRequest

BeginTransactionRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.BeginTransactionResponse>

Promise

commit(request, callback) → {undefined}

Calls Commit.

Parameters:
Name Type Description
request google.datastore.v1.ICommitRequest

CommitRequest message or plain object

callback google.datastore.v1.Datastore.CommitCallback

Node-style callback called with the error, if any, and CommitResponse

Returns:
Type Description
undefined

commit(request) → {Promise.<google.datastore.v1.CommitResponse>}

Calls Commit.

Parameters:
Name Type Description
request google.datastore.v1.ICommitRequest

CommitRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.CommitResponse>

Promise

lookup(request, callback) → {undefined}

Calls Lookup.

Parameters:
Name Type Description
request google.datastore.v1.ILookupRequest

LookupRequest message or plain object

callback google.datastore.v1.Datastore.LookupCallback

Node-style callback called with the error, if any, and LookupResponse

Returns:
Type Description
undefined

lookup(request) → {Promise.<google.datastore.v1.LookupResponse>}

Calls Lookup.

Parameters:
Name Type Description
request google.datastore.v1.ILookupRequest

LookupRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.LookupResponse>

Promise

reserveIds(request, callback) → {undefined}

Calls ReserveIds.

Parameters:
Name Type Description
request google.datastore.v1.IReserveIdsRequest

ReserveIdsRequest message or plain object

callback google.datastore.v1.Datastore.ReserveIdsCallback

Node-style callback called with the error, if any, and ReserveIdsResponse

Returns:
Type Description
undefined

reserveIds(request) → {Promise.<google.datastore.v1.ReserveIdsResponse>}

Calls ReserveIds.

Parameters:
Name Type Description
request google.datastore.v1.IReserveIdsRequest

ReserveIdsRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.ReserveIdsResponse>

Promise

rollback(request, callback) → {undefined}

Calls Rollback.

Parameters:
Name Type Description
request google.datastore.v1.IRollbackRequest

RollbackRequest message or plain object

callback google.datastore.v1.Datastore.RollbackCallback

Node-style callback called with the error, if any, and RollbackResponse

Returns:
Type Description
undefined

rollback(request) → {Promise.<google.datastore.v1.RollbackResponse>}

Calls Rollback.

Parameters:
Name Type Description
request google.datastore.v1.IRollbackRequest

RollbackRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.RollbackResponse>

Promise

runAggregationQuery(request, callback) → {undefined}

Calls RunAggregationQuery.

Parameters:
Name Type Description
request google.datastore.v1.IRunAggregationQueryRequest

RunAggregationQueryRequest message or plain object

callback google.datastore.v1.Datastore.RunAggregationQueryCallback

Node-style callback called with the error, if any, and RunAggregationQueryResponse

Returns:
Type Description
undefined

runAggregationQuery(request) → {Promise.<google.datastore.v1.RunAggregationQueryResponse>}

Calls RunAggregationQuery.

Parameters:
Name Type Description
request google.datastore.v1.IRunAggregationQueryRequest

RunAggregationQueryRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.RunAggregationQueryResponse>

Promise

runQuery(request, callback) → {undefined}

Calls RunQuery.

Parameters:
Name Type Description
request google.datastore.v1.IRunQueryRequest

RunQueryRequest message or plain object

callback google.datastore.v1.Datastore.RunQueryCallback

Node-style callback called with the error, if any, and RunQueryResponse

Returns:
Type Description
undefined

runQuery(request) → {Promise.<google.datastore.v1.RunQueryResponse>}

Calls RunQuery.

Parameters:
Name Type Description
request google.datastore.v1.IRunQueryRequest

RunQueryRequest message or plain object

Returns:
Type Description
Promise.<google.datastore.v1.RunQueryResponse>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Datastore}

Creates new Datastore service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean <optional>
false

Whether requests are length-delimited

responseDelimited boolean <optional>
false

Whether responses are length-delimited

Returns:
Type Description
Datastore

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AllocateIdsCallback(error, responseopt)

Callback as used by allocateIds.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.AllocateIdsResponse <optional>

AllocateIdsResponse

BeginTransactionCallback(error, responseopt)

Callback as used by beginTransaction.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.BeginTransactionResponse <optional>

BeginTransactionResponse

CommitCallback(error, responseopt)

Callback as used by commit.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.CommitResponse <optional>

CommitResponse

LookupCallback(error, responseopt)

Callback as used by lookup.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.LookupResponse <optional>

LookupResponse

ReserveIdsCallback(error, responseopt)

Callback as used by reserveIds.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.ReserveIdsResponse <optional>

ReserveIdsResponse

RollbackCallback(error, responseopt)

Callback as used by rollback.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.RollbackResponse <optional>

RollbackResponse

RunAggregationQueryCallback(error, responseopt)

Callback as used by runAggregationQuery.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.RunAggregationQueryResponse <optional>

RunAggregationQueryResponse

RunQueryCallback(error, responseopt)

Callback as used by runQuery.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.datastore.v1.RunQueryResponse <optional>

RunQueryResponse