@spec apply_tenant_scope(
  t(),
  keyword()
) :: t()

Apply tenant scope as required filters.

Add array filtering operations to WHERE clauses.

Supports array containment, overlap, and equality operations.

Parameters

• selecto - The Selecto instance
• array_filters - List of array filter tuples or single filter
• opts - Additional options

Examples

# Array contains
selecto
|> Selecto.array_filter({:array_contains, "tags", ["featured", "new"]})

# Array overlap (has any of the elements)
selecto
|> Selecto.array_filter({:array_overlap, "categories", ["electronics", "computers"]})

# Array contained by
selecto
|> Selecto.array_filter({:array_contained, "permissions", ["read", "write", "admin"]})

# Multiple filters
selecto
|> Selecto.array_filter([
    {:array_contains, "special_features", ["Trailers"]},
    {:array_overlap, "languages", ["English", "Spanish"]}
  ])

Add array manipulation operations to select fields.

Supports array construction, modification, and transformation operations.

Parameters

• selecto - The Selecto instance
• array_operations - List of array manipulation operations
• opts - Additional options

Examples

# Array append
selecto
|> Selecto.array_manipulate({:array_append, "tags", "new-tag", as: "updated_tags"})

# Array remove
selecto
|> Selecto.array_manipulate({:array_remove, "tags", "deprecated", as: "cleaned_tags"})

# Array to string
selecto
|> Selecto.array_manipulate({:array_to_string, "tags", ", ", as: "tag_string"})

Add array aggregation operations to select fields.

Supports ARRAY_AGG, STRING_AGG, and other array aggregation functions with optional DISTINCT, ORDER BY, and filtering.

Parameters

• selecto - The Selecto instance
• array_operations - List of array operation tuples or single operation
• opts - Additional options

Examples

# Simple array aggregation
selecto
|> Selecto.array_select({:array_agg, "film.title", as: "film_titles"})

# Array aggregation with DISTINCT and ORDER BY
selecto
|> Selecto.array_select({:array_agg, "actor.name",
    distinct: true,
    order_by: [{"actor.last_name", :asc}],
    as: "unique_actors"})

# String aggregation with custom delimiter
selecto
|> Selecto.array_select({:string_agg, "tag.name",
    delimiter: ", ",
    as: "tag_list"})

# Array length operation
selecto
|> Selecto.array_select({:array_length, "tags", 1, as: "tag_count"})

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

Get all available fields across all joins and the source table.

Add a simple CASE expression to the select fields.

Simple CASE expressions test a column against specific values and return corresponding results. This is useful for data transformation and categorization.

Parameters

• selecto - The Selecto instance
• column - Column to test against
• when_clauses - List of {value, result} tuples for WHEN conditions
• opts - Options including :else and :as

Examples

# Simple CASE for film ratings
selecto
|> Selecto.case_select("film.rating", [
    {"G", "General Audience"},
    {"PG", "Parental Guidance"},
    {"PG-13", "Parents Strongly Cautioned"},
    {"R", "Restricted"}
  ], else: "Not Rated", as: "rating_description")
|> Selecto.select(["film.title", "rating_description"])

# Generated SQL:
# SELECT film.title,
#        CASE film.rating
#          WHEN 'G' THEN 'General Audience'
#          WHEN 'PG' THEN 'Parental Guidance'
#          WHEN 'PG-13' THEN 'Parents Strongly Cautioned'
#          WHEN 'R' THEN 'Restricted'
#          ELSE 'Not Rated'
#        END AS rating_description

Add a searched CASE expression to the select fields.

Searched CASE expressions evaluate multiple conditions and return results based on the first true condition. This enables complex conditional logic.

Parameters

• selecto - The Selecto instance
• when_clauses - List of {conditions, result} tuples
• opts - Options including :else and :as

Examples

# Customer tier based on payment totals
selecto
|> Selecto.case_when_select([
    {[{"payment_total", {:>, 100}}], "Premium"},
    {[{"payment_total", {:between, 50, 100}}], "Standard"},
    {[{"payment_total", {:>, 0}}], "Basic"}
  ], else: "No Purchases", as: "customer_tier")
|> Selecto.select(["customer.first_name", "customer_tier"])

# Multiple conditions per WHEN clause
selecto
|> Selecto.case_when_select([
    {[{"film.rating", "R"}, {"film.length", {:>, 120}}], "Long Adult Film"},
    {[{"film.rating", "G"}, {"film.special_features", {:like, "%Family%"}}], "Family Film"}
  ], else: "Regular Film", as: "film_category")

# Generated SQL:
# SELECT customer.first_name,
#        CASE
#          WHEN payment_total > $1 THEN $2
#          WHEN payment_total BETWEEN $3 AND $4 THEN $5
#          WHEN payment_total > $6 THEN $7
#          ELSE $8
#        END AS customer_tier

@spec columns(t()) :: map()

