Class DatastoreClient (8.4.0)

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Required. A list of keys with incomplete key paths for which to allocate 
 *  IDs. No key may be reserved/read-only. 
 */ 
  
 // const keys = [1,2,3,4] 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callAllocateIds 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 keys 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
 allocateIds 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callAllocateIds 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Options for a new transaction. 
 */ 
  
 // const transactionOptions = {} 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callBeginTransaction 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
  beginTransaction 
 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callBeginTransaction 
 (); 
 

  const 
  
 client 
  
 = 
  
 longrunning 
 . 
 operationsClient 
 (); 
 await 
  
 client 
 . 
 cancelOperation 
 ({ 
 name 
 : 
  
 '' 
 }); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  The type of commit to perform. Defaults to `TRANSACTIONAL`. 
 */ 
  
 // const mode = {} 
  
 /** 
 *  The identifier of the transaction associated with the commit. A 
 *  transaction identifier is returned by a call to 
 *  Datastore.BeginTransaction google.datastore.v1.Datastore.BeginTransaction. 
 */ 
  
 // const transaction = Buffer.from('string') 
  
 /** 
 *  Options for beginning a new transaction for this request. 
 *  The transaction is committed when the request completes. If specified, 
 *  TransactionOptions.mode google.datastore.v1.TransactionOptions  must be 
 *  TransactionOptions.ReadWrite google.datastore.v1.TransactionOptions.ReadWrite. 
 */ 
  
 // const singleUseTransaction = {} 
  
 /** 
 *  The mutations to perform. 
 *  When mode is `TRANSACTIONAL`, mutations affecting a single entity are 
 *  applied in order. The following sequences of mutations affecting a single 
 *  entity are not permitted in a single `Commit` request: 
 *  - `insert` followed by `insert` 
 *  - `update` followed by `insert` 
 *  - `upsert` followed by `insert` 
 *  - `delete` followed by `update` 
 *  When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single 
 *  entity. 
 */ 
  
 // const mutations = [1,2,3,4] 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callCommit 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
 commit 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCommit 
 (); 
 

  const 
  
 client 
  
 = 
  
 longrunning 
 . 
 operationsClient 
 (); 
 await 
  
 client 
 . 
 deleteOperation 
 ({ 
 name 
 : 
  
 '' 
 }); 
 

  const 
  
 client 
  
 = 
  
 longrunning 
 . 
 operationsClient 
 (); 
 const 
  
 name 
  
 = 
  
 '' 
 ; 
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 getOperation 
 ({ 
 name 
 }); 
 // doThingsWith(response) 
 

  const 
  
 client 
  
 = 
  
 longrunning 
 . 
 operationsClient 
 (); 
 for 
  
 await 
  
 ( 
 const 
  
 response 
  
 of 
  
 client 
 . 
 listOperationsAsync 
 ( 
 request 
 )); 
 // doThingsWith(response) 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  The options for this lookup request. 
 */ 
  
 // const readOptions = {} 
  
 /** 
 *  Required. Keys of entities to look up. 
 */ 
  
 // const keys = [1,2,3,4] 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callLookup 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 keys 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
  lookup 
 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callLookup 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Required. A list of keys with complete key paths whose numeric IDs should 
 *  not be auto-allocated. 
 */ 
  
 // const keys = [1,2,3,4] 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callReserveIds 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 keys 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
  reserveIds 
 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callReserveIds 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Required. The transaction identifier, returned by a call to 
 *  Datastore.BeginTransaction google.datastore.v1.Datastore.BeginTransaction. 
 */ 
  
 // const transaction = Buffer.from('string') 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callRollback 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 transaction 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
 rollback 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRollback 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Entities are partitioned into subsets, identified by a partition ID. 
 *  Queries are scoped to a single partition. 
 *  This partition ID is normalized with the standard default context 
 *  partition ID. 
 */ 
  
 // const partitionId = {} 
  
 /** 
 *  The options for this query. 
 */ 
  
 // const readOptions = {} 
  
 /** 
 *  The query to run. 
 */ 
  
 // const aggregationQuery = {} 
  
 /** 
 *  The GQL query to run. This query must be an aggregation query. 
 */ 
  
 // const gqlQuery = {} 
  
 /** 
 *  Optional. The mode in which the query request is processed. This field is 
 *  optional, and when not provided, it defaults to `NORMAL` mode where no 
 *  additional statistics will be returned with the query results. 
 */ 
  
 // const mode = {} 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callRunAggregationQuery 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
 runAggregationQuery 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRunAggregationQuery 
 (); 
 

   
 /** 
 * This snippet has been automatically generated and should be regarded as a code template only. 
 * It will require modifications to work. 
 * It may require correct/in-range values for request initialization. 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The ID of the project against which to make the request. 
 */ 
  
 // const projectId = 'abc123' 
  
 /** 
 *  The ID of the database against which to make the request. 
 *  '(default)' is not allowed; please use empty string '' to refer the default 
 *  database. 
 */ 
  
 // const databaseId = 'abc123' 
  
 /** 
 *  Entities are partitioned into subsets, identified by a partition ID. 
 *  Queries are scoped to a single partition. 
 *  This partition ID is normalized with the standard default context 
 *  partition ID. 
 */ 
  
 // const partitionId = {} 
  
 /** 
 *  The options for this query. 
 */ 
  
 // const readOptions = {} 
  
 /** 
 *  The query to run. 
 */ 
  
 // const query = {} 
  
 /** 
 *  The GQL query to run. This query must be a non-aggregation query. 
 */ 
  
 // const gqlQuery = {} 
  
 /** 
 *  Optional. The mode in which the query request is processed. This field is 
 *  optional, and when not provided, it defaults to `NORMAL` mode where no 
 *  additional statistics will be returned with the query results. 
 */ 
  
 // const mode = {} 
  
 // Imports the Datastore library 
  
 const 
  
 { 
 DatastoreClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/datastore 
' 
 ). 
  v1 
 
 ; 
  
 // Instantiates a client 
  
 const 
  
 datastoreClient 
  
 = 
  
 new 
  
  DatastoreClient 
 
 (); 
  
 async 
  
 function 
  
 callRunQuery 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 projectId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 datastoreClient 
 . 
 runQuery 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRunQuery 
 ();