@google-cloud/firestore 0.21.0 » Class: FirestoreClient

v1.FirestoreClient

class   static

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

• create_time - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion.
• update_time - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion.
• read_time - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist.
• commit_time - The time at which the writes in a transaction were committed. Any read with an equal or greater read_time is guaranteed to see the effects of the transaction.

Constructor

FirestoreClient

new FirestoreClient(options)

Construct an instance of FirestoreClient.

Parameter

options

Optional object The configuration object. See the subsequent parameters for more details. Values in options have the following properties: Parameter credentials Optional object Credentials object. credentials.client_email Optional string credentials.private_key Optional string email Optional string Account email address. Required when using a .pem or .p12 keyFilename. keyFilename Optional string Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well. port Optional number The port on which to connect to the remote host. projectId Optional string The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically. promise Optional function() Custom promise module to use instead of native Promises. servicePath Optional string The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

anyPathPath

anyPathPath(project, database, document, anyPath) returns String

Return a fully-qualified any_path resource name string.

Parameter
project	String
database	String
document	String
anyPath	String

Returns

String 

batchGetDocuments

batchGetDocuments(request, options) returns Stream

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter database string The database name. In the format: projects/{project_id}/databases/{database_id}. documents Array of string The names of the documents to retrieve. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. The request will fail if any of the document is not a child resource of the given database. Duplicate names will be elided. mask Optional Object The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask transaction Optional string Reads documents in a transaction. newTransaction Optional Object Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. This object should have the same structure as TransactionOptions readTime Optional Object Reads documents as they were at the given time. This may not be older than 60 seconds. This object should have the same structure as Timestamp
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream 

An object stream which emits BatchGetDocumentsResponse on 'data' event.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); const documents = []; const request = { database:
formattedDatabase, documents: documents,
};
client.batchGetDocuments(request).on('data', response => {
  // doThingsWith(response)
});

beginTransaction

beginTransaction(request, options, callback) returns Promise

Starts a new transaction.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter database string The database name. In the format: projects/{project_id}/databases/{database_id}. options Optional Object The options for the transaction. Defaults to a read-write transaction. This object should have the same structure as TransactionOptions
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing BeginTransactionResponse.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing BeginTransactionResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); client.beginTransaction({database: formattedDatabase})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

commit

commit(request, options, callback) returns Promise

Commits a transaction, while optionally updating documents.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter database string The database name. In the format: projects/{project_id}/databases/{database_id}. writes Array of Object The writes to apply. Always executed atomically and in order. This object should have the same structure as Write transaction Optional string If set, applies all writes in this transaction, and commits it.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing CommitResponse.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing CommitResponse. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); const writes = []; const request = { database:
formattedDatabase, writes: writes,
};
client.commit(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

createDocument

createDocument(request, options, callback) returns Promise

Creates a new document.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent resource. For example: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id} collectionId string The collection ID, relative to parent, to list. For example: chatrooms. documentId string The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. document Object The document to create. name must not be set. This object should have the same structure as Document mask Optional Object The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Document.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Document. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); const collectionId = ''; const documentId =
''; const document = {}; const request = { parent: formattedParent,
  collectionId: collectionId,
  documentId: documentId,
  document: document,
};
client.createDocument(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

databaseRootPath

databaseRootPath(project, database) returns String

Return a fully-qualified database_root resource name string.

Parameter
project	String
database	String

Returns

String 

deleteDocument

deleteDocument(request, options, callback) returns Promise

Deletes a document.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter name string The resource name of the Document to delete. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. currentDocument Optional Object An optional precondition on the document. The request will fail if this is set and not met by the target document. This object should have the same structure as Precondition
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error) The function which will be called with the result of the API call.

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedName = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); client.deleteDocument({name:
formattedName}).catch(err => { console.error(err);
});

documentPathPath

documentPathPath(project, database, documentPath) returns String

Return a fully-qualified document_path resource name string.

Parameter
project	String
database	String
documentPath	String

Returns

String 

documentRootPath

documentRootPath(project, database) returns String

Return a fully-qualified document_root resource name string.

Parameter
project	String
database	String

Returns

String 

getDocument

getDocument(request, options, callback) returns Promise