See Selecto.Fields.columns/1.

@spec configure(Selecto.Types.domain(), term(), keyword()) :: t()

Generate a selecto structure from a domain configuration and connection input.

## Parameters

• domain - Domain configuration map (see domain configuration docs)
• postgrex_opts - Connection input retained for backward compatibility. This may be adapter-specific connection options, an Ecto repo, a live connection pid/name, or a pooled connection reference.
• opts - Configuration options

## Options

• :validate - (boolean, default: true) Whether to validate the domain configuration before processing. When true, will raise Selecto.DomainValidator.ValidationError if the domain has structural issues like missing schemas, circular join dependencies, or invalid advanced join configurations.
• :pool - (boolean, default: false) Whether to enable connection pooling
• :pool_options - Connection pool configuration options
• :adapter - (module, default: SelectoDBPostgreSQL.Adapter) Database adapter module

## Validation

Domain validation checks for:

• Required top-level keys (source, schemas)
• Schema structural integrity (required keys, column definitions)
• Association references to valid schemas
• Join references to existing associations
• Join dependency cycles that would cause infinite recursion
• Advanced join type requirements (dimension keys, hierarchy parameters, etc.)
• Field reference validity in filters and selectors

## Examples

  # Basic usage (validation enabled by default)
  selecto = Selecto.configure(domain, connection_input)

  # With connection pooling
  selecto = Selecto.configure(domain, connection_input, pool: true)

  # Custom pool configuration
  pool_opts = [pool_size: 20, max_overflow: 10]
  selecto = Selecto.configure(domain, connection_input, pool: true, pool_options: pool_opts)

  # Using existing pooled connection
  {:ok, pool} = Selecto.ConnectionPool.start_pool(connection_input)
  selecto = Selecto.configure(domain, {:pool, pool})

  # Disable validation for performance-critical scenarios
  selecto = Selecto.configure(domain, connection_input, validate: false)

  # With Ecto repository and schema
  selecto = Selecto.from_ecto(MyApp.Repo, MyApp.User)

  # Validation can also be called explicitly
  :ok = Selecto.DomainValidator.validate_domain!(domain)
  selecto = Selecto.configure(domain, connection_input)

@spec detail_actions(t()) :: %{optional(atom() | String.t()) => map()}

See Selecto.Fields.detail_actions/1.

@spec domain(t()) :: Selecto.Types.domain()

See Selecto.Fields.domain/1.

@spec domain_data(t()) :: term()

See Selecto.Fields.domain_data/1.

@spec ensure_tenant_scope!(
  t(),
  keyword()
) :: :ok

Raise if tenant scope is required and missing.

Create an EXCEPT set operation between two queries.

Returns rows from the first query that don't appear in the second query.

Options

• :all - Use EXCEPT ALL to include duplicates in difference (default: false)
• :column_mapping - Map columns between incompatible schemas

Examples

# Find free users (all users except premium)
all_users |> Selecto.except(premium_users)

# Include duplicates in difference
query1 |> Selecto.except(query2, all: true)

@spec execute(Selecto.Types.t(), Selecto.Types.execute_options()) ::
  Selecto.Types.safe_execute_result()

Generate and run the query, returning {:ok, result} or {:error, reason}.

Non-raising version that returns tagged tuples for better error handling. Result format: {:ok, {rows, columns, aliases}} | {:error, reason}

## Examples

  case Selecto.execute(selecto) do
    {:ok, {rows, columns, aliases}} ->
      # Handle successful query
      process_results(rows, columns)
    {:error, reason} ->
      # Handle database error
      Logger.error("Query failed: #{inspect(reason)}")
  end

@spec execute_one(Selecto.Types.t(), Selecto.Types.execute_options()) ::
  Selecto.Types.safe_execute_one_result()

Execute a query expecting exactly one row, returning {:ok, row} or {:error, reason}.

Useful for queries that should return a single record (e.g., with LIMIT 1 or aggregate functions). Returns an error if zero rows or multiple rows are returned.

## Examples

  case Selecto.execute_one(selecto) do
    {:ok, row} ->
      # Handle single row result
      process_single_result(row)
    {:error, :no_results} ->
      # Handle case where no rows were found
    {:error, :multiple_results} ->
      # Handle case where multiple rows were found
    {:error, error} ->
      # Handle database or other errors
  end

@spec execute_shape(t(), Selecto.Types.execute_options()) ::
  {:ok, list()} | {:error, Selecto.Error.t()}

Execute a query configured with select_shape/2 and return shaped rows.

Returns {:ok, shaped_rows} where each row mirrors the selection shape.

@spec execute_stream(
  Selecto.Types.t(),
  keyword()
) :: Selecto.Types.safe_execute_stream_result()

Execute a query as a database-backed stream.

Returns a stream of {row, columns, aliases} tuples for incremental result consumption.

Options

