Эта страница переведена с помощью Cloud Translation API.

REST Resource: projects.databases

Ресурс: База данных

База данных Cloud Firestore.

JSON-представление

JSON-представление
{ "name": string, "uid": string, "createTime": string, "updateTime": string, "deleteTime": string, "locationId": string, "type": enum (`DatabaseType`), "concurrencyMode": enum (`ConcurrencyMode`), "versionRetentionPeriod": string, "earliestVersionTime": string, "pointInTimeRecoveryEnablement": enum (`PointInTimeRecoveryEnablement`), "appEngineIntegrationMode": enum (`AppEngineIntegrationMode`), "keyPrefix": string, "deleteProtectionState": enum (`DeleteProtectionState`), "cmekConfig": { object (`CmekConfig`) }, "previousId": string, "etag": string }

{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "cmekConfig": {
    object (CmekConfig)
  },
  "previousId": string,
  "etag": string
}

Поля
`name`	`string` Имя ресурса базы данных. Формат: `projects/{project}/databases/{database}`
`uid`	`string` Только вывод. Созданный системой UUID4 для этой базы данных.
`createTime`	`string ( Timestamp format)` Только вывод. Временная метка создания этой базы данных. Базы данных, созданные до 2016 года, не заполняют createTime. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`updateTime`	`string ( Timestamp format)` Только вывод. Временная метка последнего обновления этой базы данных. Обратите внимание, что сюда входят только обновления ресурса базы данных, а не данные, содержащиеся в базе данных. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`deleteTime`	`string ( Timestamp format)` Только вывод. Метка времени, когда эта база данных была удалена. Устанавливается только в том случае, если база данных была удалена. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`locationId`	`string` Расположение базы данных. Доступные местоположения перечислены по адресу https://cloud.google.com/firestore/docs/locations .
`type`	`enum ( DatabaseType )` Тип базы данных. См. https://cloud.google.com/datastore/docs/firestore-or-datastore для получения информации о том, как выбрать.
`concurrencyMode`	`enum ( ConcurrencyMode )` Режим управления параллелизмом, используемый для этой базы данных.
`versionRetentionPeriod`	`string ( Duration format)` Только вывод. Период, в течение которого предыдущие версии данных сохраняются в базе данных. Любое `read` или `query` может указать `readTime` в этом окне и будет считывать состояние базы данных в этот момент. Если функция PITR включена, срок хранения составляет 7 дней. В противном случае срок хранения составляет 1 час. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « `s` ». Пример: `"3.5s"` .
`earliestVersionTime`	`string ( Timestamp format)` Только вывод. Самая ранняя временная метка, по которой более старые версии данных могут быть прочитаны из базы данных. См. [versionRetentionPeriod] выше; это поле заполняется с помощью `now - versionRetentionPeriod` . Это значение постоянно обновляется и становится устаревшим в момент запроса. Если вы используете это значение для восстановления данных, обязательно учтите время с момента запроса значения до момента начала восстановления. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: `"2014-10-02T15:01:23Z"` и `"2014-10-02T15:01:23.045123456Z"` .
`pointInTimeRecoveryEnablement`	`enum ( PointInTimeRecoveryEnablement )` Включить ли функцию PITR в этой базе данных.
`appEngineIntegrationMode`	`enum ( AppEngineIntegrationMode )` Режим интеграции App Engine, который будет использоваться для этой базы данных.
`keyPrefix`	`string` Только вывод. KeyPrefix для этой базы данных. Этот keyPrefix используется в сочетании с идентификатором проекта (« ~ ") для создания идентификатора приложения, который возвращается из API Cloud Datastore в средах выполнения Google App Engine первого поколения. Это значение может быть пустым, и в этом случае идентификатор приложения, используемый для ключей в кодировке URL, — это идентификатор проекта (например: foo вместо v~foo).
`deleteProtectionState`	`enum ( DeleteProtectionState )` Состояние защиты от удаления базы данных.
`cmekConfig`	`object ( CmekConfig )` Необязательный. Присутствие указывает на то, что для этой базы данных включен CMEK.
`previousId`	`string` Только вывод. Предыдущий идентификатор базы данных ресурса базы данных. Это поле заполняется только для удаленных баз данных.
`etag`	`string` Эта контрольная сумма вычисляется сервером на основе значений других полей и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

Тип базы данных

Тип базы данных. См. https://cloud.google.com/datastore/docs/firestore-or-datastore для получения информации о том, как выбрать.

Изменение режима разрешено только в том случае, если база данных пуста.

Перечисления
`DATABASE_TYPE_UNSPECIFIED`	Значение по умолчанию. Это значение используется, если тип базы данных опущен.
`FIRESTORE_NATIVE`	Основной режим Firestore
`DATASTORE_MODE`	Firestore в режиме хранилища данных.

Режим параллелизма

Тип режима управления параллелизмом для транзакций.

Перечисления
`CONCURRENCY_MODE_UNSPECIFIED`	Не используется.
`OPTIMISTIC`	По умолчанию используйте оптимистический контроль параллелизма. Этот режим доступен для баз данных Cloud Firestore.
`PESSIMISTIC`	По умолчанию используйте пессимистическое управление параллелизмом. Этот режим доступен для баз данных Cloud Firestore. Это настройка по умолчанию для Cloud Firestore.
`OPTIMISTIC_WITH_ENTITY_GROUPS`	По умолчанию используйте оптимистичный контроль параллелизма с группами сущностей. Это единственный доступный режим для Cloud Datastore. Этот режим также доступен для Cloud Firestore с режимом хранилища данных, но не рекомендуется.

Пойнтинтимерековериэнаблемент

Включение функции восстановления на определенный момент времени.

Перечисления

POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Не используется.

Перечисления
`POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED`	Не используется.
`POINT_IN_TIME_RECOVERY_ENABLED`	Чтение поддерживается для выбранных версий данных за последние 7 дней: Считывает любую временную метку за последний час. Считывает 1-минутные снимки за 1 час и в течение 7 дней. `versionRetentionPeriod` и `earliestVersionTime` можно использовать для определения поддерживаемых версий.
`POINT_IN_TIME_RECOVERY_DISABLED`	Чтение поддерживается для любой версии данных за последний час.

POINT_IN_TIME_RECOVERY_ENABLED

Чтение поддерживается для выбранных версий данных за последние 7 дней:

Считывает любую временную метку за последний час.
Считывает 1-минутные снимки за 1 час и в течение 7 дней.

versionRetentionPeriod и earliestVersionTime можно использовать для определения поддерживаемых версий.

POINT_IN_TIME_RECOVERY_DISABLED Чтение поддерживается для любой версии данных за последний час.

AppEngineIntegrationMode

Тип режима интеграции App Engine.

Перечисления

APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Не используется.

ENABLED Если приложение App Engine существует в том же регионе, что и эта база данных, конфигурация App Engine повлияет на эту базу данных. Это включает в себя отключение приложения и базы данных, а также отключение записи в базу данных.

Перечисления
`APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED`	Не используется.
`ENABLED`	Если приложение App Engine существует в том же регионе, что и эта база данных, конфигурация App Engine повлияет на эту базу данных. Это включает в себя отключение приложения и базы данных, а также отключение записи в базу данных.
`DISABLED`	App Engine не влияет на способность этой базы данных обслуживать запросы. Это настройка по умолчанию для баз данных, созданных с помощью Firestore API.

DISABLED

App Engine не влияет на способность этой базы данных обслуживать запросы.

Это настройка по умолчанию для баз данных, созданных с помощью Firestore API.

Делепротетектионстате

Состояние защиты базы данных от удаления.

Перечисления
`DELETE_PROTECTION_STATE_UNSPECIFIED`	Значение по умолчанию. Не указан тип защиты от удаления
`DELETE_PROTECTION_DISABLED`	Защита от удаления отключена
`DELETE_PROTECTION_ENABLED`	Защита от удаления включена

CmekConfig

Конфигурация CMEK (ключ шифрования, управляемый клиентом) для базы данных Firestore. Если он отсутствует, база данных защищена ключом шифрования Google по умолчанию.

JSON-представление
{ "kmsKeyName": string, "activeKeyVersion": [ string ] }

Поля

Поля
`kmsKeyName`	`string` Необходимый. Для шифрования можно использовать только ключи, находящиеся в том же месте, что и эта база данных. Для мультирегиона nam5 Firestore это соответствует мультирегиону Cloud KMS us. Для мультирегионального eur3 Firestore это соответствует мультирегиональному сервису Cloud KMS в Европе. См. https://cloud.google.com/kms/docs/locations . Ожидаемый формат: `projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` .
`activeKeyVersion[]`	`string` Только вывод. Используемые в настоящее время версии ключей KMS . Во время ротации ключей может использоваться несколько версий ключей. Ожидаемый формат: `projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}` .

kmsKeyName

string

Необходимый. Для шифрования можно использовать только ключи, находящиеся в том же месте, что и эта база данных.

Для мультирегиона nam5 Firestore это соответствует мультирегиону Cloud KMS us. Для мультирегионального eur3 Firestore это соответствует мультирегиональному сервису Cloud KMS в Европе. См. https://cloud.google.com/kms/docs/locations .

Ожидаемый формат: projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} .

activeKeyVersion[]

string

Только вывод. Используемые в настоящее время версии ключей KMS . Во время ротации ключей может использоваться несколько версий ключей.

Ожидаемый формат: projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} .

Методы
`create`	Создайте базу данных.
`delete`	Удаляет базу данных.
`exportDocuments`	Экспортирует копию всех документов или их части из Google Cloud Firestore в другую систему хранения, например Google Cloud Storage.
`get`	Получает информацию о базе данных.
`importDocuments`	Импортирует документы в Google Cloud Firestore.
`list`	Перечислите все базы данных в проекте.
`patch`	Обновляет базу данных.
`restore`	Создает новую базу данных путем восстановления из существующей резервной копии.

REST Resource: projects.databases

Ресурс: База данных

Тип базы данных

Режим параллелизма

Пойнтинтимерековериэнаблемент

AppEngineIntegrationMode

Делепротетектионстате

CmekConfig

Методы

`create`

`delete`

`exportDocuments`

`get`

`importDocuments`

`list`

`patch`

`restore`