cquill - v0.1.0

cquill/query/builder

Types

QueryModifier

</>

A QueryModifier is a function that transforms a query. This is the foundation for composable query building.

pub type QueryModifier(s) =
  fn(ast.Query(s)) -> ast.Query(s)

Scope

</>

A Scope is a named, reusable query modifier. This is similar to Ecto’s query scopes.

pub type Scope(s) {
  Scope(name: String, modifier: fn(ast.Query(s)) -> ast.Query(s))
}

Constructors

Values

active

</> 
pub fn active() -> fn(ast.Query(s)) -> ast.Query(s)

Create an “active” filter. Assumes an active boolean field.

and_then

</> 
pub fn and_then(
  first: fn(ast.Query(s)) -> ast.Query(s),
  second: fn(ast.Query(s)) -> ast.Query(s),
) -> fn(ast.Query(s)) -> ast.Query(s)

Compose two modifiers into a single modifier.

apply_scope

</> 
pub fn apply_scope(
  query: ast.Query(s),
  scope: Scope(s),
) -> ast.Query(s)

Apply a scope to a query.

apply_scopes

</> 
pub fn apply_scopes(
  query: ast.Query(s),
  scopes: List(Scope(s)),
) -> ast.Query(s)

Apply multiple scopes to a query.

by_user

</> 
pub fn by_user(user_id: Int) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier for “by user” filtering. Common pattern for multi-tenant queries.

clone

</> 
pub fn clone(q: ast.Query(s)) -> ast.Query(s)

Clone a query, optionally resetting certain parts.

clone_without_conditions

</> 
pub fn clone_without_conditions(q: ast.Query(s)) -> ast.Query(s)

Clone a query but clear all WHERE conditions.

clone_without_order

</> 
pub fn clone_without_order(q: ast.Query(s)) -> ast.Query(s)

Clone a query but clear all ORDER BY.

clone_without_pagination

</> 
pub fn clone_without_pagination(q: ast.Query(s)) -> ast.Query(s)

Clone a query but clear pagination.

compose

</> 
pub fn compose(
  modifiers: List(fn(ast.Query(s)) -> ast.Query(s)),
) -> fn(ast.Query(s)) -> ast.Query(s)

Compose multiple modifiers into a single modifier. Modifiers are applied left to right.

Example

let active_admins = builder.compose([
  builder.filter(query.eq_bool("active", True)),
  builder.filter(query.eq_string("role", "admin")),
  builder.with_limit(10),
])
user_query |> active_admins

conditions_equivalent

</> 
pub fn conditions_equivalent(
  query_a: ast.Query(a),
  query_b: ast.Query(b),
) -> Bool

Check if two queries have equivalent conditions (order-independent).

count_conditions_deep

</> 
pub fn count_conditions_deep(q: ast.Query(s)) -> Int

Count total conditions including nested AND/OR.

filter

</> 
pub fn filter(
  condition: ast.Condition,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter modifier from a condition. Returns a function that adds the condition to any query.

Example

let active_filter = builder.filter(query.eq_bool("active", True))
user_query |> active_filter

filter_eq_bool

</> 
pub fn filter_eq_bool(
  field: String,
  value: Bool,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter that requires a field to equal a specific boolean.

filter_eq_int

</> 
pub fn filter_eq_int(
  field: String,
  value: Int,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter that requires a field to equal a specific integer.

filter_eq_string

</> 
pub fn filter_eq_string(
  field: String,
  value: String,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter that requires a field to equal a specific string.

filter_gt_int

</> 
pub fn filter_gt_int(
  field: String,
  value: Int,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter for values greater than a threshold.

filter_not_null

</> 
pub fn filter_not_null(
  field: String,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter for non-null values.

filter_null

</> 
pub fn filter_null(
  field: String,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a filter for null values.

get_condition_fields

</> 
pub fn get_condition_fields(q: ast.Query(s)) -> List(String)

Extract all field names referenced in conditions.

identity

</> 
pub fn identity() -> fn(ast.Query(s)) -> ast.Query(s)

Create an identity modifier (does nothing).

merge_conditions

</> 
pub fn merge_conditions(
  target: ast.Query(s),
  source: ast.Query(a),
) -> ast.Query(s)

Merge conditions from source query into target query. Preserves target’s source, select, and other settings.

merge_order_bys

</> 
pub fn merge_order_bys(
  target: ast.Query(s),
  source: ast.Query(a),
) -> ast.Query(s)

Merge order_bys from source query into target query.

merge_pagination

</> 
pub fn merge_pagination(
  target: ast.Query(s),
  source: ast.Query(a),
) -> ast.Query(s)

Merge pagination (limit/offset) from source to target. Only applies if target doesn’t already have pagination.

not_deleted

</> 
pub fn not_deleted() -> fn(ast.Query(s)) -> ast.Query(s)

Create a “soft delete” filter that excludes soft-deleted records. Assumes a deleted_at field that is NULL for non-deleted records.

oldest_first

</> 
pub fn oldest_first() -> fn(ast.Query(s)) -> ast.Query(s)

Create an “oldest first” ordering modifier. Assumes a created_at timestamp field.

order_asc

</> 
pub fn order_asc(
  field: String,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that adds ORDER BY ASC.

order_desc

</> 
pub fn order_desc(
  field: String,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that adds ORDER BY DESC.

published

</> 
pub fn published() -> fn(ast.Query(s)) -> ast.Query(s)

Create a “published” filter for content models. Assumes a published boolean field.

recent_first

</> 
pub fn recent_first() -> fn(ast.Query(s)) -> ast.Query(s)

Create a “recent first” ordering modifier. Assumes a created_at timestamp field.

scope

</> 
pub fn scope(
  name: String,
  modifier: fn(ast.Query(s)) -> ast.Query(s),
) -> Scope(s)

Create a named scope.

when

</> 
pub fn when(
  condition: Bool,
  modifier: fn(ast.Query(s)) -> ast.Query(s),
) -> fn(ast.Query(s)) -> ast.Query(s)

Conditionally apply a modifier. If the condition is true, apply the modifier; otherwise, return unchanged.

when_some

</> 
pub fn when_some(
  maybe_value: option.Option(a),
  modifier_factory: fn(a) -> fn(ast.Query(s)) -> ast.Query(s),
) -> fn(ast.Query(s)) -> ast.Query(s)

Apply a modifier based on an optional value. If the value is Some, apply the modifier factory with that value.

with_distinct

</> 
pub fn with_distinct() -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that makes the query distinct.

with_limit

</> 
pub fn with_limit(count: Int) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that sets the limit.

with_offset

</> 
pub fn with_offset(
  count: Int,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that sets the offset.

with_pagination

</> 
pub fn with_pagination(
  page: Int,
  per_page: Int,
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that sets pagination.

with_select

</> 
pub fn with_select(
  fields: List(String),
) -> fn(ast.Query(s)) -> ast.Query(s)

Create a modifier that sets specific fields to select.

✨ Search Document