• :max_rows - PostgreSQL cursor batch size (default 500)
• :receive_timeout - stream consumer wait timeout in ms (default 60000)
• :queue_timeout - internal task yield timeout in ms (default 100)
• :stream_timeout - transaction timeout for cursor execution (default 30000)

Notes

• Direct PostgreSQL connections use cursor-backed streaming.
• Adapter-backed streaming requires adapter.stream/4 support.
• Ecto repo and pooled PostgreSQL stream paths currently return structured :validation_error responses.

@spec execute_with_metadata(Selecto.Types.t(), Selecto.Types.execute_options()) ::
  {:ok, Selecto.Types.execute_result(), map()} | {:error, Selecto.Error.t()}

Execute a query and return results with metadata including SQL, params, and execution time.

Parameters

• selecto - The Selecto struct containing connection and query info
• opts - Execution options

Returns

• {:ok, result, metadata} - Successful execution with results and metadata
• {:error, error} - Execution failure with detailed error

The metadata map includes:

• :sql - The generated SQL query string
• :params - The query parameters
• :execution_time - Query execution time in milliseconds

Examples

case Selecto.execute_with_metadata(selecto) do
  {:ok, {rows, columns, aliases}, _metadata} ->
    # Process successful results with metadata
    handle_results(rows, columns, aliases)
  {:error, error} ->
    # Handle database error
    Logger.error("Query failed: #{inspect(error)}")
end

@spec explain(
  t(),
  keyword()
) :: {:ok, map()} | {:error, Selecto.Error.t()}

Run EXPLAIN for a query and return plan details.

@spec explain_analyze(
  t(),
  keyword()
) :: {:ok, map()} | {:error, Selecto.Error.t()}

Run EXPLAIN ANALYZE for a query and return plan details.

@spec extensions(t()) :: [{module(), keyword()}]

See Selecto.Fields.extensions/1.

@spec field(t(), Selecto.Types.field_name()) :: map() | nil

See Selecto.Fields.field/2.

@spec field_suggestions(t(), String.t()) :: [String.t()]

Get field suggestions for autocomplete or error recovery.

@spec filter(t(), [Selecto.Types.filter()]) :: t()

@spec filter(t(), Selecto.Types.filter()) :: t()

Add filters to the query.

For macro-free query composition, prefer importing Selecto.Expr and using runtime filter helpers.

Examples

import Selecto.Expr

selecto
|> Selecto.filter(eq("status", "delivered"))
|> Selecto.filter(compact_and([not_null("customer.id"), gte("total", 100)]))

@spec filters(t()) :: %{required(String.t()) => term()}

See Selecto.Fields.filters/1.

@spec format_sql(
  String.t(),
  keyword()
) :: String.t()

Format SQL output for readability.

Configure Selecto from an Ecto repository and schema.

This convenience function automatically introspects the Ecto schema and configures Selecto with the appropriate domain and database connection.

## Parameters

• repo - The Ecto repository module (e.g., MyApp.Repo)
• schema - The Ecto schema module to use as the source table
• opts - Configuration options (passed to EctoAdapter.configure/3)

## Examples

  # Basic usage
  selecto = Selecto.from_ecto(MyApp.Repo, MyApp.User)

  # With joins and options
  selecto = Selecto.from_ecto(MyApp.Repo, MyApp.User,
    joins: [:posts, :profile],
    redact_fields: [:password_hash]
  )

  # With validation
  selecto = Selecto.from_ecto(MyApp.Repo, MyApp.User, validate: true)

@spec group_by(t(), [Selecto.Types.field_name()]) :: t()

@spec group_by(t(), Selecto.Types.field_name()) :: t()

Add to the Group By clause.

Examples

import Selecto.Expr

selecto
|> Selecto.group_by(["customer.name"])
|> Selecto.group_by(rollup(["status"]))

@spec highlight_sql(String.t(), :ansi | :markdown | nil) :: String.t()

Apply optional highlighting to SQL (:ansi or :markdown).

@spec infer_type(t(), term()) ::
  {:ok, Selecto.TypeSystem.sql_type()} | {:error, term()}

Infer the SQL type of an expression.

Returns the type of a field, function, literal, or complex expression. Useful for type checking, validation, and UI components that need type information.

Examples

# Field type lookup
{:ok, :string} = Selecto.infer_type(selecto, "product_name")

# Aggregate function
{:ok, :bigint} = Selecto.infer_type(selecto, {:count, "*"})

# Numeric aggregate
{:ok, :decimal} = Selecto.infer_type(selecto, {:sum, "price"})

# Literal
{:ok, :integer} = Selecto.infer_type(selecto, {:literal, 42})

Create an INTERSECT set operation between two queries.

Returns only rows that appear in both queries.

Options

• :all - Use INTERSECT ALL to include duplicate intersections (default: false)
• :column_mapping - Map columns between incompatible schemas

Examples

# Find users who are both active and premium
active_users |> Selecto.intersect(premium_users)

