Squirrelix.TypedQuery (Squirrelix v0.4.0)

Copy Markdown View Source

A query annotated with parameter and return column metadata.

Summary

Types

t()

Functions

from_query(query, opts)
resolve_parameter_names(params)

Types

t()

@type t() :: %Squirrelix.TypedQuery{
  comment: [String.t()],
  content: String.t(),
  file: String.t(),
  name: String.t(),
  params: [Squirrelix.Parameter.t()],
  returns: [Squirrelix.Column.t()],
  starting_line: pos_integer()
}

Functions

from_query(query, opts)

@spec from_query(
  Squirrelix.Query.t(),
  keyword()
) ::
  {:ok, t()}
  | {:error,
     Squirrelix.Error.DuplicateReturnColumns.t()
     | Squirrelix.Error.MissingQueryMetadataField.t()
     | Squirrelix.Error.QueryHasInvalidColumn.t()
     | struct()}

resolve_parameter_names(params)

@spec resolve_parameter_names([Squirrelix.Parameter.t()]) :: [String.t()]