@spec add_bool_field(t(), String.t(), numeric_field_options()) :: t()

Adds a boolean field to the schema.

Useful for flags, status indicators, and binary choices.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_bool_field(schema, "published", :indexed_stored)
iex> is_reference(schema)
true

@spec add_bytes_field(t(), String.t(), numeric_field_options()) :: t()

Adds a bytes field to the schema.

Useful for binary data, hashes, and raw byte sequences.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_bytes_field(schema, "file_hash", :stored)
iex> is_reference(schema)
true

@spec add_date_field(t(), String.t(), numeric_field_options()) :: t()

Adds a date field to the schema.

Useful for timestamps, publication dates, and temporal data.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_date_field(schema, "created_at", :fast_stored)
iex> is_reference(schema)
true

@spec add_f64_field(t(), String.t(), numeric_field_options()) :: t()

Adds an f64 (64-bit floating point) field to the schema.

Useful for prices, ratings, scores, and other decimal values.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_f64_field(schema, "rating", :fast_stored)
iex> is_reference(schema)
true

@spec add_facet_field(t(), String.t()) :: t()

Adds a facet field to the schema.

Facet fields enable hierarchical categorization and faceted search. Facets are always indexed and stored by design.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_facet_field(schema, "category")
iex> is_reference(schema)
true

@spec add_i64_field(t(), String.t(), numeric_field_options()) :: t()

Adds an i64 (signed 64-bit integer) field to the schema.

Useful for signed integers, timestamps, and other numeric data.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_i64_field(schema, "timestamp", :fast_stored)
iex> is_reference(schema)
true

@spec add_ip_addr_field(t(), String.t(), numeric_field_options()) :: t()

Adds an IP address field to the schema.

Supports both IPv4 and IPv6 addresses for network data indexing.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_ip_addr_field(schema, "client_ip", :indexed_stored)
iex> is_reference(schema)
true

@spec add_json_field(t(), String.t(), text_field_options()) :: t()

Adds a JSON object field to the schema.

JSON fields allow indexing and searching within structured JSON data.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_json_field(schema, "metadata", :text_stored)
iex> is_reference(schema)
true

@spec add_text_field(t(), String.t(), text_field_options()) :: t()

Adds a text field to the schema.

Text fields are used for full-text search with tokenization and analysis.

Parameters

• schema: The schema to modify
• field_name: The name of the field
• options: Field indexing and storage options

Field Options

• :text - Field is tokenized and indexed for full-text search
• :text_stored - Field is tokenized, indexed, and stored for retrieval
• :stored - Field is only stored (not searchable)
• :fast - Field is tokenized, indexed, and optimized for fast access
• :fast_stored - Field is tokenized, indexed with positions, stored, and optimized for fast access and phrase queries

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_text_field(schema, "title", :text_stored)
iex> schema = TantivyEx.Schema.add_text_field(schema, "body", :text)
iex> is_reference(schema)
true

@spec add_text_field_with_tokenizer(t(), String.t(), text_field_options(), String.t()) ::
  t()

Adds a text field with a custom tokenizer to the schema.

Parameters

• schema: The schema to modify
• field_name: The name of the field
• options: Field indexing and storage options
• tokenizer: The tokenizer to use ("default", "raw", "en_stem", etc.)

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_text_field_with_tokenizer(schema, "title", :text_stored, "en_stem")
iex> is_reference(schema)
true

@spec add_u64_field(t(), String.t(), numeric_field_options()) :: t()

Adds a u64 (unsigned 64-bit integer) field to the schema.

Parameters

• schema: The schema to modify
• field_name: The name of the field
• options: Field indexing and storage options

Field Options

• :indexed - Field is indexed for fast filtering and range queries
• :indexed_stored - Field is indexed and stored for retrieval
• :stored - Field is only stored (not searchable)
• :fast - Field is stored as a fast field for rapid access
• :fast_stored - Field is both fast and stored

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_u64_field(schema, "price", :indexed_stored)
iex> schema = TantivyEx.Schema.add_u64_field(schema, "views", :fast)
iex> is_reference(schema)
true

@spec field_exists?(t(), String.t()) :: boolean()

Checks if a field exists in the schema.

Parameters

• schema: The schema to check
• field_name: The name of the field to check for

Examples

iex> TantivyEx.Schema.field_exists?(schema, "title")
true
iex> TantivyEx.Schema.field_exists?(schema, "nonexistent_field")
false

@spec get_field_names(t()) :: [String.t()]

Returns a list of all field names in the schema.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_text_field(schema, "title", :text_stored)
iex> schema = TantivyEx.Schema.add_u64_field(schema, "price", :indexed)
iex> TantivyEx.Schema.get_field_names(schema)
["title", "price"]

@spec get_field_type(t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}

Returns the type of a specific field in the schema.

Examples

iex> schema = TantivyEx.Schema.new()
iex> schema = TantivyEx.Schema.add_text_field(schema, "title", :text_stored)
iex> TantivyEx.Schema.get_field_type(schema, "title")
{:ok, "text"}

iex> TantivyEx.Schema.get_field_type(schema, "nonexistent")
{:error, "Field 'nonexistent' not found"}

@spec new() :: t()

Creates a new empty schema.

Examples

iex> schema = TantivyEx.Schema.new()
iex> is_reference(schema)
true

@spec validate(t()) :: {:ok, String.t()} | {:error, String.t()}

Validates a schema for correctness.

Checks for basic requirements like having at least one field.

Examples

iex> schema = TantivyEx.Schema.new()
iex> TantivyEx.Schema.validate(schema)
{:error, "Schema must have at least one field"}

iex> schema = TantivyEx.Schema.add_text_field(schema, "title", :text)
iex> TantivyEx.Schema.validate(schema)
{:ok, "Schema is valid"}