# Include duplicate intersections
query1 |> Selecto.intersect(query2, all: true)

@spec join(t(), atom(), keyword()) :: t()

Enable a join from the domain configuration or add a custom join dynamically.

This allows adding joins at runtime that either:

• Enable predefined joins from the domain configuration
• Add completely custom joins not in the domain

Parameters

• join_id - The join identifier (atom)
• options - Optional configuration overrides

Options

• :type - Join type (:left, :inner, :right, :full). Default: :left
• :source - Source table name (required for custom joins)
• :on - Join conditions as list of maps with :left and :right keys
• :owner_key - The key on the parent table
• :related_key - The key on the joined table
• :fields - Map of field configurations to expose from the joined table

Examples

# Enable domain-configured join
selecto |> Selecto.join(:category)

# Custom join with explicit configuration
selecto |> Selecto.join(:audit_log,
  source: "audit_logs",
  on: [%{left: "id", right: "record_id"}],
  type: :left,
  fields: %{
    action: %{type: :string},
    created_at: %{type: :naive_datetime}
  }
)

@spec join_parameterize(t(), atom(), String.t() | atom(), keyword()) :: t()

Create a parameterized instance of an existing join.

Parameterized joins allow the same association to be joined multiple times with different filter conditions. The parameter creates a unique instance that can be referenced using dot notation: join_name:parameter.field_name

Parameters

• join_id - Base join identifier to parameterize
• parameter - Unique parameter value to identify this instance
• options - Filter conditions and options

Examples

# Create parameterized join for electronics products
selecto
|> Selecto.join_parameterize(:products, "electronics", category_id: 1)
|> Selecto.select(["products:electronics.product_name"])

# Multiple parameterized instances for comparison
selecto
|> Selecto.join_parameterize(:orders, "active", status: "active")
|> Selecto.join_parameterize(:orders, "completed", status: "completed")
|> Selecto.select([
    "orders:active.total as active_total",
    "orders:completed.total as completed_total"
  ])

@spec join_subquery(t(), atom(), t(), keyword()) :: t()

Join with another Selecto query as a subquery.

This creates a join using a separate Selecto query as the right side, enabling complex subquery joins for aggregations and derived tables.

Parameters

• join_id - Identifier for this join
• join_selecto - The Selecto struct to use as subquery
• options - Join configuration

Options

• :type - Join type (:left, :inner, :right, :full). Default: :left
• :on - Join conditions referencing the subquery alias

Examples

# Create a subquery for aggregated data
order_totals = Selecto.configure(order_domain, connection)
|> Selecto.select(["customer_id", {:sum, "total", as: "total_spent"}])
|> Selecto.group_by(["customer_id"])

# Join aggregated subquery to main query
selecto
|> Selecto.join_subquery(:customer_totals, order_totals,
    on: [%{left: "customer_id", right: "customer_id"}]
  )
|> Selecto.select(["name", "customer_totals.total_spent"])

@spec joins(t()) :: map()

See Selecto.Fields.joins/1.

Add JSON operations to WHERE clauses for filtering with PostgreSQL JSON/JSONB functionality.

Supports JSON containment, existence, and comparison operations.

Parameters

• selecto - The Selecto instance
• json_filters - List of JSON filter tuples or single filter
• opts - Options (reserved for future use)

Examples

# JSON containment and existence
selecto
|> Selecto.json_filter([
    {:json_contains, "metadata", %{"category" => "electronics"}},
    {:json_path_exists, "metadata", "$.specs.warranty"}
  ])

# JSON path comparison
selecto
|> Selecto.json_filter([
    {:json_extract_text, "settings", "$.theme", {:=, "dark"}},
    {:json_extract, "data", "$.priority", {:>, 5}}
  ])

# Single JSON filter
selecto
|> Selecto.json_filter({:json_exists, "tags", "electronics"})

Add JSON operations to ORDER BY clauses for sorting with PostgreSQL JSON/JSONB functionality.

Parameters

• selecto - The Selecto instance
• json_sorts - List of JSON sort tuples or single sort
• opts - Options (reserved for future use)

Examples

# Sort by JSON path values
selecto
|> Selecto.json_order_by([
    {:json_extract, "metadata", "$.priority", :desc},
    {:json_extract_text, "data", "$.created_at", :asc}
  ])

# Single JSON sort
selecto
|> Selecto.json_order_by({:json_extract, "settings", "$.sort_order"})

@spec json_rowset(t(), atom() | String.t(), keyword() | map()) :: t()

Add a SQLite JSON rowset expansion using json_each or json_tree.

This helper registers the standard SQLite JSON rowset columns so they can be selected and filtered with qualified references such as item_rows.value.

Add JSON operations to SELECT clauses for PostgreSQL JSON/JSONB functionality.

Supports JSON path extraction, aggregation, construction, and manipulation operations.

Parameters

