Console
    Contact Us Start free

    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
    Name Description
    key entity.Key
    options AllocateIdsOptions | number
    Returns
    Type Description
    Promise < AllocateIdsResponse >

    allocateIds(key, options, callback)

      allocateIds 
 ( 
 key 
 : 
  
 entity 
 . 
 Key 
 , 
  
 options 
 : 
  
 AllocateIdsOptions 
  
 | 
  
 number 
 , 
  
 callback 
 : 
  
 AllocateIdsCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    key entity.Key
    options AllocateIdsOptions | number
    callback AllocateIdsCallback
    Returns
    Type Description
    void

    createReadStream(keys, options)

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

    Retrieve the entities as a readable object stream.

    Parameters
    Name Description
    keys Entities

    Datastore key object(s).
    options CreateReadStreamOptions

    Optional configuration. See for a complete list of options.
    Returns
    Type Description
    Transform

    delete(keys, gaxOptions)

      delete 
 ( 
 keys 
 : 
  
 Entities 
 , 
  
 gaxOptions 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise<DeleteResponse> 
 ;
    Parameters
    Name Description
    keys Entities
    gaxOptions CallOptions
    Returns
    Type Description
    Promise < DeleteResponse >

    delete(keys, callback)

      delete 
 ( 
 keys 
 : 
  
 Entities 
 , 
  
 callback 
 : 
  
 DeleteCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    keys Entities
    callback DeleteCallback
    Returns
    Type Description
    void

    delete(keys, gaxOptions, callback)

      delete 
 ( 
 keys 
 : 
  
 Entities 
 , 
  
 gaxOptions 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 DeleteCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    keys Entities
    gaxOptions CallOptions
    callback DeleteCallback
    Returns
    Type Description
    void

    get(keys, options)

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

    get(keys, callback)

      get 
 ( 
 keys 
 : 
  
 entity 
 . 
 Key 
  
 | 
  
 entity 
 . 
 Key 
 [], 
  
 callback 
 : 
  
 GetCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    keys entity.Key | entity.Key []
    callback GetCallback
    Returns
    Type Description
    void

    get(keys, options, callback)

      get 
 ( 
 keys 
 : 
  
 entity 
 . 
 Key 
  
 | 
  
 entity 
 . 
 Key 
 [], 
  
 options 
 : 
  
 CreateReadStreamOptions 
 , 
  
 callback 
 : 
  
 GetCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    keys entity.Key | entity.Key []
    options CreateReadStreamOptions
    callback GetCallback
    Returns
    Type Description
    void

    merge(entities)

      merge 
 ( 
 entities 
 : 
  
 Entities 
 ) 
 : 
  
 Promise<CommitResponse> 
 ;
    Parameter
    Name Description
    entities Entities
    Returns
    Type Description
    Promise < CommitResponse >

    merge(entities, callback)

      merge 
 ( 
 entities 
 : 
  
 Entities 
 , 
  
 callback 
 : 
  
 SaveCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    entities Entities
    callback SaveCallback
    Returns
    Type Description
    void

    prepareGaxRequest_(config, callback)

      prepareGaxRequest_ 
 ( 
 config 
 : 
  
 RequestConfig 
 , 
  
 callback 
 : 
  
 Function 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    config RequestConfig
    callback Function
    Returns
    Type Description
    void

    request_(config, callback)

      request_ 
 ( 
 config 
 : 
  
 RequestConfig 
 , 
  
 callback 
 : 
  
 RequestCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    config RequestConfig
    callback RequestCallback
    Returns
    Type Description
    void

    requestStream_(config)

      requestStream_ 
 ( 
 config 
 : 
  
 RequestConfig 
 ) 
 : 
  
 AbortableDuplex 
 ;

    Make a request as a stream.

    Parameter
    Name Description
    config RequestConfig

    Configuration object.
    Returns
    Type Description
    AbortableDuplex

    runQuery(query, options)

      runQuery 
 ( 
 query 
 : 
  
 Query 
 , 
  
 options 
 ?: 
  
 RunQueryOptions 
 ) 
 : 
  
 Promise<RunQueryResponse> 
 ;
    Parameters
    Name Description
    query Query
    options RunQueryOptions
    Returns
    Type Description
    Promise < RunQueryResponse >

    runQuery(query, options, callback)

      runQuery 
 ( 
 query 
 : 
  
 Query 
 , 
  
 options 
 : 
  
 RunQueryOptions 
 , 
  
 callback 
 : 
  
 RunQueryCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    query Query
    options RunQueryOptions
    callback RunQueryCallback
    Returns
    Type Description
    void

    runQuery(query, callback)

      runQuery 
 ( 
 query 
 : 
  
 Query 
 , 
  
 callback 
 : 
  
 RunQueryCallback 
 ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    query Query
    callback RunQueryCallback
    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
    Name Description
    query Query

    Query object.
    options RunQueryStreamOptions

    Optional configuration.
    Returns
    Type Description
    Transform
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: