@spec queryable_columns(module()) :: [atom()]

Returns the list of columns that are safe to filter on for a resource.

@spec validate_aggregate_filters(module(), list()) :: :ok | no_return()

Validates aggregate filters for a resource.

Ensures that aggregate queries reference valid columns and that the aggregate type is supported by ScyllaDB.

Supported aggregate types: :count, :sum, :avg, :min, :max

Parameters

• resource - The Ash resource module
• aggregates - List of aggregate maps with :type, :name, and optional :field keys

Examples

FilterValidator.validate_aggregate_filters(MyApp.User, [%{type: :count, name: :total}])
# => :ok

FilterValidator.validate_aggregate_filters(MyApp.User, [%{type: :sum, name: :total_age, field: :age}])
# => :ok

@spec validate_all(module(), list(), keyword()) :: :ok | no_return()

Comprehensive validation that runs all filter validators.

This is the recommended entry point for validating all aspects of a query against a resource.

Parameters

• resource - The Ash resource module
• filters - List of Ash filter expressions
• opts - Keyword list of options:
  • :aggregates - List of aggregate maps
  • :calculations - List of calculation maps
  • :validate_base - Whether to validate the base_filter (default: true)
  • :validate_relationships - Whether to validate relationship filters (default: true)
  • :validate_exists - Whether to validate EXISTS filters (default: true)
  • :validate_in - Whether to validate IN filters (default: true)

@spec validate_base_filter(module()) :: :ok | no_return()

Validates base_filter expressions from the resource DSL.

Ensures that the base_filter references valid columns and that those columns are queryable (primary key or indexed).

Parameters

• resource - The Ash resource module

@spec validate_calculation_filters(module(), list()) :: :ok | no_return()

Validates calculation filters for a resource.

Ensures that calculation expressions reference valid attributes and that the calculation module (if specified) exists and implements the required behaviour.

Parameters

• resource - The Ash resource module
• calculations - List of calculation maps with :name, :type, and :expression keys

@spec validate_exists_filters(module(), list()) :: :ok | no_return()

Validates EXISTS filter expressions.

EXISTS filters check for the presence of a value (IS NOT NULL in CQL). This is valid for any column that exists on the resource.

Parameters

• resource - The Ash resource module
• filters - List of filter expressions that may include EXISTS checks

@spec validate_filters(module(), list()) :: :ok | no_return()

Validates that all filter columns on a resource are queryable.

Returns :ok if all filters are on primary key columns or indexed columns. Raises AshScylla.Error with an actionable message if a filter would require ALLOW FILTERING.

Parameters

• resource - The Ash resource module
• filters - List of Ash filter expressions

Examples

AshScylla.DataLayer.FilterValidator.validate_filters(MyApp.User, filters)
# => :ok

AshScylla.DataLayer.FilterValidator.validate_filters(MyApp.User, [{:non_indexed_col, :eq, "value"}])
# => raises AshScylla.Error with suggestion to add secondary_index

@spec validate_in_filters(module(), list()) :: :ok | no_return()

Validates IN filter expressions with list values.

IN filters are valid when:

• The column is a primary key or indexed
• The value list is not empty
• All values in the list are of a compatible type

Parameters

• resource - The Ash resource module
• filters - List of filter expressions that may include IN checks

@spec validate_relationship_filters(module(), list()) :: :ok | no_return()

Validates relationship filters for a resource.

Ensures that relationship filters reference valid relationships and that the relationship target columns are queryable.

Parameters

• resource - The Ash resource module
• filters - List of filter expressions that may reference relationships

Examples

FilterValidator.validate_relationship_filters(MyApp.Post, [%{path: [:author, :name], op: :eq, value: "Alice"}])
# => :ok if :author is a valid belongs_to relationship