• selecto - The Selecto instance
• json_operations - List of JSON operation tuples or single operation
• opts - Options (reserved for future use)

Examples

# JSON path extraction
selecto
|> Selecto.json_select([
    {:json_extract, "metadata", "$.category", as: "category"},
    {:json_extract, "metadata", "$.specs.weight", as: "weight"}
  ])

# JSON aggregation
selecto
|> Selecto.json_select([
    {:json_agg, "product_name", as: "products"},
    {:json_object_agg, "product_id", "price", as: "price_map"}
  ])
|> Selecto.group_by(["category"])

# Single JSON operation
selecto
|> Selecto.json_select({:json_extract, "data", "$.status", as: "status"})

@spec json_table(t(), atom() | String.t(), keyword() | map()) :: t()

Add a MySQL JSON_TABLE rowset expansion to the query.

This helper projects JSON-derived rows as a joinable rowset and registers the projected columns into the query config so they can be selected and filtered with qualified field references such as item_rows.sku.

Add a LATERAL join to the query.

LATERAL joins allow the right side of the join to reference columns from the left side, enabling powerful correlated subquery patterns.

Parameters

• join_type - Type of join (:left, :inner, :right, :full)
• subquery_builder_or_function - Function that builds correlated subquery or table function tuple
• alias_name - Alias for the LATERAL join results
• opts - Additional options

Examples

# LATERAL join with correlated subquery
selecto
|> Selecto.lateral_join(
  :left,
  fn base_query ->
    Selecto.configure(rental_domain, connection)
    |> Selecto.select([{:func, "COUNT", ["*"], as: "rental_count"}])
    |> Selecto.filter([{"customer_id", {:ref, "customer.customer_id"}}])
    |> Selecto.limit(5)
  end,
  "recent_rentals"
)

# LATERAL join with table function
selecto
|> Selecto.lateral_join(
  :inner,
  {:unnest, "film.special_features"},
  "features"
)

# LATERAL join with generate_series
selecto
|> Selecto.lateral_join(
  :inner,
  {:function, :generate_series, [1, 10]},
  "numbers"
)

@spec limit(t(), non_neg_integer()) :: t()

Limit the number of rows returned by the query.

Examples

# Limit to 10 rows
selecto |> Selecto.limit(10)

# Limit with offset for pagination
selecto |> Selecto.limit(10) |> Selecto.offset(20)

@spec offset(t(), non_neg_integer()) :: t()

Set the offset for the query results.

Examples

# Skip first 20 rows
selecto |> Selecto.offset(20)

# Pagination: page 3 with 10 items per page
selecto |> Selecto.limit(10) |> Selecto.offset(20)

@spec order_by(t(), [Selecto.Types.order_spec()]) :: t()

@spec order_by(t(), Selecto.Types.order_spec()) :: t()

Add to the Order By clause.

Examples

import Selecto.Expr

selecto
|> Selecto.order_by([asc("inserted_at"), desc("priority")])

@spec post_retarget_filter(t(), [Selecto.Types.filter()]) :: t()

@spec post_retarget_filter(t(), Selecto.Types.filter()) :: t()

Append filters explicitly to the post-retarget filter list.

These filters apply to the retargeted target root.

@spec post_retarget_filters(t()) :: [Selecto.Types.filter()]

Read post-retarget filters from the query set (set.post_retarget_filters).

@spec pre_retarget_filter(t(), [Selecto.Types.filter()]) :: t()

@spec pre_retarget_filter(t(), Selecto.Types.filter()) :: t()

Append filters explicitly to the pre-retarget filter list.

These filters stay attached to the original root side when using retarget/3.

@spec pre_retarget_filters(t()) :: [Selecto.Types.filter()]

Read pre-retarget filters from the query set (set.filtered).

@spec query_filters(
  t(),
  keyword()
) :: [Selecto.Types.filter()]

Return query filters from current filter buckets.

Options:

• :include_post_retarget (default: true)

@spec require_tenant_filter(t(), Selecto.Types.filter()) :: t()

Add a required tenant filter to query state.

@spec required_filters(t()) :: [Selecto.Types.filter()]

Return required filters currently attached to the query.

This includes domain-level required filters and tenant-scope required filters attached at runtime.

@spec resolve_field(t(), Selecto.Types.field_name()) ::
  {:ok, map()} | {:error, term()}

Enhanced field resolution with disambiguation and error handling.

Provides detailed field information and helpful error messages.

Retarget the query to focus on a different table while preserving existing context.

This allows you to retarget a Selecto query from the source table to any joined table, while preserving existing filters through subqueries.

Examples

# Retarget from events to orders while preserving event filters
selecto
|> Selecto.filter([{"event_id", 123}])
|> Selecto.retarget(:orders)
|> Selecto.select(["product_name", "quantity"])

Options

• :preserve_filters - Whether to preserve existing filters (default: true)
• :subquery_strategy - How to generate the subquery (:in, :exists, :join)

