Struct CreateIndexStatement 

pub struct CreateIndexStatement { /* private fields */ }

Available on crate feature database and non-WebAssembly only.

CREATE INDEX statement builder

This struct provides a fluent API for constructing CREATE INDEX queries.

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_email")
    .table("users")
    .col("email")
    .unique();

Implementations

impl CreateIndexStatement

pub fn new() -> CreateIndexStatement

Create a new CREATE INDEX statement

pub fn take(&mut self) -> CreateIndexStatement

Take the ownership of data in the current CreateIndexStatement

pub fn name<T>(&mut self, name: T) -> &mut CreateIndexStatement

where T: IntoIden,

Set the index name

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_email");

pub fn table<T>(&mut self, tbl: T) -> &mut CreateIndexStatement

where T: IntoTableRef,

Set the table

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_email")
    .table("users");

pub fn col<C>(&mut self, column: C) -> &mut CreateIndexStatement

where C: IntoIden,

Add a column to the index

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_name_email")
    .table("users")
    .col("name")
    .col("email");

pub fn col_order<C>( &mut self, column: C, order: Order, ) -> &mut CreateIndexStatement

where C: IntoIden,

Add a column with sort order

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::types::Order;

let query = Query::create_index()
    .name("idx_created_at")
    .table("posts")
    .col_order("created_at", Order::Desc);

pub fn cols<I, C>(&mut self, columns: I) -> &mut CreateIndexStatement

where I: IntoIterator<Item = C>, C: IntoIden,

Add multiple columns to the index

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_name_email")
    .table("users")
    .cols(vec!["name", "email"]);

pub fn unique(&mut self) -> &mut CreateIndexStatement

Set UNIQUE attribute

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_email")
    .table("users")
    .col("email")
    .unique();

pub fn if_not_exists(&mut self) -> &mut CreateIndexStatement

Add IF NOT EXISTS clause

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_email")
    .table("users")
    .col("email")
    .if_not_exists();

pub fn where(&mut self, condition: SimpleExpr) -> &mut CreateIndexStatement

Add WHERE clause for partial index

Partial indexes are supported by PostgreSQL and SQLite.

Examples

use reinhardt_query::prelude::*;

let query = Query::create_index()
    .name("idx_active_users")
    .table("users")
    .col("email")
    .r#where(Expr::col("active").eq(true));

pub fn using(&mut self, method: IndexMethod) -> &mut CreateIndexStatement

Set index method using USING clause

Examples

use reinhardt_query::prelude::*;
use reinhardt_query::query::IndexMethod;

let query = Query::create_index()
    .name("idx_email")
    .table("users")
    .col("email")
    .using(IndexMethod::Hash);

Trait Implementations

impl Clone for CreateIndexStatement

fn clone(&self) -> CreateIndexStatement

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateIndexStatement

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for CreateIndexStatement

fn default() -> CreateIndexStatement

Returns the “default value” for a type.

impl QueryStatementBuilder for CreateIndexStatement

fn build_any( &self, query_builder: &(dyn QueryBuilderTrait + 'static), ) -> (String, Values)

Build SQL statement for a database backend and collect query parameters

fn to_string<T>(&self, query_builder: T) -> String

where T: QueryBuilderTrait,

Build SQL statement for a database backend and return SQL string with values inlined as SQL literals.

fn build<T>(&self, query_builder: T) -> (String, Values)

where T: QueryBuilderTrait,

Build SQL statement with parameter collection

impl QueryStatementWriter for CreateIndexStatement