AyeSQL v0.4.1 AyeSQL.Core View Source

This module defines the core functionality for AyeSQL.

Link to this section Summary

Types

SQL query arguments.

AyeSQL AST.

Contents of the query.

Documentation of the query function.

Definition of the query in the AST.

Name of the query function.

AyeSQL query options.

AyeSQL query parameters.

AyeSQL query.

SQL query statements.

Functions

Creates several queries from the contents of a file.

Whether the queries should run by default or not.

Link to this section Types

Link to this type

arguments()

View Source
arguments() :: list()

SQL query arguments.

AyeSQL AST.

Link to this type

content()

View Source
content() :: [atom() | binary()]

Contents of the query.

Documentation of the query function.

Link to this type

fun_def()

View Source
fun_def() :: {name(), docs(), content()}

Definition of the query in the AST.

Name of the query function.

AyeSQL query options.

Link to this type

parameters()

View Source
parameters() :: map() | keyword()

AyeSQL query parameters.

AyeSQL query.

Link to this type

statement()

View Source
statement() :: binary()

SQL query statements.

Link to this section Functions

Link to this function

create_queries(file)

View Source
create_queries(binary()) :: list() | no_return()

Creates several queries from the contents of a file.

Whether the queries should run by default or not.

You can set this in the configuration as:

use Mix.Config

config :ayesql,
  run?: true