sea_query/index/mod.rs
1//! Index definition & alternations statements.
2//!
3//! # Usage
4//!
5//! - Table Index Create, see [`IndexCreateStatement`]
6//! - Table Index Drop, see [`IndexDropStatement`]
7
8mod common;
9mod create;
10mod drop;
11
12pub use common::*;
13pub use create::*;
14pub use drop::*;
15
16/// Shorthand for constructing any index statement
17#[derive(Debug, Clone)]
18pub struct Index;
19
20/// All available types of index statement
21#[derive(Debug, Clone)]
22pub enum IndexStatement {
23 Create(IndexCreateStatement),
24 Drop(IndexDropStatement),
25}
26
27impl Index {
28 /// Construct index [`IndexCreateStatement`]
29 pub fn create() -> IndexCreateStatement {
30 IndexCreateStatement::new()
31 }
32
33 /// Construct index [`IndexDropStatement`]
34 pub fn drop() -> IndexDropStatement {
35 IndexDropStatement::new()
36 }
37}