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
Namespace
Google \ Cloud \ Firestore \ Admin \ V1Methods
__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 locations 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. |
↳ version_retention_period |
Google\Protobuf\Duration
Output only. The period during which past versions of data are retained in the database. Any read or query can specify a |
↳ earliest_version_time |
Google\Protobuf\Timestamp
Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with |
↳ point_in_time_recovery_enablement |
int
Whether to enable the PITR feature on 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 locations are listed at https://cloud.google.com/firestore/docs/locations.
| Returns | |
|---|---|
| Type | Description |
string | |
setLocationId
The location of the database. Available locations 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 | |
getVersionRetentionPeriod
Output only. The period during which past versions of data are retained in the database.
Any read
or query can specify
a read_time within this window, and will read the state of the database
at that time.
If the PITR feature is enabled, the retention period is 7 days. Otherwise,
the retention period is 1 hour.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasVersionRetentionPeriod
clearVersionRetentionPeriod
setVersionRetentionPeriod
Output only. The period during which past versions of data are retained in the database.
Any read
or query can specify
a read_time within this window, and will read the state of the database
at that time.
If the PITR feature is enabled, the retention period is 7 days. Otherwise,
the retention period is 1 hour.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEarliestVersionTime
Output only. The earliest timestamp at which older versions of the data can
be read from the database. See [version_retention_period] above; this field
is populated with now - version_retention_period.
This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasEarliestVersionTime
clearEarliestVersionTime
setEarliestVersionTime
Output only. The earliest timestamp at which older versions of the data can
be read from the database. See [version_retention_period] above; this field
is populated with now - version_retention_period.
This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPointInTimeRecoveryEnablement
Whether to enable the PITR feature on this database.
| Returns | |
|---|---|
| Type | Description |
int | |
setPointInTimeRecoveryEnablement
Whether to enable the PITR feature on 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 | |