See Selecto.Retarget module for more details.

@spec select(t(), [Selecto.Types.selector()]) :: t()

@spec select(t(), Selecto.Types.selector()) :: t()

Add fields to the select list.

For macro-free query composition, prefer importing Selecto.Expr and using string field paths plus runtime helper constructors.

Examples

import Selecto.Expr

selecto
|> Selecto.select(["order_number", "customer.name", as(sum("total"), "customer_total")])
|> Selecto.select(count_distinct("customer.id"))

@spec select_shape(t(), list() | tuple()) :: t()

Compile a nested selection shape and attach it to the query.

This is an opt-in structured selection API. Use execute_shape/2 to materialize results into the same list/tuple structure.

Nested lists/tuples that only reference a single joined schema are treated as subselect nodes.

@spec set(t()) :: Selecto.Types.query_set()

See Selecto.Fields.set/1.

@spec source_table(t()) :: Selecto.Types.table_name() | nil

See Selecto.Fields.source_table/1.

@spec sqlite_fts_rank(
  t(),
  atom() | String.t() | [atom() | String.t()],
  keyword() | map()
) :: t()

Add a SQLite FTS5 ranking selector using bm25(...).

This helper is intentionally narrow: all referenced fields must be configured as SQLite FTS5 fields on the same source alias.

Add subselect fields to return related data as aggregated arrays.

This prevents result set denormalization while maintaining relational context by returning related data as JSON arrays, PostgreSQL arrays, or other formats.

Examples

# Basic subselect - get orders as JSON for each attendee
selecto
|> Selecto.select(["attendee.name"])
|> Selecto.subselect(["order.product_name", "order.quantity"])

# With custom configuration
selecto
|> Selecto.subselect([
     %{
       fields: ["product_name", "quantity"],
       target_schema: :order,
       format: :json_agg,
       alias: "order_items"
     }
   ])

Options

• :format - Aggregation format (:json_agg, :array_agg, :string_agg, :count)
• :alias_prefix - Prefix for generated field aliases

See Selecto.Subselect module for more details.

@spec tenant(t()) :: map() | nil

Read tenant context from query state.

@spec tenant_required?(
  t(),
  keyword()
) :: boolean()

Return whether tenant scope is required for this query.

@spec text_search_rank(
  t(),
  atom() | String.t() | [atom() | String.t()],
  keyword() | map()
) :: t()

Add an adapter-aware text-search rank selector.

This is the shared entry point for ranking support. Adapters can map it onto their native ranking primitives where available.

@spec to_sql(
  t(),
  keyword()
) :: {String.t(), list()}

Generate SQL without executing - useful for debugging and caching.

Supports optional readability controls:

• pretty: true

• highlight: :ansi | :markdown

@spec type_category(Selecto.TypeSystem.sql_type()) ::
  Selecto.TypeSystem.type_category()

Get the type category for a given SQL type.

Categories: :numeric, :string, :boolean, :datetime, :json, :array, :binary, :uuid, :unknown

@spec types_compatible?(Selecto.TypeSystem.sql_type(), Selecto.TypeSystem.sql_type()) ::
  boolean()

Check if two SQL types are compatible for comparisons or assignments.

Examples

true = Selecto.types_compatible?(:integer, :decimal)
false = Selecto.types_compatible?(:string, :boolean)

@spec udf(atom() | String.t(), [term()] | term()) :: tuple()

Build a registered scalar or predicate UDF expression.

This is a convenience wrapper around the normalized {:udf, function_id, args} shape used by selectors and filters.

Examples

Selecto.udf("similarity", ["name", "Acme"])
Selecto.udf(:matches_name, ["name", "Acme%"])

@spec udf_table(atom() | String.t(), [term()] | term()) :: tuple()

Build a registered table-UDF expression for lateral joins and named laterals.

Examples

Selecto.udf_table("nearby_points", ["location", 500])
Selecto.udf_table(:nearby_points, ["location", 500])

Create a UNION set operation between two queries.

Combines results from multiple queries using UNION or UNION ALL. All queries must have compatible column counts and types.

Options

• :all - Use UNION ALL to include duplicates (default: false)
• :column_mapping - Map columns between incompatible schemas

Examples

# Basic UNION (removes duplicates)
query1 |> Selecto.union(query2)

# UNION ALL (includes duplicates, faster)
query1 |> Selecto.union(query2, all: true)

# UNION with column mapping
customers |> Selecto.union(vendors,
  column_mapping: [
    {"name", "company_name"},
    {"email", "contact_email"}
  ]
)

Add an UNNEST operation to expand array columns into rows.

UNNEST transforms array values into a set of rows, one for each array element. Can optionally include ordinality to track position in the array.

Examples

# Basic unnest
selecto |> Selecto.unnest("tags", as: "tag")

# Unnest with ordinality (includes position)
selecto |> Selecto.unnest("tags", as: "tag", ordinality: "tag_position")

