Crate lunatic_diesel

source ·

Modules

associations

Traits related to relationships between multiple tables.

backend

Types which represent various database backends

connection

Types related to database connections

data_types

Structs to represent the primitive equivalent of SQL types where there is no existing Rust primitive, or where using it would be confusing (such as date and time types). This module will re-export all backend specific data structures when compiled against that backend.

deserialize

Types and traits related to deserializing values from the database

dsl

Includes various helper types and bare functions which are named too generically to be included in prelude, but are often used when using Diesel.

expression

AST types representing various typed SQL expressions.

expression_methods

Adds various methods to construct new expressions. These traits are exported by default, and implemented automatically.

helper_types

Provide helper types for concisely writing the return type of functions. As with iterators, it is unfortunately difficult to return a partially constructed query without exposing the exact implementation of the function. Without higher kinded types, these various DSLs can’t be combined into a single trait for boxing purposes.

migration

Representation of migrations

prelude

Re-exports important traits and types. Meant to be glob imported when using Diesel.

query_builder

Contains traits responsible for the actual construction of SQL statements

query_dsl

Traits that construct SELECT statements

query_source

Types related to describing schema, and interactions between tables.

result

Errors, type aliases, and functions related to working with Result.

row

Contains the Row trait

serialize

Types and traits related to serializing values for the database

sql_types

Types which represent a SQL data type.

sqlite

upsert

Types and functions related to PG’s and Sqlite’s ON CONFLICT clause

Macros

alias

Declare a new alias for a table

allow_columns_to_appear_in_same_group_by_clause

Allow two or more columns which are otherwise unrelated to be used together in a group by clause.

allow_tables_to_appear_in_same_query

Allow two or more tables which are otherwise unrelated to be used together in a query.

infix_operator

Useful for libraries adding support for new SQL types. Apps should never need to call this.

joinable

Allow two tables to be referenced in a join query without providing an explicit ON clause.

no_arg_sql_functionDeprecated

Declare a 0 argument SQL function for use in your code. This will generate a unit struct, which is an expression representing calling this function. See now for example output. now was generated using:

numeric_expr

Indicates that an expression allows all numeric operators. If you create new SQL functions that return a numeric type, you should invoke this macro that type. Unfortunately, Rust disallows us from automatically implementing Add for types which implement Expression, under its orphan rules.

operator_allowed

Implements the Rust operator for a given type. If you create a new SQL function, which returns a type that you’d like to use an operator on, you should invoke this macro. Unfortunately, Rust disallows us from automatically implementing Add and other traits from std::ops, under its orphan rules.

postfix_operator

Useful for libraries adding support for new SQL types. Apps should never need to call this.

prefix_operator

Useful for libraries adding support for new SQL types. Apps should never need to call this.

sql_function

Declare a sql function for use in your code.

table

Specifies that a table exists, and what columns it has. This will create a new public module, with the same name, as the name of the table. In this module, you’ll find a unit struct named table, and a unit struct with the names of each of the columns.

Structs

SqliteConnection

Connections for the SQLite backend. Unlike other backends, SQLite supported connection URLs are:

Enums

ConnectionError

Errors which can occur during Connection::establish

Traits

AppearsOnTable

Indicates that all elements of an expression are valid given a from clause.

AsChangeset

Types which can be passed to update.set.

BelongingToDsl

Constructs a query that finds record(s) based on directional association with other record(s).

BoolExpressionMethods

Methods present on boolean expressions

BoxableExpression

Helper trait used when boxing expressions.

Column

A column on a database table. Types which implement this trait should have been generated by the table! macro.

CombineDsl

Extension trait to combine queries using a combinator like UNION, INTERSECT or EXPECT with or without ALL rule for duplicates

Connection

A connection to a database

DecoratableTarget

Interface to add information to conflict targets. Designed to be open for further additions to conflict targets like constraints

EscapeExpressionMethods

Adds the escape method to LIKE and NOT LIKE. This is used to specify the escape character for the pattern.

Expression

Represents a typed fragment of SQL.

ExpressionMethods

Methods present on all expressions, except tuples

GroupedBy

The grouped_by function groups records by their parent.

Identifiable

This trait indicates that a struct represents a single row in a database table.

Insertable

Represents that a structure can be used to insert a new row into the database. This is automatically implemented for &[T] and &Vec<T> for inserting more than one record.

IntoSql

Converts a type to its representation for use in Diesel’s query builder.

JoinOnDsl

Specify the ON clause for a join statement. This will override any implicit ON clause that would come from joinable!

JoinTo

Indicates that two tables can be joined without an explicit ON clause.

NullableExpressionMethods

Methods present on all expressions

OptionalExtension

See the method documentation.

QueryDsl

Methods used to construct select statements.

QuerySource

Represents a type which can appear in the FROM clause. Apps should not need to concern themselves with this trait.

Queryable

Trait indicating that a record can be queried from the database.

QueryableByName

Deserializes the result of a query constructed with sql_query.

RunQueryDsl

Methods used to execute queries.

SaveChangesDsl

Sugar for types which implement both AsChangeset and Identifiable

Selectable

Trait indicating that a record can be selected and queried from the database.

SelectableExpression

Indicates that an expression can be selected from a source.

SelectableHelper

This helper trait provides several methods for constructing a select or returning clause based on a Selectable implementation.

Table

A SQL database table. Types which implement this trait should have been generated by the table! macro.

TextExpressionMethods

Methods present on text expressions

Functions

debug_query

Takes a query QueryFragment expression as an argument and returns a type that implements fmt::Display and fmt::Debug to show the query.

delete

Creates a DELETE statement.

insert_into

Creates an INSERT statement for the target table.

insert_or_ignore_into

Creates an INSERT [OR] IGNORE statement.

replace_into

Creates a REPLACE statement.

select

Creates a bare select statement, with no from clause. Primarily used for testing diesel itself, but likely useful for third party crates as well. The given expressions must be selectable from anywhere.

sql_query

Construct a full SQL query using raw SQL.

update

Creates an UPDATE statement.