datasource

type Database struct {
	Name        string
	Description string

	Engine *Engine

	Tables     []*Table
	Views      []*View
	Procedures []*Function
	Roles      []*Role

	Properties struct {
		CharacterSet string
		Collation    string
		Locale       string

		ConnectionLimit int
		Owner           string

		DefaultStorageEngine string
		DefaultSchema        string
		DefaultNamespace     string

		SecurityModel                 string
		RecoveryModel, BackupStrategy string
	}
}

type Databases []*Database

type Engine struct {
	Name             string
	BuiltinFunctions []*Function

	Properties struct {
		Version string

		TransactionSupport   []string
		ConcurrencyControl   string
		RecoveryModel        string
		StorageModel         string
		IntegrityEnforcement string

		ReplicationCapabilities []string
		IndexingCapabilities    []string
		Caching                 []string
	}
}

type Engines []*Engine

type Field struct {
	Name        string
	Description string

	Properties struct {
		PrimaryKey bool

		Type      string
		Length    *int
		Precision *int
		Scale     *int

		Default   *string
		AutoInc   *string // Auto increment seed, nil if AutoIncrement false
		Virtual   bool
		Generated *string

		Unique        bool
		Index         bool
		Nullable      bool
		AllowedValues []string // name? for enum or set (MySQL)
		Encrypted     bool
		Overrides     struct {
			CharacterSet string
			Collation    string
		}
	}
}

type Fields []*Field

type Function struct {
	Name        string
	Description string

	Properties struct {
		Definition string
		Type       string
		Returns    *string
		Parameters []struct {
			Name        string
			Description string
			Type        string
			Direction   string // IN, OUT, INOUT
		}
	}
}

type Functions []*Function

type Namer interface {
	GetName() string
}

type Role struct {
	Name        string
	Description string

	Permissions []string
	Inheritance []string
	Members     []string
}

type Roles []*Role

type Server struct {
	Name string

	Engine    *Engine
	Databases Databases

	MaxConnections int
	Timeout        int
	SecurityModel  string
}

type Servers []*Server

type Table struct {
	Name        string
	Description string

	Engine *Engine

	Fields []*Field

	Properties struct {
		PrimaryKeys []string

		Indexes []struct {
			Name        string
			Description string

			Fields    []string
			Type      string // B-tree, Hash, etc.
			Unique    bool
			Clustered bool
			Spatial   bool
		}
		ForeignKeys []struct {
			Name  string
			Field *Field

			ToTable string
			ToField string

			OnUpdate string
			OnDelete string
		}

		Partitioned bool
	}
}

type Tables []*Table

type View struct {
	Name        string
	Description string

	Fields []*Field

	Properties struct {
		Definition   string
		Updatable    bool
		WithCheck    bool
		Materialized bool
	}
}

type Views []*View