Send feedback
Class DatastoreClient Stay organized with collections
Save and categorize content based on your preferences.
Version 6.5.0 keyboard_arrow_down
Each RPC normalizes the partition IDs of the keys in its input entities, and always returns entities with keys with normalized partition IDs. This applies to all keys and entities, including those in values, except keys with both an empty path and an empty or unset partition ID. Normalization of input keys sets the project ID (if not already set) to the project ID from the request.
v1
Package
@google-cloud/datastore
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of DatastoreClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
datastoreStub
datastoreStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
Methods
allocateIds(request, options)
allocateIds
(
request
?:
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
IAllocateIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.IAllocateIdsRequest
options
CallOptions
Returns
allocateIds(request, options, callback)
allocateIds
(
request
:
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IAllocateIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IAllocateIdsRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.IAllocateIdsResponse
, protos. google.datastore.v1.IAllocateIdsRequest
| null | undefined, {} | null | undefined>
Returns
allocateIds(request, callback)
allocateIds
(
request
:
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IAllocateIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IAllocateIdsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IAllocateIdsRequest
callback
Callback
<protos. google.datastore.v1.IAllocateIdsResponse
, protos. google.datastore.v1.IAllocateIdsRequest
| null | undefined, {} | null | undefined>
Returns
beginTransaction(request, options)
beginTransaction
(
request
?:
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
IBeginTransactionResponse
,
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.IBeginTransactionRequest
options
CallOptions
Returns
beginTransaction(request, options, callback)
beginTransaction
(
request
:
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IBeginTransactionResponse
,
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IBeginTransactionRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.IBeginTransactionResponse
, protos. google.datastore.v1.IBeginTransactionRequest
| null | undefined, {} | null | undefined>
Returns
beginTransaction(request, callback)
beginTransaction
(
request
:
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IBeginTransactionResponse
,
protos
.
google
.
datastore
.
v1
.
IBeginTransactionRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IBeginTransactionRequest
callback
Callback
<protos. google.datastore.v1.IBeginTransactionResponse
, protos. google.datastore.v1.IBeginTransactionRequest
| null | undefined, {} | null | undefined>
Returns
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
commit(request, options)
commit
(
request
?:
protos
.
google
.
datastore
.
v1
.
ICommitRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
ICommitResponse
,
protos
.
google
.
datastore
.
v1
.
ICommitRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.ICommitRequest
options
CallOptions
Returns
commit(request, options, callback)
commit
(
request
:
protos
.
google
.
datastore
.
v1
.
ICommitRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
ICommitResponse
,
protos
.
google
.
datastore
.
v1
.
ICommitRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.ICommitRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.ICommitResponse
, protos. google.datastore.v1.ICommitRequest
| null | undefined, {} | null | undefined>
Returns
commit(request, callback)
commit
(
request
:
protos
.
google
.
datastore
.
v1
.
ICommitRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
ICommitResponse
,
protos
.
google
.
datastore
.
v1
.
ICommitRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.ICommitRequest
callback
Callback
<protos. google.datastore.v1.ICommitResponse
, protos. google.datastore.v1.ICommitRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
lookup(request, options)
lookup
(
request
?:
protos
.
google
.
datastore
.
v1
.
ILookupRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
ILookupResponse
,
protos
.
google
.
datastore
.
v1
.
ILookupRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.ILookupRequest
options
CallOptions
Returns
lookup(request, options, callback)
lookup
(
request
:
protos
.
google
.
datastore
.
v1
.
ILookupRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
ILookupResponse
,
protos
.
google
.
datastore
.
v1
.
ILookupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.ILookupRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.ILookupResponse
, protos. google.datastore.v1.ILookupRequest
| null | undefined, {} | null | undefined>
Returns
lookup(request, callback)
lookup
(
request
:
protos
.
google
.
datastore
.
v1
.
ILookupRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
ILookupResponse
,
protos
.
google
.
datastore
.
v1
.
ILookupRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.ILookupRequest
callback
Callback
<protos. google.datastore.v1.ILookupResponse
, protos. google.datastore.v1.ILookupRequest
| null | undefined, {} | null | undefined>
Returns
reserveIds(request, options)
reserveIds
(
request
?:
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
IReserveIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.IReserveIdsRequest
options
CallOptions
Returns
reserveIds(request, options, callback)
reserveIds
(
request
:
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IReserveIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IReserveIdsRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.IReserveIdsResponse
, protos. google.datastore.v1.IReserveIdsRequest
| null | undefined, {} | null | undefined>
Returns
reserveIds(request, callback)
reserveIds
(
request
:
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IReserveIdsResponse
,
protos
.
google
.
datastore
.
v1
.
IReserveIdsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IReserveIdsRequest
callback
Callback
<protos. google.datastore.v1.IReserveIdsResponse
, protos. google.datastore.v1.IReserveIdsRequest
| null | undefined, {} | null | undefined>
Returns
rollback(request, options)
rollback
(
request
?:
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
IRollbackResponse
,
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.IRollbackRequest
options
CallOptions
Returns
rollback(request, options, callback)
rollback
(
request
:
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IRollbackResponse
,
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IRollbackRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.IRollbackResponse
, protos. google.datastore.v1.IRollbackRequest
| null | undefined, {} | null | undefined>
Returns
rollback(request, callback)
rollback
(
request
:
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IRollbackResponse
,
protos
.
google
.
datastore
.
v1
.
IRollbackRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IRollbackRequest
callback
Callback
<protos. google.datastore.v1.IRollbackResponse
, protos. google.datastore.v1.IRollbackRequest
| null | undefined, {} | null | undefined>
Returns
runQuery(request, options)
runQuery
(
request
?:
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
datastore
.
v1
.
IRunQueryResponse
,
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.datastore.v1.IRunQueryRequest
options
CallOptions
Returns
runQuery(request, options, callback)
runQuery
(
request
:
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IRunQueryResponse
,
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IRunQueryRequest
options
CallOptions
callback
Callback
<protos. google.datastore.v1.IRunQueryResponse
, protos. google.datastore.v1.IRunQueryRequest
| null | undefined, {} | null | undefined>
Returns
runQuery(request, callback)
runQuery
(
request
:
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
,
callback
:
Callback<protos
.
google
.
datastore
.
v1
.
IRunQueryResponse
,
protos
.
google
.
datastore
.
v1
.
IRunQueryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.datastore.v1.IRunQueryRequest
callback
Callback
<protos. google.datastore.v1.IRunQueryResponse
, protos. google.datastore.v1.IRunQueryRequest
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]