Todos os produtos
Search
Central de documentação

Tablestore:FieldSchema

Última atualização: Aug 20, 2026

O FieldSchema define a configuração de campos de um índice de busca. Cada campo no índice exige uma entrada FieldSchema que especifique propriedades como tipo de campo, tokenizador e comportamento de indexação.

Parâmetros

message FieldSchema {
    optional string field_name = 1;
    optional FieldType field_type = 2;
    optional string analyzer = 4;
    optional bool index = 5;
    optional bool sort_and_agg = 6;
    repeated FieldSchema field_schemas = 8; // only for nested type
    optional bool is_array = 9;
    optional bytes analyzer_parameter = 10;
    optional bool is_virtual_field = 11;
    repeated string source_field_names = 12;
    repeated string date_formats = 13;
    optional bool enable_highlighting = 14;
    optional VectorOptions vector_options = 15;
    optional JsonType json_type = 16;
}

Nome

Tipo

Obrigatório

Descrição

field_name

string

Sim

Nome do campo. Deve corresponder exatamente ao nome do campo na tabela de dados.

Importante

Um nome de campo incompatível causa falha na criação do índice.

field_type

FieldType

Sim

Tipo do campo. Para mais informações, consulte Data types.

Importante

O tipo de campo do índice de busca deve corresponder ao tipo de campo equivalente na tabela de dados.

analyzer

string

Não

Tipo de tokenizador. Padrão: tokenização de palavra única. Aplicável apenas a campos TEXT.

index

bool

Não

Define se a indexação está ativada para o campo. Padrão: true. Se definido como true, cria um índice invertido ou espacial. Se definido como false, nenhum índice é criado.

sort_and_agg

bool

Não

Indica se a ordenação e a agregação estão habilitadas para o campo.

Somente campos com ordenação e agregação ativadas podem ser usados em operações de ordenação.

field_schemas

FieldSchema

Não

Configurações dos subcampos. Necessário apenas quando o tipo de campo for NESTED.

is_array

bool

Não

Especifica se o campo é um array. Se definido como true, os dados gravados neste campo devem estar no formato de array JSON, como ["a","b","c"].

Não é necessário para campos NESTED.

analyzer_parameter

bytes

Não

Definições opcionais de parâmetros do tokenizador. O valor deve ser codificado via protobuf.

Os parâmetros suportados variam conforme o tipo de tokenizador. Para mais detalhes, consulte Tokenizers.

is_virtual_field

bool

Não

Determina se o campo é uma coluna virtual. Padrão: false. Obrigatório apenas ao utilizar colunas virtuais.

source_field_names

string

Não

Nomes dos campos de source na tabela de dados mapeados para esta coluna virtual. Necessário somente quando is_virtual_field estiver definido como true.

date_formats

string

Não

Formatos de data. Exigido exclusivamente para campos DATE.

enable_highlighting

bool

Não

Controla a ativação do destaque e resumo de consulta. Padrão: false. Apenas campos TEXT suportam este recurso.

Defina este parâmetro como true para ativar o destaque e o resumo nas consultas.

vector_options

VectorOptions

Não

Parâmetros de configuração para campos vetoriais. Obrigatório quando o tipo de campo for VECTOR.

json_type

JsonType

Não

Tipo de índice do campo JSON. Valores válidos: OBJECT e Object. Necessário quando o tipo de campo for JSON.