Struct sea_orm_migration::prelude::IndexCreateStatement
source · pub struct IndexCreateStatement { /* private fields */ }
Expand description
Create an index for an existing table
§Examples
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col(Glyph::Aspect)
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect`)"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect")"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect")"#
);
Create index if not exists
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.if_not_exists()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col(Glyph::Aspect)
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect`)"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE INDEX IF NOT EXISTS "idx-glyph-aspect" ON "glyph" ("aspect")"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE INDEX IF NOT EXISTS "idx-glyph-aspect" ON "glyph" ("aspect")"#
);
Index with prefix
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col((Glyph::Aspect, 128))
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect` (128))"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect" (128))"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect")"#
);
Index with order
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col((Glyph::Aspect, IndexOrder::Desc))
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect` DESC)"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect" DESC)"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect" DESC)"#
);
Index on multi-columns
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col((Glyph::Image, IndexOrder::Asc))
.col((Glyph::Aspect, IndexOrder::Desc))
.unique()
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE UNIQUE INDEX `idx-glyph-aspect` ON `glyph` (`image` ASC, `aspect` DESC)"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE UNIQUE INDEX "idx-glyph-aspect" ON "glyph" ("image" ASC, "aspect" DESC)"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE UNIQUE INDEX "idx-glyph-aspect" ON "glyph" ("image" ASC, "aspect" DESC)"#
);
Index with prefix and order
use sea_query::{tests_cfg::*, *};
let index = Index::create()
.name("idx-glyph-aspect")
.table(Glyph::Table)
.col((Glyph::Aspect, 64, IndexOrder::Asc))
.to_owned();
assert_eq!(
index.to_string(MysqlQueryBuilder),
r#"CREATE INDEX `idx-glyph-aspect` ON `glyph` (`aspect` (64) ASC)"#
);
assert_eq!(
index.to_string(PostgresQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect" (64) ASC)"#
);
assert_eq!(
index.to_string(SqliteQueryBuilder),
r#"CREATE INDEX "idx-glyph-aspect" ON "glyph" ("aspect" ASC)"#
);
Implementations§
source§impl IndexCreateStatement
impl IndexCreateStatement
sourcepub fn new() -> IndexCreateStatement
pub fn new() -> IndexCreateStatement
Construct a new IndexCreateStatement
sourcepub fn if_not_exists(&mut self) -> &mut IndexCreateStatement
pub fn if_not_exists(&mut self) -> &mut IndexCreateStatement
Create index if index not exists
sourcepub fn name<T>(&mut self, name: T) -> &mut IndexCreateStatement
pub fn name<T>(&mut self, name: T) -> &mut IndexCreateStatement
Set index name
sourcepub fn table<T>(&mut self, table: T) -> &mut IndexCreateStatementwhere
T: IntoTableRef,
pub fn table<T>(&mut self, table: T) -> &mut IndexCreateStatementwhere
T: IntoTableRef,
Set target table
sourcepub fn col<C>(&mut self, col: C) -> &mut IndexCreateStatementwhere
C: IntoIndexColumn,
pub fn col<C>(&mut self, col: C) -> &mut IndexCreateStatementwhere
C: IntoIndexColumn,
Add index column
sourcepub fn primary(&mut self) -> &mut IndexCreateStatement
pub fn primary(&mut self) -> &mut IndexCreateStatement
Set index as primary
sourcepub fn unique(&mut self) -> &mut IndexCreateStatement
pub fn unique(&mut self) -> &mut IndexCreateStatement
Set index as unique
sourcepub fn nulls_not_distinct(&mut self) -> &mut IndexCreateStatement
pub fn nulls_not_distinct(&mut self) -> &mut IndexCreateStatement
Set nulls to not be treated as distinct values. Only available on Postgres.
sourcepub fn full_text(&mut self) -> &mut IndexCreateStatement
pub fn full_text(&mut self) -> &mut IndexCreateStatement
Set index as full text.
On MySQL, this is FULLTEXT
.
On PgSQL, this is GIN
.
sourcepub fn index_type(&mut self, index_type: IndexType) -> &mut IndexCreateStatement
pub fn index_type(&mut self, index_type: IndexType) -> &mut IndexCreateStatement
Set index type. Not available on Sqlite.
pub fn is_primary_key(&self) -> bool
pub fn is_unique_key(&self) -> bool
pub fn is_nulls_not_distinct(&self) -> bool
pub fn get_index_spec(&self) -> &TableIndex
pub fn take(&mut self) -> IndexCreateStatement
source§impl IndexCreateStatement
impl IndexCreateStatement
sourcepub fn build<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
pub fn build<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
sourcepub fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String
pub fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String
sourcepub fn to_string<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
pub fn to_string<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
Trait Implementations§
source§impl Clone for IndexCreateStatement
impl Clone for IndexCreateStatement
source§fn clone(&self) -> IndexCreateStatement
fn clone(&self) -> IndexCreateStatement
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for IndexCreateStatement
impl Debug for IndexCreateStatement
source§impl Default for IndexCreateStatement
impl Default for IndexCreateStatement
source§fn default() -> IndexCreateStatement
fn default() -> IndexCreateStatement
Returns the “default value” for a type. Read more
source§impl SchemaStatementBuilder for IndexCreateStatement
impl SchemaStatementBuilder for IndexCreateStatement
source§fn build<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
fn build<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
Build corresponding SQL statement for certain database backend and return SQL string
source§fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String
fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String
Build corresponding SQL statement for certain database backend and return SQL string
source§fn to_string<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
fn to_string<T>(&self, schema_builder: T) -> Stringwhere
T: SchemaBuilder,
Build corresponding SQL statement for certain database backend and return SQL string
Auto Trait Implementations§
impl Freeze for IndexCreateStatement
impl !RefUnwindSafe for IndexCreateStatement
impl Send for IndexCreateStatement
impl Sync for IndexCreateStatement
impl Unpin for IndexCreateStatement
impl !UnwindSafe for IndexCreateStatement
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more