Gets a single document.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter name string The resource name of the Document to get. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. mask Optional Object The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask transaction Optional string Reads the document in a transaction. readTime Optional Object Reads the version of the document at the given time. This may not be older than 60 seconds. This object should have the same structure as Timestamp
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Document.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Document. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedName = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); client.getDocument({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter
callback	function(Error, string) the callback to be called with the current project Id.

listCollectionIds

listCollectionIds(request, options, callback) returns Promise

Lists all the collection IDs underneath a document.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom pageSize Optional number The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Array, nullable Object, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is Array of string. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListCollectionIdsResponse.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of string.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of string in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListCollectionIdsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]');

client.listCollectionIds({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listCollectionIds(nextRequest, options).then(callback);
  }
}
client.listCollectionIds({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listCollectionIdsStream

listCollectionIdsStream(request, options) returns Stream

Equivalent to listCollectionIds, but returns a NodeJS Stream object.

This fetches the paged responses for listCollectionIds continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent document. In the format: projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom pageSize Optional number The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits a string on 'data' event.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); client.listCollectionIdsStream({parent:
formattedParent}) .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listDocuments

listDocuments(request, options, callback) returns Promise

Lists documents.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom collectionId string The collection ID, relative to parent, to list. For example: chatrooms or messages. pageSize Optional number The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. orderBy Optional string The order to sort results by. For example: priority desc, name. mask Optional Object The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask transaction Optional string Reads documents in a transaction. readTime Optional Object Reads documents as they were at the given time. This may not be older than 60 seconds. This object should have the same structure as Timestamp showMissing Optional boolean If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with show_missing may not specify where or order_by.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Array, nullable Object, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is Array of Document. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListDocumentsResponse.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of Document.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Document in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListDocumentsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); const collectionId = ''; const request = {
  parent: formattedParent,
  collectionId: collectionId,
};

client.listDocuments(request)
  .then(responses => {
    const resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); const collectionId = ''; const request = {
  parent: formattedParent,
  collectionId: collectionId,
};


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listDocuments(nextRequest, options).then(callback);
  }
}
client.listDocuments(request, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listDocumentsStream

listDocumentsStream(request, options) returns Stream

Equivalent to listDocuments, but returns a NodeJS Stream object.

This fetches the paged responses for listDocuments continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom collectionId string The collection ID, relative to parent, to list. For example: chatrooms or messages. pageSize Optional number The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page. orderBy Optional string The order to sort results by. For example: priority desc, name. mask Optional Object The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask transaction Optional string Reads documents in a transaction. readTime Optional Object Reads documents as they were at the given time. This may not be older than 60 seconds. This object should have the same structure as Timestamp showMissing Optional boolean If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with show_missing may not specify where or order_by.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing Document on 'data' event.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); const collectionId = ''; const request = {
  parent: formattedParent,
  collectionId: collectionId,
};
client.listDocumentsStream(request)
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

listen

listen(options) returns Stream

Listens to changes.

Parameter
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream 

An object stream which is both readable and writable. It accepts objects representing ListenRequest for write() method, and will emit objects representing ListenResponse on 'data' event asynchronously.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const stream = client.listen().on('data', response => {
  // doThingsWith(response)
});
const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); const request = { database: formattedDatabase,
};
// Write request objects.
stream.write(request);

matchAnyPathFromAnyPathName

matchAnyPathFromAnyPathName(anyPathName) returns String

Parse the anyPathName from a any_path resource.

Parameter
anyPathName	String A fully-qualified path representing a any_path resources.

Returns

String 

• A string representing the any_path.

matchDatabaseFromAnyPathName

matchDatabaseFromAnyPathName(anyPathName) returns String

Parse the anyPathName from a any_path resource.

Parameter
anyPathName	String A fully-qualified path representing a any_path resources.

Returns

String 

• A string representing the database.

matchDatabaseFromDatabaseRootName

matchDatabaseFromDatabaseRootName(databaseRootName) returns String

Parse the databaseRootName from a database_root resource.

Parameter
databaseRootName	String A fully-qualified path representing a database_root resources.

Returns

String 

• A string representing the database.

matchDatabaseFromDocumentPathName

matchDatabaseFromDocumentPathName(documentPathName) returns String

Parse the documentPathName from a document_path resource.

Parameter
documentPathName	String A fully-qualified path representing a document_path resources.

Returns

String 

• A string representing the database.

matchDatabaseFromDocumentRootName

matchDatabaseFromDocumentRootName(documentRootName) returns String

Parse the documentRootName from a document_root resource.

Parameter
documentRootName	String A fully-qualified path representing a document_root resources.

Returns

String 

• A string representing the database.

matchDocumentFromAnyPathName

matchDocumentFromAnyPathName(anyPathName) returns String

Parse the anyPathName from a any_path resource.

