Recurso: Campo
Representa um único campo no banco de dados.
Os campos são agrupados pelo seu “Grupo de Coleções”, que representa todas as coleções do banco de dados com o mesmo id.
Representação JSON |
---|
{ "name": string, "indexConfig": { object ( |
Campos | |
---|---|
name | Obrigatório. Um nome de campo do formulário Um caminho de campo pode ser um nome de campo simples, por exemplo, Os caminhos dos campos podem ser citados usando Exemplos: (Observação: os comentários aqui são escritos em sintaxe de marcação, portanto, há uma camada adicional de crases para representar um bloco de código) Um |
indexConfig | A configuração do índice para este campo. Se não for definido, a indexação do campo reverterá para a configuração definida pelo |
ttlConfig | A configuração TTL para este |
IndexConfig
A configuração do índice para este campo.
Representação JSON |
---|
{
"indexes": [
{
object ( |
Campos | |
---|---|
indexes[] | Os índices suportados para este campo. |
usesAncestorConfig | Somente saída. Quando verdadeiro, a configuração do índice do |
ancestorField | Somente saída. Especifica o nome do recurso do |
reverting | Somente saída Quando verdadeiro, a configuração do índice do |
TtlConfig
A configuração TTL (time-to-live) para documentos que possuem esse Field
definido.
Armazenar um valor de carimbo de data/hora em um campo habilitado para TTL será tratado como o tempo de expiração absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento é elegível para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desabilitará a expiração do documento individual.
Representação JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state | Somente saída. O estado da configuração TTL. |
Estado
O estado de aplicação da configuração TTL a todos os documentos.
Enums | |
---|---|
STATE_UNSPECIFIED | O estado não é especificado ou é desconhecido. |
CREATING | O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Documentos recém-escritos terão TTLs aplicados conforme solicitado. Os TTLs solicitados em documentos existentes ainda estão sendo processados. Quando os TTLs de todos os documentos existentes forem processados, o estado passará para 'ATIVO'. |
ACTIVE | O TTL está ativo para todos os documentos. |
NEEDS_REPAIR | A configuração TTL não pôde ser habilitada para todos os documentos existentes. Documentos recém-escritos continuarão a ter seu TTL aplicado. A LRO retornada na última tentativa de habilitar o TTL para este Field falhou e pode ter mais detalhes. |
Métodos | |
---|---|
| Obtém os metadados e a configuração de um campo. |
| Lista a configuração de campo e os metadados deste banco de dados. |
| Atualiza uma configuração de campo. |