Recurso: campo
Representa um único campo no banco de dados.
Os campos são agrupados pelo "Grupo de coleções", que representa todos os conjuntos no banco de dados com o mesmo ID.
Representação JSON |
---|
{ "name": string, "indexConfig": { object ( |
Campos | |
---|---|
name |
Obrigatório. Um nome de campo no formato Um caminho de campo pode ser um nome de campo simples, por exemplo , Os caminhos do campo podem ser citados usando Exemplos: (Observação: os comentários aqui estão escritos em sintaxe markdown, portanto há uma camada adicional de crases para representar um bloco de código) Uma |
indexConfig |
A configuração de índice para este campo. Se não for definida, a indexação de campo vai reverter para a configuração definida pelo |
ttlConfig |
A configuração de TTL deste |
IndexConfig
A configuração de índice para este campo.
Representação JSON |
---|
{
"indexes": [
{
object ( |
Campos | |
---|---|
indexes[] |
Os índices compatíveis com este campo. |
usesAncestorConfig |
Apenas saída. Quando verdadeiro, a configuração de índice de |
ancestorField |
Apenas saída. Especifica o nome do recurso da |
reverting |
Saída apenas quando verdadeiro, a configuração de índice de |
TtlConfig
A configuração de TTL (vida útil) para documentos que tenham esse Field
definido.
O armazenamento de um valor de carimbo de data/hora em um campo ativado para TTL será tratado como o prazo de validade absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento está qualificado para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desativa a expiração do documento individual.
Representação JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state |
Apenas saída. O estado da configuração do TTL. |
Estado
O estado de aplicação da configuração de TTL a todos os documentos.
Enums | |
---|---|
STATE_UNSPECIFIED |
O estado não foi especificado ou é desconhecido. |
CREATING |
O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Os documentos recém-gravados terão a TTL aplicada conforme solicitado. Os TTLs solicitados nos documentos existentes ainda estão sendo processados. Quando os TTLs em todos os documentos existentes forem processados, o estado passará para "ACTIVE". |
ACTIVE |
O TTL está ativo para todos os documentos. |
NEEDS_REPAIR |
Não foi possível ativar a configuração de TTL para todos os documentos existentes. O TTL dos documentos recém-gravados continuará sendo aplicado. A LRO retornada na última tentativa de ativar o TTL para este Field falhou e pode ter mais detalhes. |
Métodos |
|
---|---|
|
Recebe os metadados e a configuração de um campo. |
|
Lista a configuração de campo e os metadados para este banco de dados. |
|
Atualiza uma configuração de campo. |