database

Documentation

Index

• func SanitizeValue(value string) string
• type ColumnResult
• type Connector
• type ConnectorFactory
  • func NewConnectorFactory() ConnectorFactory
• type ConstraintResult
• type ConstraintResultList
  • func (source ConstraintResultList) AppendIfNotExists(items ...ConstraintResult) ConstraintResultList
• type DbType
  • func (c DbType) String() string
• type Result
• type TableDetail
  • func ParseTableName(value string, selectedSchemas []string) (TableDetail, error)
• type TableResult

Functions

func SanitizeValue

func SanitizeValue(value string) string

Types

type ColumnResult

type ColumnResult struct {
	Name       string
	DataType   string
	IsPrimary  bool
	IsForeign  bool
	IsUnique   bool
	IsNullable bool
	EnumValues string
	Comment    string
}

type Connector

type Connector interface {
	Connect() error
	Close()
	GetDbType() DbType
	GetSchemas() ([]string, error)
	GetTables(schemaNames []string) ([]TableDetail, error)
	GetColumns(tableName TableDetail) ([]ColumnResult, error)
	GetConstraints(tableName TableDetail) ([]ConstraintResult, error)
}

type ConnectorFactory

type ConnectorFactory interface {
	NewConnector(connectionString string) (Connector, error)
}

func NewConnectorFactory

func NewConnectorFactory() ConnectorFactory

type ConstraintResult

type ConstraintResult struct {
	FkTable        string
	FkSchema       string
	PkTable        string
	PkSchema       string
	ConstraintName string
	ColumnName     string
	IsPrimary      bool
	HasMultiplePK  bool
}

type ConstraintResultList

type ConstraintResultList []ConstraintResult

func (ConstraintResultList) AppendIfNotExists

func (source ConstraintResultList) AppendIfNotExists(items ...ConstraintResult) ConstraintResultList

AppendIfNotExists ensures that only unique items are appended to the list of constraints

type DbType

type DbType string

const (
	Postgres DbType = "pgx"
	MySql    DbType = "mysql"
	MsSql    DbType = "sqlserver"
	Sqlite3  DbType = "sqlite"
)

func (DbType) String

func (c DbType) String() string

type Result

type Result struct {
	Tables []TableResult
}

type TableDetail

type TableDetail struct {
	Schema string
	Name   string
}

func ParseTableName

func ParseTableName(value string, selectedSchemas []string) (TableDetail, error)

type TableResult

type TableResult struct {
	Table       TableDetail
	Columns     []ColumnResult
	Constraints ConstraintResultList
}