# Multiple unnests (will be cross-joined)
selecto
|> Selecto.unnest("tags", as: "tag")
|> Selecto.unnest("categories", as: "category")

@spec validate_tenant_scope(
  t(),
  keyword()
) :: :ok | {:error, Selecto.Error.t()}

Validate tenant scope and return :ok or structured validation error.

Add a window function to the query.

Window functions provide analytical capabilities over a set of rows related to the current row, without grouping rows into a single result.

Examples

# Add row numbers within each category
selecto |> Selecto.window_function(:row_number,
  over: [partition_by: ["category"], order_by: ["created_at"]])

# Calculate running total
selecto |> Selecto.window_function(:sum, ["amount"],
  over: [partition_by: ["user_id"], order_by: ["date"]],
  as: "running_total")

# Get previous value for comparison
selecto |> Selecto.window_function(:lag, ["amount", 1],
  over: [partition_by: ["user_id"], order_by: ["date"]],
  as: "prev_amount")

Add a Common Table Expression (CTE) to the query using WITH clause.

CTEs provide a way to create temporary named result sets that can be referenced within the main query, enabling query modularity and readability.

Parameters

• selecto - The Selecto instance
• name - CTE name (must be valid SQL identifier)
• query_builder - Function that returns a Selecto query for the CTE
• opts - Options including :columns, :dependencies, and optional :join

Join shortcut options (:join):

• true - infer join keys from first declared CTE column
• keyword/map - any Selecto.join/3 options (:type, :owner_key, :related_key, :on, :fields)
• fields: :infer - infer join fields from declared CTE columns

Examples

# Simple CTE for filtering
selecto
|> Selecto.with_cte("active_customers", fn ->
    Selecto.configure(customer_domain, connection)
    |> Selecto.filter([{"active", true}])
  end,
  join: [owner_key: :customer_id, related_key: :customer_id]
)
|> Selecto.select(["film.title", "active_customers.first_name"])

# CTE with explicit columns
selecto
|> Selecto.with_cte("customer_stats",
    fn ->
      Selecto.configure(customer_domain, connection)
      |> Selecto.select(["customer_id", {:func, "COUNT", ["rental_id"], as: "rental_count"}])
      |> Selecto.join(:left, "rental", on: "customer.customer_id = rental.customer_id")
      |> Selecto.group_by(["customer_id"])
    end,
    columns: ["customer_id", "rental_count"]
  )

# Named CTE member from domain.query_members.ctes
selecto
|> Selecto.with_cte(:active_customers)
|> Selecto.select(["film.title", "active_customers.first_name"])

# Generated SQL:
# WITH active_customers AS (
#   SELECT * FROM customer WHERE active = true
# )
# SELECT film.title, active_customers.first_name
# FROM film
# INNER JOIN active_customers ON rental.customer_id = active_customers.customer_id

Add multiple CTEs to the query in a single operation.

Useful for complex queries that require multiple temporary result sets. CTEs will be automatically ordered based on their dependencies.

Parameters

• selecto - The Selecto instance
• cte_specs - List of CTE specifications created with create_cte/3
• opts - Options including :joins for auto-joining one or more CTEs

Batch join shortcut options (:joins):

• true - auto-join every provided CTE (default key inference)
• list of entries where each entry is one of:
  • cte name ("my_cte" or :my_cte) to use inferred defaults
  • {name, join_opts} tuple
  • keyword/map with :name plus join options

Examples

# Multiple related CTEs
active_customers_cte = Selecto.Advanced.CTE.create_cte("active_customers", fn ->
  Selecto.configure(customer_domain, connection)
  |> Selecto.filter([{"active", true}])
end)

high_value_cte = Selecto.Advanced.CTE.create_cte("high_value_customers", fn ->
  Selecto.configure(customer_domain, connection)
  |> Selecto.aggregate([{"payment.amount", :sum, as: "total_spent"}])
  |> Selecto.join(:inner, "payment", on: "customer.customer_id = payment.customer_id")
  |> Selecto.group_by(["customer.customer_id"])
  |> Selecto.having([{"total_spent", {:>, 100}}])
end, dependencies: ["active_customers"])

selecto
|> Selecto.with_ctes([active_customers_cte, high_value_cte],
  joins: [
    [name: "active_customers", owner_key: :customer_id, related_key: :customer_id],
    [name: "high_value_customers", owner_key: :customer_id, related_key: :customer_id]
  ]
)
|> Selecto.select(["film.title", "high_value_customers.total_spent"])

@spec with_lateral(t(), atom() | String.t(), keyword() | map()) :: t()

Apply a LATERAL source directly or resolve a named LATERAL preset from domain.query_members.laterals.

Examples

selecto
|> Selecto.with_lateral(:recent_rentals)

selecto
|> Selecto.with_lateral(:recent_rentals, join_type: :inner)

