Module column_schema

datatypes::schema

Module column_schema 

Source

Structs§

ColumnSchema
Schema of a column, used as an immutable struct.
FulltextOptions
Fulltext options for a column.
SkippingIndexOptions
Skipping options for a column.
VectorIndexOptions
Options for vector index (HNSW).

Enums§

ColumnExtType
Column extended type set in column schema’s metadata.
FulltextAnalyzer
Fulltext analyzer.
FulltextBackend
The backend of the fulltext index.
SkippingIndexType
Skip index types.
VectorDistanceMetric
Distance metric for vector similarity search.
VectorIndexEngineType
Supported vector index engine types.

Constants§

COLUMN_FULLTEXT_CHANGE_OPT_KEY_ENABLE
Keys used in fulltext options
COLUMN_FULLTEXT_OPT_KEY_ANALYZER
COLUMN_FULLTEXT_OPT_KEY_BACKEND
COLUMN_FULLTEXT_OPT_KEY_CASE_SENSITIVE
COLUMN_FULLTEXT_OPT_KEY_FALSE_POSITIVE_RATE
COLUMN_FULLTEXT_OPT_KEY_GRANULARITY
COLUMN_SKIPPING_INDEX_OPT_KEY_FALSE_POSITIVE_RATE
COLUMN_SKIPPING_INDEX_OPT_KEY_GRANULARITY
Keys used in SKIPPING index options
COLUMN_SKIPPING_INDEX_OPT_KEY_TYPE
COMMENT_KEY
DEFAULT_CONSTRAINT_KEY 🔒
Key used to store default constraint in arrow field’s metadata.
DEFAULT_FALSE_POSITIVE_RATE
DEFAULT_GRANULARITY
DEFAULT_VECTOR_INDEX_CONNECTIVITY 🔒
Default HNSW connectivity parameter.
DEFAULT_VECTOR_INDEX_EXPANSION_ADD 🔒
Default expansion factor during index construction.
DEFAULT_VECTOR_INDEX_EXPANSION_SEARCH 🔒
Default expansion factor during search.
FULLTEXT_KEY
Key used to store fulltext options in arrow field’s metadata.
INVERTED_INDEX_KEY
Key used to store whether the column has inverted index in arrow field’s metadata.
SKIPPING_INDEX_KEY
Key used to store skip options in arrow field’s metadata.
TIME_INDEX_KEY
Key used to store whether the column is time index in arrow field’s metadata.
VECTOR_INDEX_KEY
Key used to store vector index options in arrow field’s metadata.

Functions§

default_vector_index_connectivity 🔒
default_vector_index_expansion_add 🔒
default_vector_index_expansion_search 🔒
fulltext_options_default_granularity 🔒
index_options_default_false_positive_rate_in_10000 🔒

Type Aliases§

Metadata