stch.sql.ddl documentation

SQL DSL for data definition language (DDL).
Supports a majority of MySQL's statements for
tables and databases.

->AddColumnSpec

(->AddColumnSpec col-spec col-position)
Positional factory function for class stch.sql.ddl.AddColumnSpec.
Source

->AddIndexSpec

(->AddIndexSpec index-spec)
Positional factory function for class stch.sql.ddl.AddIndexSpec.
Source

->ChangeSpec

(->ChangeSpec col col-spec)
Positional factory function for class stch.sql.ddl.ChangeSpec.
Source

->ColumnPosition

(->ColumnPosition preposition col)
Positional factory function for class stch.sql.ddl.ColumnPosition.
Source

->ColumnSpec

(->ColumnSpec col-name col-type options)
Positional factory function for class stch.sql.ddl.ColumnSpec.
Source

->Columns

(->Columns columns+keys)
Positional factory function for class stch.sql.ddl.Columns.
Source

->ConstraintSpec

(->ConstraintSpec key-name key-spec)
Positional factory function for class stch.sql.ddl.ConstraintSpec.
Source

->DBSpec

(->DBSpec db-name)
Positional factory function for class stch.sql.ddl.DBSpec.
Source

->DefaultValueSpec

(->DefaultValueSpec x)
Positional factory function for class stch.sql.ddl.DefaultValueSpec.
Source

->DropColumnSpec

(->DropColumnSpec col)
Positional factory function for class stch.sql.ddl.DropColumnSpec.
Source

->DropDefaultSpec

(->DropDefaultSpec col)
Positional factory function for class stch.sql.ddl.DropDefaultSpec.
Source

->DropForeignKeySpec

(->DropForeignKeySpec fk)
Positional factory function for class stch.sql.ddl.DropForeignKeySpec.
Source

->DropIndexSpec

(->DropIndexSpec index)
Positional factory function for class stch.sql.ddl.DropIndexSpec.
Source

->DropPrimaryKeySpec

(->DropPrimaryKeySpec)
Positional factory function for class stch.sql.ddl.DropPrimaryKeySpec.
Source

->ForeignKeySpec

(->ForeignKeySpec field references options)
Positional factory function for class stch.sql.ddl.ForeignKeySpec.
Source

->IndexSpec

(->IndexSpec index-type index-cols)
Positional factory function for class stch.sql.ddl.IndexSpec.
Source

->RenameSpec

(->RenameSpec table)
Positional factory function for class stch.sql.ddl.RenameSpec.
Source

->SetDefaultSpec

(->SetDefaultSpec col default)
Positional factory function for class stch.sql.ddl.SetDefaultSpec.
Source

->TableOption

(->TableOption option-name option-value)
Positional factory function for class stch.sql.ddl.TableOption.
Source

->TableSpec

(->TableSpec table-name temporary columns+keys)
Positional factory function for class stch.sql.ddl.TableSpec.
Source

-add

(-add spec m)(-add spec m options)
Source
AlterAdd
Source
ColumnOptions
Column options type definition.

Source
ColumnOrIndex
Column or index type definition.

Source
Index
Index type definition.

Source
KeywordOrSym
Keyword or symbol type definition.

Source
NamedOrColumn
Named or column spec type definition.

Source
NamedOrConstraint
Source
NamedOrDB
Named or DB spec type definition.

Source
NamedOrTable
Named or table spec type definition.

Source
TableOrDB
Table spec or DB spec type definition.

Source
ToSQL
Convert an object to SQL.

Source
WhatsMyName
Source
add
(add m spec)(add m spec options)
Inputs: [m :- TableSpec spec] [m :- TableSpec spec options]
Returns: TableSpec

Add column/index. Use with alt.
Source
after
(after col)
Inputs: [col :- NamedOrColumn]
Returns: ColumnPosition

Set column position. Use with add.
Source
alt
(alt spec)
Inputs: [spec :- TableSpec]
Returns: String

Alter a table.
Source
alt-db
(alt-db db option)
Inputs: [db :- NamedOrDB, option :- TableOption]
Returns: String

Alter a database.
Source
append
(append m x)
Inputs: [m :- TableSpec, x :- (U Columns ColumnSpec Index)]
Returns: TableSpec

