REST Resource: projects.databases

Recurso: Banco de Dados

Um banco de dados Cloud Firestore.

Representação JSON
{
  "name": string,
  "uid": string,
  "createTime": string,
  "updateTime": string,
  "locationId": string,
  "type": enum (DatabaseType),
  "concurrencyMode": enum (ConcurrencyMode),
  "versionRetentionPeriod": string,
  "earliestVersionTime": string,
  "pointInTimeRecoveryEnablement": enum (PointInTimeRecoveryEnablement),
  "appEngineIntegrationMode": enum (AppEngineIntegrationMode),
  "keyPrefix": string,
  "deleteProtectionState": enum (DeleteProtectionState),
  "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 esse banco de dados foi criado. Os bancos de dados criados antes de 2016 não preenchem 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 mais recentemente. Observe que isso inclui apenas atualizações no recurso de banco de dados e não dados contidos no banco de dados.

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

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

type

enum ( DatabaseType )

O tipo do 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 para esse banco de dados.

versionRetentionPeriod

string ( Duration format)

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

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

Se o recurso PITR estiver habilitado, o período de retenção será de 7 dias. Caso contrário, o período de retenção é de 1 hora.

Uma duração em segundos com até nove dígitos fracionários, terminando com ' 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 no banco de dados. Consulte [versionRetentionPeriod] acima; esse 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, leve em consideração o tempo desde o momento em que o valor é consultado até 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 )

Se o recurso PITR deve ser habilitado neste banco de dados.

appEngineIntegrationMode

enum ( AppEngineIntegrationMode )

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

keyPrefix

string

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

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

deleteProtectionState

enum ( DeleteProtectionState )

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

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.

Tipo de banco de dados

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

Mudanças de modo só serão permitidas se o banco de dados estiver vazio.

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

Modo de simultaneidade

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

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

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

Esta é 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.

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

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

PointInTimeRecoveryEnablement

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

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Não usado.
POINT_IN_TIME_RECOVERY_ENABLED

As leituras são suportadas em versões selecionadas dos dados dos últimos 7 dias:

  • Lê qualquer carimbo de data/hora na última hora
  • Lê instantâneos de 1 minuto além de 1 hora e dentro de 7 dias

versionRetentionPeriod e earliestVersionTime podem ser usados ​​para determinar as versões suportadas.

POINT_IN_TIME_RECOVERY_DISABLED As leituras são suportadas em qualquer versão dos dados da última 1 hora.

Modo de integração do AppEngine

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

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Não usado.
ENABLED Se existir um aplicativo do App Engine na mesma região deste banco de dados, a configuração do App Engine afetará esse banco de dados. Isso inclui a desativação do aplicativo e do banco de dados, bem como a desativação de gravações no banco de dados.
DISABLED

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

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

ExcluirProtectionState

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 foi especificado
DELETE_PROTECTION_DISABLED A proteção contra exclusão está desativada
DELETE_PROTECTION_ENABLED A proteção contra exclusão está ativada

Métodos

create

 Crie 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

 Obtém informações sobre um banco de dados.

importDocuments

 Importa documentos para o Google Cloud Firestore.

list

 Liste todos os bancos de dados do projeto.

patch

 Atualiza um banco de dados.

restore

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