Sets an action reference for a capability.

Sets the allowed aggregate functions for a column.

Options: :sum, :avg, :count, :min, :max

Sets the allowed call sites for a UDF registration.

Sets allowed write operations for a relationship.

Adds an argument definition to a UDF registration.

Sets the UNNEST array field/expression for named UNNEST members.

Sets the SQL alias/table name for named VALUES members.

Sets recursive CTE base query function.

Sets whether a write operation is bulk-capable.

Sets the capability required by a query-facing overlay entry.

Sets relationship cardinality.

Sets cascade delete behavior for a write relationship.

Sets cascade update behavior for a write relationship.

Binds a field to a declared choice source.

Sets declared columns for CTE/VALUES query members.

Marks a column as computed (not from database).

Sets write operation conflict targets.

Alias for rows/1 in named VALUES members.

Defines a domain action under the top-level actions registry.

Sets the default value for the filter.

Sets a default provider for a write field.

Defines a capability under the top-level capabilities registry.

Defines a choice source under the top-level choice_sources registry.

Example

defchoice_source(:assignees, %{
  domain: :employee,
  value_field: :id,
  label_field: :full_name,
  source_relationship: :assignee
})

Defines a column customization.

Example

defcolumn :price do
  label "Product Price"
  format :currency
  aggregate_functions [:sum, :avg]
end

Defines a named CTE preset for Selecto.with_cte/2.

Example

defcte :active_customers do
  query &__MODULE__.active_customers_cte/1
  columns ["id", "name"]
  join [owner_key: :id, related_key: :id, fields: :infer]
end

Defines a detail-row action.

Example

defdetail_action :customer_profile do
  name("Customer Profile")
  description("Open the customer profile in a new tab")
  type(:external_link)
  required_fields([:customer_id])
  payload(%{url_template: "https://app.example.test/customers/{{customer_id}}"})
end

Defines a custom filter.

Example

deffilter "price_range" do
  name "Price Range"
  type :string
  description "Filter by price range"
end

Defines a named UDF specification.

Defines a join configuration under the top-level joins registry.

Example

defjoin :initiative, %{
  type: :left,
  schema: MyApp.Initiative,
  owner_key: :initiative_id,
  related_key: :id
}

Defines a JSONB schema for a JSONB column, enabling typed field access, filtering, and display of structured JSON data.

Example

defjsonb_schema :attributes do
  field :color, :string, label: "Color"
  field :weight, :decimal, label: "Weight (kg)", precision: 2
  field :organic, :boolean, label: "Organic"
  field :origin_country, :string, label: "Country of Origin"
  field :certifications, {:array, :string}, label: "Certifications"
  field :dimensions, :object do
    field :width, :decimal, label: "Width"
    field :height, :decimal, label: "Height"
    field :depth, :decimal, label: "Depth"
  end
end

Supported Field Types

• :string - Text values
• :integer - Whole numbers
• :decimal - Decimal numbers (supports precision option)
• :boolean - True/false values
• :date - Date values (ISO 8601 format)
• :datetime - DateTime values (ISO 8601 format)
• {:array, type} - Arrays of the specified type
• :object - Nested object (use nested field calls)

Field Options

• label - Human-readable label for display
• precision - Decimal precision (for :decimal type)
• required - Whether the field is required (default: false)
• default - Default value for the field
• filterable - Whether the field can be filtered (default: true)
• sortable - Whether the field can be sorted (default: true)
• format - Display format (:currency, :percentage, etc.)

Defines a named LATERAL preset for Selecto.with_lateral/2.

Example

deflateral :tag_expansion do
  source {:unnest, ""selecto_root"."tags""}
  as "tag_expansion"
  join_type :inner
end

Defines a modal detail-row action.

This is a convenience wrapper around defdetail_action that defaults type to :modal.

Defines a schema configuration under the top-level schemas registry.

Example

defschema :initiative, %{
  source_table: "initiatives",
  columns: %{id: %{type: :integer}, name: %{type: :string}}
}

Defines an association under a schema entry in schemas.

Example

defschema_assoc(:bundle_parent_load, :split_parent_load, %{
  queryable: :split_parent_load,
  field: :split_parent_load,
  owner_key: :split_parent_id,
  related_key: :id
})

Defines a root source association under source.associations.

Example

