Cloud Firestore V1 Client - Class Database (1.31.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class Database.

A Cloud Firestore Database.

Currently only one database is allowed per cloud project; this database must have a database_id of '(default)'.

Generated from protobuf message google.firestore.admin.v1.Database

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the Database. Format: projects/{project}/databases/{database}

↳ location_id string

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

↳ type int

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

↳ concurrency_mode int

The concurrency control mode to use for this database.

↳ app_engine_integration_mode int

The App Engine integration mode to use for this database.

↳ key_prefix string

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("

↳ etag string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

getName

The resource name of the Database.

Format: projects/{project}/databases/{database}

Returns
TypeDescription
string

setName

The resource name of the Database.

Format: projects/{project}/databases/{database}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocationId

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

Returns
TypeDescription
string

setLocationId

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The type of the database.

See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Returns
TypeDescription
int

setType

The type of the database.

See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getConcurrencyMode

The concurrency control mode to use for this database.

Returns
TypeDescription
int

setConcurrencyMode

The concurrency control mode to use for this database.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAppEngineIntegrationMode

The App Engine integration mode to use for this database.

Returns
TypeDescription
int

setAppEngineIntegrationMode

The App Engine integration mode to use for this database.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getKeyPrefix

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("

This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).

Returns
TypeDescription
string

setKeyPrefix

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("

This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this