REST Resource: projects.databases

Recurso: Database

Um banco de dados do Cloud Firestore.

Representação 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
}
Campos
name

string

O nome do recurso do banco de dados. Formato: projects/{project}/databases/{database}
uid

string

Apenas saída. O UUID4 gerado pelo sistema para este banco de dados.
createTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o banco de dados foi criado. Os bancos de dados criados antes de 2016 não preenchem o createTime.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que esse banco de dados foi atualizado pela última vez. Observe que isso inclui apenas atualizações do recurso do banco de dados e não dos dados contidos nele.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
deleteTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o banco de dados foi excluído. Defina apenas se o banco de dados tiver sido excluído.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
locationId

string

O local do banco de dados. Os locais disponíveis estão listados em https://cloud.google.com/firestore/docs/locations.
type

enum (DatabaseType)

O tipo de banco de dados. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obter informações sobre como escolher.
concurrencyMode

enum (ConcurrencyMode)

O modo de controle de simultaneidade a ser usado neste banco de dados.
versionRetentionPeriod

string (Duration format)

Apenas saída. O período em que as versões anteriores dos dados são retidas no banco de dados.

Qualquer read ou query pode especificar um readTime dentro dessa janela e lerá o estado do banco de dados naquele momento.

Se o recurso PITR estiver ativado, o período de armazenamento será de sete dias. Caso contrário, o período de armazenamento será de uma hora.

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
earliestVersionTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora mais antigo em que versões mais antigas dos dados podem ser lidas do banco de dados. Consulte [versionretentionPeriod] acima. este campo é preenchido com now - versionRetentionPeriod.

Esse valor é atualizado continuamente e fica obsoleto no momento em que é consultado. Se você estiver usando esse valor para recuperar dados, não deixe de considerar o momento entre o momento em que o valor é consultado e o momento em que você inicia a recuperação.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
pointInTimeRecoveryEnablement

enum (PointInTimeRecoveryEnablement)

Define se o recurso PITR deve ser ativado neste banco de dados.
appEngineIntegrationMode

enum (AppEngineIntegrationMode)

O modo de integração do App Engine a ser usado para este banco de dados.
keyPrefix

string

Apenas saída. O keyPrefix deste banco de dados. Esse keyPrefix é usado em combinação com o ID do projeto ("~") para construir o ID do aplicativo retornado das APIs do Cloud Datastore nos ambientes de execução de primeira geração do Google App Engine.

Esse valor pode estar vazio. Nesse caso, o appid a ser usado para chaves codificadas em URL é o projectId (por exemplo: foo em vez de v~foo).
deleteProtectionState

enum (DeleteProtectionState)

Estado da proteção contra exclusão do banco de dados.
cmekConfig

object (CmekConfig)

Opcional. "Presença" indica que a CMEK está ativada para este banco de dados.
previousId

string

Apenas saída. O ID do banco de dados anterior do recurso de banco de dados. Este campo só é preenchido para bancos de dados excluídos.
etag

string

Essa soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada em solicitações de atualização e exclusão para garantir que o cliente tenha um valor atualizado antes de prosseguir.

DatabaseType

O tipo de banco de dados. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obter informações sobre como escolher.

As alterações de modo só são permitidas se o banco de dados estiver vazio.

Enums
DATABASE_TYPE_UNSPECIFIED O valor padrão. Esse valor será usado se o tipo do banco de dados for omitido.
FIRESTORE_NATIVE Modo nativo do Firestore
DATASTORE_MODE Firestore no modo Datastore.

ConcurrencyMode

O tipo de modo de controle de simultaneidade para transações.

Enums
CONCURRENCY_MODE_UNSPECIFIED Não utilizado.
OPTIMISTIC Use o controle de simultaneidade otimista por padrão. Esse modo está disponível para bancos de dados do Cloud Firestore.
PESSIMISTIC

Usar o controle de simultaneidade pessimista por padrão. Esse modo está disponível para bancos de dados do Cloud Firestore.

Essa é a configuração padrão do Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Use o controle de simultaneidade otimista com grupos de entidades por padrão.

Esse é o único modo disponível para o Cloud Datastore.

Esse modo também está disponível para o Cloud Firestore com o modo Datastore, mas não é recomendado.

Ativação de recuperação pontual

Ativação do recurso de recuperação pontual.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Não utilizado.
POINT_IN_TIME_RECOVERY_ENABLED

As leituras são compatíveis com versões selecionadas dos dados dos últimos sete dias:

  • Faz leituras em qualquer carimbo de data/hora da última hora
  • Lê resumos de 1 minuto além de 1 hora e dentro de 7 dias

versionRetentionPeriod e earliestVersionTime podem ser usados para determinar as versões compatíveis.
POINT_IN_TIME_RECOVERY_DISABLED Qualquer versão dos dados da última hora aceita leituras.

AppEngineIntegrationMode

O tipo de modo de integração do App Engine.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Não utilizado.
ENABLED Se houver um aplicativo do App Engine na mesma região desse banco de dados, a configuração do App Engine afetará o banco de dados. Isso inclui a desativação do aplicativo e e desativar gravações no banco de dados.
DISABLED

O App Engine não afeta a capacidade desse banco de dados de atender às solicitações.

Essa é a configuração padrão para bancos de dados criados com a API Firestore.

DeleteProtectionState

O estado de proteção contra exclusão do banco de dados.

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED O valor padrão. O tipo de proteção contra exclusão não está especificado
DELETE_PROTECTION_DISABLED A proteção contra exclusão está desativada
DELETE_PROTECTION_ENABLED A proteção contra exclusão está ativada

Configuração Cmek

A configuração da chave de criptografia gerenciada pelo cliente (CMEK) para um banco de dados do Firestore. Se ausente, o banco de dados é protegido pela chave de criptografia padrão do Google.

Representação JSON 
{
  "kmsKeyName": string,
  "activeKeyVersion": [
    string
  ]
}
Campos
kmsKeyName

string

Obrigatório. Somente as chaves no mesmo local desse banco de dados podem ser usadas para criptografia.

Para a multirregião nam5 do Firestore, isso corresponde à multirregião us do Cloud KMS. Para a multirregião eur3 do Firestore, isso corresponde à Europa multirregional do Cloud KMS. Consulte https://cloud.google.com/kms/docs/locations.

O formato esperado é projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
activeKeyVersion[]

string

Apenas saída. Versões de chaves KMS em uso. Durante a rotação de chaves, pode haver várias versões de chaves em uso.

O formato esperado é projects/{projectId}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

Métodos

create

 Cria um banco de dados.

delete

 Exclui um banco de dados.

exportDocuments

 Exporta uma cópia de todos ou de um subconjunto de documentos do Google Cloud Firestore para outro sistema de armazenamento, como o Google Cloud Storage.

get

 Recebe informações sobre um banco de dados.

importDocuments

 Importa documentos para o Google Cloud Firestore.

list

 Liste todos os bancos de dados no projeto.

patch

 Atualiza um banco de dados.

restore

 Cria um novo banco de dados restaurando a partir de um backup existente.