defsource_assoc(:bundle_parent_load, %{
  queryable: :bundle_parent_load,
  field: :bundle_parent_load,
  owner_key: :bundle_parent_id,
  related_key: :id
})

Defines a source relationship under the top-level source_relationships registry.

Example

defsource_relationship(:assignee, %{
  target_domain: :employee,
  source_field: :assignee_id,
  target_field: :id,
  source_path: "assignee"
})

Defines a named subquery preset for Selecto.with_subquery/2.

Example

defsubquery :high_value_orders do
  query &__MODULE__.high_value_orders_subquery/1
  type :inner
  on [%{left: "id", right: "customer_id"}]
end

Defines a named UNNEST preset for Selecto.with_unnest/2.

Example

defunnest :product_tags do
  array_field "tags"
  as "tag"
  ordinality "tag_position"
end

Defines a named VALUES preset for Selecto.with_values/2.

Example

defvalues :status_lookup do
  rows [["active", "Active"], ["inactive", "Inactive"]]
  columns ["status", "label"]
  as "status_lookup"
  join [owner_key: :status, related_key: :status]
end

Appends a write constraint rule under writes.constraints.

Defines a write field under writes.fields.

Defines declared host-runtime hook references under writes.hooks.

Hook references remain host-owned code. Domain inspection and exported contracts expose only safe metadata for these references.

Defines a write operation under writes.operations.

Examples

defwrite_operation :insert do
  enabled true
  returning :record
end

defwrite_operation :delete, %{enabled: true, require_filter: true}

Defines a write relationship under writes.relationships.

Defines canonical tenant scope metadata under writes.scope.tenant.

Examples

defwrite_tenant_scope do
  required(true)
  field(:tenant_id)
  satisfied_by([:trusted_context, :prefix])
end

defwrite_tenant_scope %{required: true, field: :tenant_id}

Defines a transition graph under writes.transitions.

Appends a write validation rule under writes.validations.

Sets CTE dependency names.

Sets the filter description/help text.

Sets whether a write operation, field, or relationship is enabled.

Sets execution metadata for a domain action.

Defines a field within a JSONB schema.

This macro is only valid inside a defjsonb_schema block.

Examples

# Simple field with type and label
field :color, :string, label: "Color"

# Field with multiple options
field :weight, :decimal, label: "Weight", precision: 2, required: true

# Array field
field :tags, {:array, :string}, label: "Tags"

# Nested object field
field :dimensions, :object do
  field :width, :decimal
  field :height, :decimal
end

Sets whether the column is filterable.

Sets write operations that forbid the field.

Sets the foreign key for a write relationship.

Sets the display format for a column.

Common formats: :currency, :percentage, :number, :date, :datetime, :yes_no

Marks a write field immutable.

Sets whether a write field is insertable.

Sets join options for query member auto-join behavior.

Sets explicit join id for named subquery members.

Sets the join type for named LATERAL members.

Sets named subquery kind (:join currently supported).

Sets the human-readable label for a column or filter.

Alias for source/1 in named LATERAL members.

Sets maximum item count for a write relationship.

Sets the maximum display length for string columns.

Sets minimum item count for a write relationship.

Sets the human-readable name for a filter.

Sets ON conditions for named subquery members.

Sets operations for a capability.

Sets the valid options for a select-type filter.

Sets ordinality alias for named UNNEST members.

Sets orphan strategy metadata for a write relationship.

Sets ownership metadata for a relationship.

Sets a payload map for a detail-row action.

Sets the numeric precision for decimal columns.

Sets a query builder function for named query members.

Sets recursive CTE recursive query function.

Sets rich reference metadata for a field, including choice-source caption/value paths.

Sets whether a write operation requires a filter.

Sets whether the filter is required.

Sets required fields for a detail-row action.

Sets write operations that require the field.

Sets write operation returning behavior.

Sets the declared return type or return metadata for a UDF registration.

Sets VALUES rows for a named defvalues member.

Marks a write field as server-managed.

Sets whether the column is sortable.

Sets a source expression for named LATERAL members.

Sets the SQL function name for a UDF registration.

Sets transition metadata for a domain action.

Sets the filter type.

Common types: :string, :integer, :boolean, :date, :datetime, :decimal

Sets uniqueness fields for a write relationship.

Sets whether a write field is updatable.

Sets validators for a write field or relationship.

Sets relationship writability.

Marks a write field as write-once.