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 | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the Database. Format: |
↳ 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 | |
|---|---|
| Type | Description |
string | |
setName
The resource name of the Database.
Format: projects/{project}/databases/{database}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLocationId
The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
| Returns | |
|---|---|
| Type | Description |
string | |
setLocationId
The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The type of the database.
See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
| Returns | |
|---|---|
| Type | Description |
int | |
setType
The type of the database.
See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConcurrencyMode
The concurrency control mode to use for this database.
| Returns | |
|---|---|
| Type | Description |
int | |
setConcurrencyMode
The concurrency control mode to use for this database.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAppEngineIntegrationMode
The App Engine integration mode to use for this database.
| Returns | |
|---|---|
| Type | Description |
int | |
setAppEngineIntegrationMode
The App Engine integration mode to use for this database.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |