FieldSchema define la configuración de campos para un índice de búsqueda. Cada campo del índice requiere una entrada FieldSchema que especifique propiedades como el tipo de campo, el tokenizer y el comportamiento de indexación.
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;
}
Nombre | Tipo | Obligatorio | Descripción |
field_name | string | Sí | Nombre del campo. Debe coincidir con el nombre del campo correspondiente en la tabla de datos. Importante Si el nombre del campo no coincide, se produce un error al crear el índice. |
field_type | Sí | Tipo de campo. Para obtener más información, consulte Data types. Importante El tipo de campo del índice de búsqueda debe coincidir con el tipo de campo correspondiente en la tabla de datos. | |
analyzer | string | No | Tipo de tokenizer. Valor predeterminado: tokenización de palabra única. Solo aplica a campos TEXT. |
index | bool | No | Indica si se habilita la indexación para el campo. Valor predeterminado: true. Si se establece en true, se crea un índice invertido o espacial. Si se establece en false, no se crea ningún índice. |
sort_and_agg | bool | No | Indica si se habilitan la ordenación y la agregación para el campo. Solo los campos con ordenación y agregación habilitadas pueden usarse para ordenar resultados. |
field_schemas | No | Configuraciones de los subcampos. Obligatorio únicamente cuando el tipo de campo es NESTED. | |
is_array | bool | No | Indica si el campo es un arreglo. Si se establece en true, los datos escritos en este campo deben tener formato de arreglo JSON, por ejemplo No es necesario para campos NESTED. |
analyzer_parameter | bytes | No | Configuración opcional de parámetros del tokenizer. El valor debe estar codificado mediante protobuf. Los parámetros compatibles varían según el tipo de tokenizer. Para obtener más información, consulte Tokenizers. |
is_virtual_field | bool | No | Indica si el campo es una columna virtual. Valor predeterminado: false. Obligatorio únicamente cuando se usan columnas virtuales. |
source_field_names | string | No | Nombres de los campos de origen en la tabla de datos que se asignan a esta columna virtual. Obligatorio únicamente cuando is_virtual_field se establece en true. |
date_formats | string | No | Formatos de fecha. Obligatorio únicamente para campos DATE. |
enable_highlighting | bool | No | Indica si se habilita el resaltado y resumen de consultas. Valor predeterminado: false. Esta función solo es compatible con campos TEXT. Establezca este parámetro en true para habilitar el resaltado y resumen de consultas. |
vector_options | No | Parámetros de configuración para campos vectoriales. Obligatorio cuando el tipo de campo es VECTOR. | |
json_type | No | Tipo de índice del campo JSON. Valores válidos: OBJECT y Object. Obligatorio cuando el tipo de campo es JSON. |