Parameter
anyPathName	String A fully-qualified path representing a any_path resources.

Returns

String 

• A string representing the document.

matchDocumentPathFromDocumentPathName

matchDocumentPathFromDocumentPathName(documentPathName) returns String

Parse the documentPathName from a document_path resource.

Parameter
documentPathName	String A fully-qualified path representing a document_path resources.

Returns

String 

• A string representing the document_path.

matchProjectFromAnyPathName

matchProjectFromAnyPathName(anyPathName) returns String

Parse the anyPathName from a any_path resource.

Parameter
anyPathName	String A fully-qualified path representing a any_path resources.

Returns

String 

• A string representing the project.

matchProjectFromDatabaseRootName

matchProjectFromDatabaseRootName(databaseRootName) returns String

Parse the databaseRootName from a database_root resource.

Parameter
databaseRootName	String A fully-qualified path representing a database_root resources.

Returns

String 

• A string representing the project.

matchProjectFromDocumentPathName

matchProjectFromDocumentPathName(documentPathName) returns String

Parse the documentPathName from a document_path resource.

Parameter
documentPathName	String A fully-qualified path representing a document_path resources.

Returns

String 

• A string representing the project.

matchProjectFromDocumentRootName

matchProjectFromDocumentRootName(documentRootName) returns String

Parse the documentRootName from a document_root resource.

Parameter
documentRootName	String A fully-qualified path representing a document_root resources.

Returns

String 

• A string representing the project.

rollback

rollback(request, options, callback) returns Promise

Rolls back a transaction.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter database string The database name. In the format: projects/{project_id}/databases/{database_id}. transaction string The transaction to roll back.
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error) The function which will be called with the result of the API call.

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); const transaction = ''; const request = { database:
formattedDatabase, transaction: transaction,
};
client.rollback(request).catch(err => {
  console.error(err);
});

runQuery

runQuery(request, options) returns Stream

Runs a query.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter parent string The parent resource name. In the format: projects/{project_id}/databases/{database_id}/documents or projects/{project_id}/databases/{database_id}/documents/{document_path}. For example: projects/my-project/databases/my-database/documents or projects/my-project/databases/my-database/documents/chatrooms/my-chatroom structuredQuery Optional Object A structured query. This object should have the same structure as StructuredQuery transaction Optional string Reads documents in a transaction. newTransaction Optional Object Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. This object should have the same structure as TransactionOptions readTime Optional Object Reads documents as they were at the given time. This may not be older than 60 seconds. This object should have the same structure as Timestamp
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream 

An object stream which emits RunQueryResponse on 'data' event.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const formattedParent = client.anyPathPath('[PROJECT]', '[DATABASE]',
'[DOCUMENT]', '[ANY_PATH]'); client.runQuery({parent:
formattedParent}).on('data', response => {
  // doThingsWith(response)
});

updateDocument

updateDocument(request, options, callback) returns Promise

Updates or inserts a document.

Parameter
request	Object The request object that will be sent. Values in request have the following properties: Parameter document Object The updated document. Creates the document if it does not already exist. This object should have the same structure as Document updateMask Object The fields to update. None of the field paths in the mask may contain a reserved name. If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. This object should have the same structure as DocumentMask mask Optional Object The fields to return. If not set, returns all fields. If the document has a field that is not present in this mask, that field will not be returned in the response. This object should have the same structure as DocumentMask currentDocument Optional Object An optional precondition on the document. The request will fail if this is set and not met by the target document. This object should have the same structure as Precondition
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback	Optional function(nullable Error, nullable Object) The function which will be called with the result of the API call. The second parameter to the callback is an object representing Document.

Returns

Promise 

• The promise which resolves to an array. The first element of the array is an object representing Document. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const document = {};
const updateMask = {};
const request = {
  document: document,
  updateMask: updateMask,
};
client.updateDocument(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

write

write(options) returns Stream

Streams batches of document updates and deletes, in order.

Parameter
options	Optional Object Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns

Stream 

An object stream which is both readable and writable. It accepts objects representing WriteRequest for write() method, and will emit objects representing WriteResponse on 'data' event asynchronously.

Example

const firestore = require('@google-cloud/firestore');

const client = new firestore.v1.FirestoreClient({
  // optional auth parameters.
});

const stream = client.write().on('data', response => {
  // doThingsWith(response)
});
const formattedDatabase = client.databaseRootPath('[PROJECT]',
'[DATABASE]'); const request = { database: formattedDatabase,
};
// Write request objects.
stream.write(request);