Module column_schema 

Structs

ColumnSchema

Schema of a column, used as an immutable struct.

CompressionOptions

Parquet compression settings for a column in SSTs. Unset fields keep the SST defaults.

FulltextOptions

Fulltext options for a column.

SkippingIndexOptions

Skipping options for a column.

Enums

ColumnExtType

Column extended type set in column schema’s metadata.

CompressionType

Compression algorithms for SST columns.

FulltextAnalyzer

Fulltext analyzer.

FulltextBackend

The backend of the fulltext index.

SkippingIndexType

Skip index types.

Constants

COLUMN_COMPRESSION_OPT_KEY_LEVEL

COLUMN_COMPRESSION_OPT_KEY_PAGE_SIZE

COLUMN_COMPRESSION_OPT_KEY_TYPE

Keys used in compression options

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

COMPRESSION_KEY

Key used to store SST compression options in arrow field’s metadata.

DEFAULT_CONSTRAINT_KEY 🔒

Key used to store default constraint in arrow field’s metadata.

DEFAULT_FALSE_POSITIVE_RATE

DEFAULT_GRANULARITY

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.

ZSTD_LEVELS 🔒

Valid zstd levels, as accepted by the parquet writer.

Functions

column_default_constraint_size 🔒

fulltext_options_default_granularity 🔒

index_options_default_false_positive_rate_in_10000 🔒

metadata_size 🔒

Type Aliases

Metadata