Runtime accessors for ClickHouse-specific options configured on Ash resources.

These functions read the configuration produced by the clickhouse DSL block (see AshClickhouse.DataLayer.Dsl.Macros). They are intentionally kept in a separate module from the clickhouse macro so that importing the macro module does not also import these getters — that separation lets a resource define a local helper named like a DSL key (e.g. table/1) without it being shadowed by an imported getter.

Usage

defmodule MyApp.MyResource do
  use Ash.Resource,
    data_layer: AshClickhouse.DataLayer

  import AshClickhouse.DataLayer.Dsl.Macros

  clickhouse do
    table "my_table"
    repo MyApp.Repo
    database "my_app_dev"

    base_filter [status: "active"]
    default_context %{tenant: "org_123"}
    description "My resource description"

    engine "MergeTree()"
    order_by "id"
    partition_by "toYYYYMM(inserted_at)"

    settings "index_granularity = 8192"
  end

  attributes do
    uuid_primary_key :id
    attribute :name, :string
  end
end

Options

• :table — the table name in ClickHouse (overrides the default)
• :repo — the AshClickhouse.Repo module to use
• :database — the database to use (overrides repo default)
• :engine — the ClickHouse table engine (default "MergeTree()")
• :order_by — ORDER BY expression for the table engine
• :partition_by — PARTITION BY expression for the table engine
• :primary_key — explicit primary key columns (ClickHouse PRIMARY KEY)
• :settings — engine settings string
• :base_filter — a filter applied to all queries on this resource
• :default_context — context merged into every query/changeset
• :description — human-readable description of the resource
• :migrate — whether this resource is included in migrations (default true)
• :insert_opts — options applied to bulk inserts (e.g. async_insert: 1)
• :mutations_sync — default mutations_sync for ALTER mutations (1/2/nil)
• :index — repeated; declares a data-skipping index (see clickhouse do ... end)