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

//! Builder API's module

use super::impls::Constraint;
use super::impls::{BaseType, ReferentialAction, WrapVec};
use crate::types::Type;

/// A standard primary numeric key type
///
/// It's 64-bit wide, can't be null or non-unique
/// and auto-increments on inserts.
/// Maps to `primary` on `Pg` and manually enforces
/// this behaviour for other Sql variants.
pub fn primary() -> Type {
    Type::new(BaseType::Primary)
        .nullable(true) // Primary keys are non-null implicitly
        .increments(true) // This is ignored for now
        .primary(false) // Primary keys are primary implictly
        .unique(false) // Primary keys are unique implicitly
        .indexed(false)
}

/// A (standardised) UUID primary key type
///
/// Similar to `primary()`, but uses a standard
/// layout UUID type, mapping to `uuid` on `Pg`
/// and not supported by all Sql variants.
pub fn uuid() -> Type {
    Type::new(BaseType::UUID)
        .nullable(false)
        .unique(true)
        .indexed(true)
}

/// Create a basic integer type
pub fn integer() -> Type {
    Type::new(BaseType::Integer)
}

/// Create an auto-incrementing integer type
pub fn serial() -> Type {
    Type::new(BaseType::Serial)
}

/// A 32-bit floating point type
pub fn float() -> Type {
    Type::new(BaseType::Float)
}

/// A 64-bit floating point type
pub fn double() -> Type {
    Type::new(BaseType::Double)
}

/// A boolean data type (true, false)
pub fn boolean() -> Type {
    Type::new(BaseType::Boolean)
}

/// A variable-length string type
pub fn varchar(len: usize) -> Type {
    Type::new(BaseType::Varchar(len))
}

/// A fixed-length string type
pub fn r#char(len: usize) -> Type {
    Type::new(BaseType::Char(len))
}

/// A variable-length string type
pub fn text() -> Type {
    Type::new(BaseType::Text)
}

/// A json-type column – not supported by all backends
pub fn json() -> Type {
    Type::new(BaseType::Json)
}

/// Embed binary data
pub fn binary<'inner>() -> Type {
    Type::new(BaseType::Binary)
}

/// Create a column that points to some foreign table
pub fn foreign<S, I>(
    table: S,
    keys: I,
    on_update: ReferentialAction,
    on_delete: ReferentialAction,
) -> Type
where
    S: Into<String>,
    I: Into<WrapVec<String>>,
{
    Type::new(BaseType::Foreign(
        None,
        table.into(),
        keys.into(),
        on_update,
        on_delete,
    ))
}

/// Like `foreign(...)` but letting you provide an external schema
///
/// This function is important when making cross-schema references
pub fn foreign_schema<S, I>(
    schema: S,
    table: S,
    keys: I,
    on_update: ReferentialAction,
    on_delete: ReferentialAction,
) -> Type
where
    S: Into<String>,
    I: Into<WrapVec<String>>,
{
    Type::new(BaseType::Foreign(
        Some(schema.into()),
        table.into(),
        keys.into(),
        on_update,
        on_delete,
    ))
}

/// Any custom SQL type that is embedded into a migration
pub fn custom(sql: &'static str) -> Type {
    Type::new(BaseType::Custom(sql))
}

/// An SQL date type
pub fn date() -> Type {
    Type::new(BaseType::Date)
}

/// An SQL time type
pub fn time() -> Type {
    Type::new(BaseType::Time)
}

/// An SQL datetime type
pub fn datetime() -> Type {
    Type::new(BaseType::DateTime)
}

/// Create an array of inner types
pub fn array(inner: &Type) -> Type {
    Type::new(BaseType::Array(Box::new(inner.get_inner())))
}

/// Create an index over multiple, existing columns of the same type
pub fn index<I, S>(columns: I) -> Type
where
    S: ToString,
    I: IntoIterator<Item = S>,
{
    let vec: Vec<String> = columns.into_iter().map(|s| s.to_string()).collect();
    Type::new(BaseType::Index(vec))
}

/// Create a constraint over multiple, existing columns of the same type
pub fn unique_constraint<I, S>(columns: I) -> Type
where
    S: ToString,
    I: IntoIterator<Item = S>,
{
    let vec: Vec<String> = columns.into_iter().map(|s| s.to_string()).collect();
    Type::new(BaseType::Constraint(Constraint::Unique, vec))
}