Class DatastoreRequest

Handle logic for Datastore API operations. Handles request logic for Datastore.

Creates requests to the Datastore endpoint. Designed to be inherited by the Datastore and Transaction classes.

Package

@google-cloud/datastore!

Properties

datastore

datastore: Datastore;

Property Value

Type	Description
Datastore

id

id: string | undefined;

Property Value

Type	Description
string \| undefined

requestCallbacks_

requestCallbacks_: Array<(err: Error | null, resp: Entity | null) => void> | Entity;

Property Value

Type	Description
Array<(err: Error \| null, resp: Entity \| null) => void> \| Entity

requests_

requests_: Entity | {
        mutations: Array<{}>;
    };

Property Value

Type	Description
Entity \| { mutations: Array<{}>; }

Methods

allocateIds(key, options)

allocateIds(key: entity.Key, options: AllocateIdsOptions | number): Promise<AllocateIdsResponse>;

Parameters

Type	Name	Description
entity.Key	key
AllocateIdsOptions \| number	options

Returns

Type	Description
Promise<AllocateIdsResponse>

allocateIds(key, options, callback)

allocateIds(key: entity.Key, options: AllocateIdsOptions | number, callback: AllocateIdsCallback): void;

Parameters

Type	Name	Description
entity.Key	key
AllocateIdsOptions \| number	options
AllocateIdsCallback	callback

Returns

Type	Description
void

createReadStream(keys, options)

createReadStream(keys: Entities, options?: CreateReadStreamOptions): Transform;

Retrieve the entities as a readable object stream.

Parameters

Type	Name	Description
Entities	keys	Datastore key object(s).
CreateReadStreamOptions	options	Optional configuration. See for a complete list of options.

Returns

Type	Description
Transform

delete(keys, gaxOptions)

delete(keys: Entities, gaxOptions?: CallOptions): Promise<DeleteResponse>;

Parameters

Type	Name	Description
Entities	keys
CallOptions	gaxOptions

Returns

Type	Description
Promise<DeleteResponse>

delete(keys, callback)

delete(keys: Entities, callback: DeleteCallback): void;

Parameters

Type	Name	Description
Entities	keys
DeleteCallback	callback

Returns

Type	Description
void

delete(keys, gaxOptions, callback)

delete(keys: Entities, gaxOptions: CallOptions, callback: DeleteCallback): void;

Parameters

Type	Name	Description
Entities	keys
CallOptions	gaxOptions
DeleteCallback	callback

Returns

Type	Description
void

get(keys, options)

get(keys: entity.Key | entity.Key[], options?: CreateReadStreamOptions): Promise<GetResponse>;

Parameters

Type	Name	Description
entity.Key \| entity.Key[]	keys
CreateReadStreamOptions	options

Returns

Type	Description
Promise<GetResponse>

get(keys, callback)

get(keys: entity.Key | entity.Key[], callback: GetCallback): void;

Parameters

Type	Name	Description
entity.Key \| entity.Key[]	keys
GetCallback	callback

Returns

Type	Description
void

get(keys, options, callback)

get(keys: entity.Key | entity.Key[], options: CreateReadStreamOptions, callback: GetCallback): void;

Parameters

Type	Name	Description
entity.Key \| entity.Key[]	keys
CreateReadStreamOptions	options
GetCallback	callback

Returns

Type	Description
void

merge(entities)

merge(entities: Entities): Promise<CommitResponse>;

Parameter

Type	Name	Description
Entities	entities

Returns

Type	Description
Promise<CommitResponse>

merge(entities, callback)

merge(entities: Entities, callback: SaveCallback): void;

Parameters

Type	Name	Description
Entities	entities
SaveCallback	callback

Returns

Type	Description
void

prepareEntityObject_(obj)

static prepareEntityObject_(obj: Entity): PrepareEntityObjectResponse;

Format a user's input to mutation methods. This will create a deep clone of the input, as well as allow users to pass an object in the format of an entity.

Both of the following formats can be supplied supported:

datastore.save({ key: datastore.key('Kind'), data: { foo: 'bar' } }, (err) => {})

const entity = { foo: 'bar' } entity[datastore.KEY] = datastore.key('Kind') datastore.save(entity, (err) => {})

[#1803]https://github.com/GoogleCloudPlatform/google-cloud-node/issues/1803

Parameter

Type	Name	Description
Entity	obj	The user's input object.

Returns

Type	Description
PrepareEntityObjectResponse

prepareGaxRequest_(config, callback)

prepareGaxRequest_(config: RequestConfig, callback: Function): void;

Parameters

Type	Name	Description
RequestConfig	config
Function	callback

Returns

Type	Description
void

request_(config, callback)

request_(config: RequestConfig, callback: RequestCallback): void;

Parameters

Type	Name	Description
RequestConfig	config
RequestCallback	callback

Returns

Type	Description
void

requestStream_(config)

requestStream_(config: RequestConfig): AbortableDuplex;

Make a request as a stream.

Parameter

Type	Name	Description
RequestConfig	config	Configuration object.

Returns

Type	Description
AbortableDuplex

runQuery(query, options)

runQuery(query: Query, options?: RunQueryOptions): Promise<RunQueryResponse>;

Parameters

Type	Name	Description
Query	query
RunQueryOptions	options

Returns

Type	Description
Promise<RunQueryResponse>

runQuery(query, options, callback)

runQuery(query: Query, options: RunQueryOptions, callback: RunQueryCallback): void;

Parameters

Type	Name	Description
Query	query
RunQueryOptions	options
RunQueryCallback	callback

Returns

Type	Description
void

runQuery(query, callback)

runQuery(query: Query, callback: RunQueryCallback): void;

Parameters

Type	Name	Description
Query	query
RunQueryCallback	callback

Returns

Type	Description
void

runQueryStream(query, options)

runQueryStream(query: Query, options?: RunQueryStreamOptions): Transform;

Get a list of entities as a readable object stream.

See for a list of all available options.

Parameters

Type	Name	Description
Query	query	Query object.
RunQueryStreamOptions	options	Optional configuration.

Returns

Type	Description
Transform