selecto
|> Selecto.with_lateral(Selecto.udf_table("nearby_points", ["location", 500]),
  as: "nearby_points",
  join_type: :left
)

Add a recursive Common Table Expression (CTE) to the query.

Recursive CTEs enable hierarchical queries by combining an anchor query with a recursive query that references the CTE itself.

Parameters

• selecto - The Selecto instance
• name - CTE name (must be valid SQL identifier)
• opts - Options with :base_query, :recursive_query, and optional :join

Join shortcut options (:join) follow with_cte/4.

Examples

# Hierarchical employee structure
selecto
|> Selecto.with_recursive_cte("employee_hierarchy",
    base_query: fn ->
      # Anchor: top-level managers
      Selecto.configure(employee_domain, connection)
      |> Selecto.select(["employee_id", "name", "manager_id", {:literal, 0, as: "level"}])
      |> Selecto.filter([{"manager_id", nil}])
    end,
    recursive_query: fn cte_ref ->
      # Recursive: subordinates
      Selecto.configure(employee_domain, connection)
      |> Selecto.select(["employee.employee_id", "employee.name", "employee.manager_id",
                        {:func, "employee_hierarchy.level + 1", as: "level"}])
      |> Selecto.join(:inner, cte_ref, on: "employee.manager_id = employee_hierarchy.employee_id")
    end,
    join: [owner_key: :employee_id, related_key: :employee_id]
  )
|> Selecto.select([
    "employee_hierarchy.employee_id",
    "employee_hierarchy.name",
    "employee_hierarchy.level"
  ])
|> Selecto.order_by([{"employee_hierarchy.level", :asc}, {"employee_hierarchy.name", :asc}])

# Generated SQL:
# WITH RECURSIVE employee_hierarchy AS (
#   SELECT employee_id, name, manager_id, 0 as level
#   FROM employee
#   WHERE manager_id IS NULL
#   UNION ALL
#   SELECT employee.employee_id, employee.name, employee.manager_id, employee_hierarchy.level + 1
#   FROM employee
#   INNER JOIN employee_hierarchy ON employee.manager_id = employee_hierarchy.employee_id
# )
# SELECT employee_hierarchy.employee_id, employee_hierarchy.name, employee_hierarchy.level
# FROM employee
# INNER JOIN employee_hierarchy ON employee.employee_id = employee_hierarchy.employee_id
# ORDER BY employee_hierarchy.level ASC, employee_hierarchy.name ASC

@spec with_subquery(t(), atom() | String.t(), keyword() | map()) :: t()

Apply a named subquery preset from domain.query_members.subqueries.

This resolves a preconfigured subquery member and applies Selecto.join_subquery/4 with optional overrides.

Examples

selecto
|> Selecto.with_subquery(:high_value_orders)

selecto
|> Selecto.with_subquery(:high_value_orders, type: :left)

@spec with_tenant(t(), map() | keyword() | String.t() | atom() | nil) :: t()

Attach tenant context to the query state.

@spec with_unnest(t(), atom() | String.t(), keyword() | map()) :: t()

Apply a named UNNEST preset from domain.query_members.unnests.

Examples

selecto
|> Selecto.with_unnest(:product_tags)

Add a VALUES clause to create an inline table from literal data.

VALUES clauses allow creating inline tables from literal values, useful for data transformations, lookup tables, and testing scenarios.

Parameters

• selecto - The Selecto struct
• data - List of data rows (lists or maps)
• opts - Options including :columns (explicit column names), :as (table alias), and optional :join configuration to auto-join the VALUES table

Examples

# Basic VALUES table with explicit columns
selecto
|> Selecto.with_values([
    ["PG", "Family Friendly", 1],
    ["PG-13", "Teen", 2],
    ["R", "Adult", 3]
  ],
  columns: ["rating_code", "description", "sort_order"],
  as: "rating_lookup"
)

# Map-based VALUES (columns inferred from keys)
selecto
|> Selecto.with_values([
    %{month: 1, name: "January", days: 31},
    %{month: 2, name: "February", days: 28},
    %{month: 3, name: "March", days: 31}
  ], as: "months")

# VALUES with auto-join (fields inferred from VALUES columns)
selecto
|> Selecto.with_values([
    ["processing", "In Progress"],
    ["shipped", "In Transit"]
  ],
  columns: ["status", "status_label"],
  as: "status_labels",
  join: [owner_key: :status, related_key: :status]
)
|> Selecto.select(["order_number", "status_labels.status_label"])

# Named VALUES member from domain.query_members.values
selecto
|> Selecto.with_values(:status_labels)
|> Selecto.select(["order_number", "status_labels.status_label"])

# Generated SQL:
# WITH rating_lookup (rating_code, description, sort_order) AS (
#   VALUES ('PG', 'Family Friendly', 1),
#          ('PG-13', 'Teen', 2),
#          ('R', 'Adult', 3)
# )