Golang Create Table PostgreSQL MySQL
API
To see the full list of supported methods, see CreateTableQuery.
db.NewCreateTable(). Model(&strct). Table("table1"). // quotes table names TableExpr("table1"). // arbitrary unsafe expression ModelTableExpr("table1"). // overrides model table name Temp(). IfNotExists(). Varchar(100). // turns VARCHAR into VARCHAR(100) WithForeignKeys(). ForeignKey(`(fkey) REFERENCES table1 (pkey) ON DELETE CASCADE`). PartitionBy("HASH (id)"). TableSpace("fasttablespace"). Exec(ctx)
Example
To create a table:
_, err := db.NewCreateTable(). Model((*Book)(nil)). ForeignKey(`("author_id") REFERENCES "users" ("id") ON DELETE CASCADE`). Exec(ctx) if err != nil { panic(err) }
ResetModel
Bun provides ResetModel
method to quickly drop and create tables:
err := db.ResetModel(ctx, (*Model1)(nil), (*Model2)(nil))
DROP TABLE IF EXISTS model1 CASCADE; CREATE TABLE model1 (...); DROP TABLE IF EXISTS model2 CASCADE; CREATE TABLE model2 (...);
Hooks
You can also modify query from the bun.BeforeCreateTableHook
hook.
var _ bun.BeforeCreateTableHook = (*Book)(nil) func (*Book) BeforeCreateTable(ctx context.Context, query *bun.CreateTableQuery) error { query.ForeignKey(`("author_id") REFERENCES "users" ("id") ON DELETE CASCADE`) return nil } if _, err := db.NewCreateTable().Model((*Book)(nil)).Exec(ctx); err != nil { panic(err) }
To create an index on the table, you can use bun.AfterCreateTableHook
hook:
var _ bun.AfterCreateTableHook = (*Book)(nil) func (*Book) AfterCreateTable(ctx context.Context, query *bun.CreateTableQuery) error { _, err := query.DB().NewCreateIndex(). Model((*Book)(nil)). Index("category_id_idx"). Column("category_id"). Exec(ctx) return err }
See example for details.