1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
use super::common::*;
use crate::{backend::SchemaBuilder, prepare::*, types::*, SchemaStatementBuilder};
/// 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`)"#
/// );
/// ```
/// 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 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)"#
/// );
/// ```
#[derive(Debug, Clone)]
pub struct IndexCreateStatement {
pub(crate) table: Option<DynIden>,
pub(crate) index: TableIndex,
pub(crate) primary: bool,
pub(crate) unique: bool,
pub(crate) index_type: Option<IndexType>,
}
/// Specification of a table index
#[derive(Debug, Clone)]
pub enum IndexType {
BTree,
FullText,
Hash,
Custom(DynIden),
}
impl Default for IndexCreateStatement {
fn default() -> Self {
Self::new()
}
}
impl IndexCreateStatement {
/// Construct a new [`IndexCreateStatement`]
pub fn new() -> Self {
Self {
table: None,
index: Default::default(),
primary: false,
unique: false,
index_type: None,
}
}
/// Set index name
pub fn name(&mut self, name: &str) -> &mut Self {
self.index.name(name);
self
}
/// Set target table
pub fn table<T: 'static>(&mut self, table: T) -> &mut Self
where
T: Iden,
{
self.table = Some(SeaRc::new(table));
self
}
/// Add index column
pub fn col<C: 'static>(&mut self, col: C) -> &mut Self
where
C: IntoIndexColumn,
{
self.index.col(col.into_index_column());
self
}
/// Set index as primary
pub fn primary(&mut self) -> &mut Self {
self.primary = true;
self
}
/// Set index as unique
pub fn unique(&mut self) -> &mut Self {
self.unique = true;
self
}
/// Set index as full text.
/// On MySQL, this is `FULLTEXT`.
/// On PgSQL, this is `GIN`.
pub fn full_text(&mut self) -> &mut Self {
self.index_type(IndexType::FullText)
}
/// Set index type. Not available on Sqlite.
pub fn index_type(&mut self, index_type: IndexType) -> &mut Self {
self.index_type = Some(index_type);
self
}
pub fn is_primary_key(&self) -> bool {
self.primary
}
pub fn get_index_spec(&self) -> &TableIndex {
&self.index
}
pub fn take(&mut self) -> Self {
Self {
table: self.table.take(),
index: self.index.take(),
primary: self.primary,
unique: self.unique,
index_type: self.index_type.take(),
}
}
}
impl SchemaStatementBuilder for IndexCreateStatement {
fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String {
let mut sql = SqlWriter::new();
schema_builder.prepare_index_create_statement(self, &mut sql);
sql.result()
}
fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String {
let mut sql = SqlWriter::new();
schema_builder.prepare_index_create_statement(self, &mut sql);
sql.result()
}
}