Append a set of columns/indexes or single
column/index to a table.
Source
auto-inc
(auto-inc start)
Inputs: [start :- Int]
Returns: TableOption

Set the auto-increment table option.
Source
big-int
(big-int & [arg0__2221__auto__ & args__2222__auto__])
Source
binary
(binary & [arg0__2221__auto__ & args__2222__auto__])
Source
blob
(blob & [arg0__2221__auto__ & args__2222__auto__])
Source
bool
(bool & [arg0__2221__auto__ & args__2222__auto__])
Source
change
(change m col col-spec)
Inputs: [m :- TableSpec, col :- NamedOrColumn, col-spec :- ColumnSpec]
Returns: TableSpec

Change column. Use with alt.
Source
char'
Source
character-set
(character-set charset)
Inputs: [charset :- Named]
Returns: TableOption

Set the character set table option.
Source
chr
(chr & [arg0__2221__auto__ & args__2222__auto__])
Source
collate
(collate collation)
Inputs: [collation :- Named]
Returns: TableOption

Set the collate table option.
Source
column
(column col-name col-type options)
Inputs: [col-name col-type options]
Returns: ColumnSpec
Source
column?
(column? x)
Inputs: [x :- Any]
Returns: Boolean
Source
columns
(columns)
Inputs: []
Returns: Columns
Source
columns?
(columns? x)
Inputs: [x :- Any]
Returns: Boolean
Source
constraint
(constraint & [arg0 & args])
Define a named constraint. Use with an index fn.

Source
create
(create spec & options)
Inputs: [spec :- TableOrDB & options :- [TableOption]]
Returns: String

Create a table or database with options.
Source
date
(date & [arg0__2221__auto__ & args__2222__auto__])
Source
datetime
(datetime & [arg0__2221__auto__ & args__2222__auto__])
Source
db
(db db-name)
Inputs: [db-name :- Named]
Returns: DBSpec

Create a database.
Source
db?
(db? x)
Inputs: [x :- Any]
Returns: Boolean
Source
decimal
(decimal & [arg0__2221__auto__ & args__2222__auto__])
Source
default
(default x)
Inputs: [x :- (U Number String)]
Returns: DefaultValueSpec

Set the default value for a column.
Use with a column fn.
Source
defcolumns
macro
(defcolumns name & columns+keys)
Define one or more columns.

Source
defindexfn
macro
(defindexfn fn-name index-type)
Define an index fn.

Source
deftable
macro
(deftable table-name & columns+keys)
Source
deftypefn
macro
(deftypefn fn-name col-type)
Define a type fn (e.g., int, varchar).

