Squirrelix.Query (Squirrelix v0.4.0)

Copy Markdown View Source

Parses Squirrel SQL query files into Elixir structs.

Summary

Types

t()

Functions

from_file(file)

Types

t()

@type t() :: %Squirrelix.Query{
  comment: [String.t()],
  content: String.t(),
  file: String.t(),
  name: String.t(),
  starting_line: pos_integer()
}

Functions

from_file(file)

@spec from_file(String.t()) ::
  {:ok, t()}
  | {:error,
     Squirrelix.Error.CannotReadFile.t()
     | Squirrelix.Error.QueryFileHasInvalidName.t()}