Module diesel::query_builder

Contains traits responsible for the actual construction of SQL statements

The types in this module are part of Diesel’s public API, but are generally only useful for implementing Diesel plugins. Applications should generally not need to care about the types inside of this module.

Modules

bind_collector

Types related to managing bind parameters during query construction.

Structs

AstPass

The primary type used when walking a Diesel AST during query execution.

AstPassToSqlOptionsi-implement-a-third-party-backend-and-opt-into-breaking-changes

This is used to pass down additional settings to the AstPass when rendering the sql string.

BatchInserti-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a batch insert clause, which allows to insert multiple rows at once.

BoxedLimitOffsetClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A boxed variant of LimitOffsetClause

BoxedSelectStatementi-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a boxed select query

BoxedSqlQuery

See SqlQuery::into_boxed.

DebugQuery

A struct that implements fmt::Display and fmt::Debug to show the SQL representation of a query.

DeleteStatement

Represents a SQL DELETE statement.

IncompleteInsertStatement

The structure returned by insert_into.

InsertStatementi-implement-a-third-party-backend-and-opt-into-breaking-changes

A fully constructed insert statement.

LimitClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A query node representing a limit clause

LimitOffsetClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A helper query node that contains both limit and offset clauses

NoFromClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a not existing from clause

NoLimitClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A query node indicating the absence of a limit clause

NoOffsetClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A query node indicating the absence of an offset clause

OffsetClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

A query node representing an offset clause

Onlypostgres_backend

Represents a query with an ONLY clause.

ReturningClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a SQL Returning clause

SelectStatementi-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a select query

SqlQuery

The return value of sql_query.

UpdateStatement

Represents a complete UPDATE statement.

ValuesClausei-implement-a-third-party-backend-and-opt-into-breaking-changes

This type represents a values clause used as part of insert statements

Traits

AsChangeset

Types which can be passed to update.set.

AsQuery

Types that can be converted into a complete, typed SQL query.

BindCollector

A type which manages serializing bind parameters during query construction.

DecoratableTarget

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

IntoBoxedClause

A trait used to construct type erased boxed variant of the current query node

IntoUpdateTarget

A type which can be passed to update or delete.

Query

A complete SQL query with a return type.

QueryBuilder

Constructs a SQL query from a Diesel AST.

QueryFragment

An untyped fragment of SQL.

QueryId

Uniquely identifies queries by their type for the purpose of prepared statement caching.

SelectClauseExpressioni-implement-a-third-party-backend-and-opt-into-breaking-changes

Specialised variant of Expression for select clause types

SelectQuery

Indicates that a type is a SELECT statement.

UndecoratedInsertRecordi-implement-a-third-party-backend-and-opt-into-breaking-changes

Marker trait to indicate that no additional operations have been added to a record for insert.

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.

Type Definitions

BoxedDeleteStatement

A DELETE statement with a boxed WHERE clause

BoxedUpdateStatement

An UPDATE statement with a boxed WHERE clause.

BuildQueryResult

A specialized Result type used with the query builder.

IncompleteInsertOrIgnoreStatement

Represents the return type of diesel::insert_or_ignore_into

IncompleteReplaceStatement

Represents the return type of diesel::replace_into

InsertOrIgnoreStatement

Represents a complete INSERT OR IGNORE statement.

ReplaceStatement

Represents a complete INSERT OR REPLACE statement.

Derive Macros

AsChangeset

Implements AsChangeset

QueryId

Implements QueryId