Source
double'
(double' & [arg0__2221__auto__ & args__2222__auto__])
Source
drop-column
(drop-column m col)
Inputs: [m :- TableSpec, col :- NamedOrColumn]
Returns: TableSpec

Drop a column. Use with alt.
Source
drop-db
(drop-db db)
Inputs: [db :- NamedOrDB]
Returns: String

Drop a database.
Source
drop-default
(drop-default m col)
Inputs: [m :- TableSpec, col :- NamedOrColumn]
Returns: TableSpec

Drop column default. Use with alt.
Source
drop-foreign-key
(drop-foreign-key m fk)
Inputs: [m :- TableSpec, fk :- NamedOrConstraint]
Returns: TableSpec

Drop a foreign key. Use with alt.
Source
drop-index
(drop-index m index)
Inputs: [m :- TableSpec, index :- NamedOrConstraint]
Returns: TableSpec

Drop an index. Use with alt.
Source
drop-primary-key
(drop-primary-key m)
Inputs: [m :- TableSpec]
Returns: TableSpec

Drop a primary key. Use with alt.
Source
drop-table
(drop-table & tables)
Inputs: [& tables :- [NamedOrTable]]
Returns: String

Drop one or more tables.
Source
drop-temp-table
(drop-temp-table & tables)
Inputs: [& tables :- [NamedOrTable]]
Returns: String

Drop one or more tables.
Source
engine
(engine eng)
Inputs: [eng :- Named]
Returns: TableOption

Set the engine table option.
Source
enum
(enum & [arg0__2221__auto__ & args__2222__auto__])
Source
float'
(float' & [arg0__2221__auto__ & args__2222__auto__])
Source
foreign-key
(foreign-key & [arg0 & args])
Define a foreign key. Use with create or alt.

Source
fulltext
(fulltext & [arg0__2450__auto__ & args__2451__auto__])
Source
geometry
(geometry & [arg0__2221__auto__ & args__2222__auto__])
Source
idx
(idx index-type index-cols)
Inputs: [index-type index-cols]
Returns: IndexSpec
Source
index
(index & [arg0__2450__auto__ & args__2451__auto__])
Source
index?
(index? x)
Inputs: [x :- Any]
Returns: Boolean
Source
integer
(integer & [arg0__2221__auto__ & args__2222__auto__])
Source
linestring
(linestring & [arg0__2221__auto__ & args__2222__auto__])
Source
map->AddColumnSpec
(map->AddColumnSpec m2155)
Factory function for class AddColumnSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->AddIndexSpec
(map->AddIndexSpec m2951)
Factory function for class AddIndexSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->ChangeSpec
(map->ChangeSpec m2992)
Factory function for class ChangeSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->ColumnPosition
(map->ColumnPosition m2091)
Factory function for class ColumnPosition, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->ColumnSpec
(map->ColumnSpec m2020)
Factory function for class ColumnSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->Columns
(map->Columns m2762)
Factory function for class Columns, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->ConstraintSpec
(map->ConstraintSpec m2553)
Factory function for class ConstraintSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DBSpec
(map->DBSpec m1890)
Factory function for class DBSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DefaultValueSpec
(map->DefaultValueSpec m1963)
Factory function for class DefaultValueSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DropColumnSpec
(map->DropColumnSpec m3182)
Factory function for class DropColumnSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DropDefaultSpec
(map->DropDefaultSpec m3124)
Factory function for class DropDefaultSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DropForeignKeySpec
(map->DropForeignKeySpec m3348)
Factory function for class DropForeignKeySpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DropIndexSpec
(map->DropIndexSpec m3240)
Factory function for class DropIndexSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->DropPrimaryKeySpec
(map->DropPrimaryKeySpec m3298)
Factory function for class DropPrimaryKeySpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->ForeignKeySpec
(map->ForeignKeySpec m2493)
Factory function for class ForeignKeySpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->IndexSpec
(map->IndexSpec m2385)
Factory function for class IndexSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->RenameSpec
(map->RenameSpec m3406)
Factory function for class RenameSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->SetDefaultSpec
(map->SetDefaultSpec m3058)
Factory function for class SetDefaultSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->TableOption
(map->TableOption m2839)
Factory function for class TableOption, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
map->TableSpec
(map->TableSpec m2624)
Factory function for class TableSpec, taking a map of keywords to field values, but not 400x slower than ->x like the clojure.core version

Source
medium-int
(medium-int & [arg0__2221__auto__ & args__2222__auto__])
Source
point
(point & [arg0__2221__auto__ & args__2222__auto__])
Source
polygon
(polygon & [arg0__2221__auto__ & args__2222__auto__])
Source
primary-key
(primary-key & [arg0__2450__auto__ & args__2451__auto__])
Source
rename
(rename m table)
Inputs: [m :- TableSpec, table :- NamedOrTable]
Returns: TableSpec

Rename a table. Use with alt.
Source
rename-db
(rename-db old-db new-db)
Inputs: [old-db :- NamedOrDB, new-db :- NamedOrDB]
Returns: String

Rename a database.
Source
set'
(set' & [arg0__2221__auto__ & args__2222__auto__])
Source
set-default
(set-default m col default)
Inputs: [m :- TableSpec, col :- NamedOrColumn, default :- (U String Number)]
Returns: TableSpec

Set column default. Use with alt.
Source
small-int
(small-int & [arg0__2221__auto__ & args__2222__auto__])
Source
spatial
(spatial & [arg0__2450__auto__ & args__2451__auto__])
Source
strict-map->AddColumnSpec
(strict-map->AddColumnSpec m2156 & [drop-extra-keys?__894__auto__])
Factory function for class AddColumnSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->AddIndexSpec
(strict-map->AddIndexSpec m2952 & [drop-extra-keys?__894__auto__])
Factory function for class AddIndexSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->ChangeSpec
(strict-map->ChangeSpec m2993 & [drop-extra-keys?__894__auto__])
Factory function for class ChangeSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->ColumnPosition
(strict-map->ColumnPosition m2092 & [drop-extra-keys?__894__auto__])
Factory function for class ColumnPosition, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->ColumnSpec
(strict-map->ColumnSpec m2021 & [drop-extra-keys?__894__auto__])
Factory function for class ColumnSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->Columns
(strict-map->Columns m2763 & [drop-extra-keys?__894__auto__])
Factory function for class Columns, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->ConstraintSpec
(strict-map->ConstraintSpec m2554 & [drop-extra-keys?__894__auto__])
Factory function for class ConstraintSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DBSpec
(strict-map->DBSpec m1891 & [drop-extra-keys?__894__auto__])
Factory function for class DBSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DefaultValueSpec
(strict-map->DefaultValueSpec m1964 & [drop-extra-keys?__894__auto__])
Factory function for class DefaultValueSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DropColumnSpec
(strict-map->DropColumnSpec m3183 & [drop-extra-keys?__894__auto__])
Factory function for class DropColumnSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DropDefaultSpec
(strict-map->DropDefaultSpec m3125 & [drop-extra-keys?__894__auto__])
Factory function for class DropDefaultSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DropForeignKeySpec
(strict-map->DropForeignKeySpec m3349 & [drop-extra-keys?__894__auto__])
Factory function for class DropForeignKeySpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DropIndexSpec
(strict-map->DropIndexSpec m3241 & [drop-extra-keys?__894__auto__])
Factory function for class DropIndexSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->DropPrimaryKeySpec
(strict-map->DropPrimaryKeySpec m3299 & [drop-extra-keys?__894__auto__])
Factory function for class DropPrimaryKeySpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->ForeignKeySpec
(strict-map->ForeignKeySpec m2494 & [drop-extra-keys?__894__auto__])
Factory function for class ForeignKeySpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->IndexSpec
(strict-map->IndexSpec m2386 & [drop-extra-keys?__894__auto__])
Factory function for class IndexSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->RenameSpec
(strict-map->RenameSpec m3407 & [drop-extra-keys?__894__auto__])
Factory function for class RenameSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->SetDefaultSpec
(strict-map->SetDefaultSpec m3059 & [drop-extra-keys?__894__auto__])
Factory function for class SetDefaultSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->TableOption
(strict-map->TableOption m2840 & [drop-extra-keys?__894__auto__])
Factory function for class TableOption, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
strict-map->TableSpec
(strict-map->TableSpec m2625 & [drop-extra-keys?__894__auto__])
Factory function for class TableSpec, taking a map of keywords to field values.  All keys are required, and no extra keys are allowed.  Even faster than map->

Source
table
(table table-name)
Inputs: [table-name :- Named]
Returns: TableSpec
Source
table?
(table? x)
Inputs: [x :- Any]
Returns: Boolean
Source
temp-table
(temp-table table-name)
Inputs: [table-name :- Named]
Returns: TableSpec
Source
text
(text & [arg0__2221__auto__ & args__2222__auto__])
Source
time'
(time' & [arg0__2221__auto__ & args__2222__auto__])
Source
timestamp
(timestamp & [arg0__2221__auto__ & args__2222__auto__])
Source
tiny-int
(tiny-int & [arg0__2221__auto__ & args__2222__auto__])
Source
to-sql
(to-sql x)
Source
truncate
(truncate table)
Inputs: [table :- NamedOrTable]
Returns: String

Truncate a table.
Source
unique
(unique & [arg0__2450__auto__ & args__2451__auto__])
Source
varbinary
(varbinary & [arg0__2221__auto__ & args__2222__auto__])
Source
varchar
(varchar & [arg0__2221__auto__ & args__2222__auto__])
Source
whats-my-name
(whats-my-name x)
Source
year
(year & [arg0__2221__auto__ & args__2222__auto__])
Source