db

type Column struct {
	Name         string      // the original name of the column in the DB
	Type         string      // the original type of the column in the DB
	Nullable     bool        // true if the column is not NON-NULL
	HasDefault   bool        // true if the column has a default
	IsPrimaryKey bool        // true if the column is a primary key
	Ordinal      int16       // the column's ordinal position
	Comment      string      // the comment attached to the column
	Table        *Table      `json:"-"`
	ForeignKey   *ForeignKey // foreign key database definition
}

type Columns []*Column

type DB map[string]*Schema

type Enum struct {
	ID      int64
	Name    string             // the original name of the enum in the DB
	Values  stringlist.Strings // the list of possible values for this enum
	Comment string
	Schema  *Schema `json:"-"`
}

type Enums []*Enum

type ForeignKey struct {
	Name           string  // the original name of the foreign key constraint in the db
	Comment        string  // the comment attached to the ForeignKey
	Columns        Columns `json:"-"` // Schema and Table can be retrieved from the source Column
	ForeignColumns Columns `json:"-"` //
}

type ForeignKeys []*ForeignKey

type Index struct {
	Name      string  // name of the index in the database
	IsUnique  bool    // true if the index is unique
	IsPrimary bool    // true if the index is for the PK
	Comment   string  // the comment attached to the index
	Columns   Columns `json:"-"` // list of columns in this index
}

type Indexes []*Index

type Param struct {
	Ordinal       int
	Name          string
	Type          string
	SQLType       string
	QueryPosition int
}

type Params []*Param

type Schema struct {
	Name   string
	Tables Tables
	Enums  Enums
}

type Table struct {
	ID          int64
	Name        string      // the original name of the table in the DB
	Type        string      // the table type (e.g. VIEW or BASE TABLE)
	Comment     string      // the comment attached to the table
	Schema      *Schema     // reference to schema `json:"-"`
	Columns     Columns     // ordered list of columns in this table
	ReadOnly    bool        // table allows insert/update/delete
	Indexes     Indexes     // list of indexes in this table
	ForeignKeys ForeignKeys // list of Foreign Keys from the table
	References  ForeignKeys // list of Foreign Keys to the table

	PrimaryKeys Columns // list of columns that are flagged as Primary Keys
}

type Tables []*Table