types

Documentation

Index

• type Column
• type DbType
  • func (w DbType) Index() int
  • func (w DbType) String() string
• type ISQL
• type QueryResult
• type Table

Types

type Column

type Column struct {
	Name         string         `json:"name"`          // Name is the name of the column.
	Type         string         `json:"type"`          // Type is the data type of the column.
	IsNullable   string         `json:"is_nullable"`   // IsNullable indicates whether the column can have null values.
	Key          string         `json:"key"`           // Key is the key type of the column.
	DefaultValue sql.NullString `json:"default_value"` // DefaultValue is the default value of the column.
	Extra        string         `json:"extra"`         // Extra contains additional information about the column.
	Description  string         `json:"description"`   // Description is a description of the column.
	Metatags     []string       `json:"metatags"`      // Metatags contains the column name.
	Visibility   bool           `json:"visibility"`    // Visibility indicates whether the column is visible.
	IsIndex      bool           `json:"is_index"`      // IsIndex indicates whether the column is an index.
	IsPrimary    bool           `json:"is_primary"`    // IsPrimary indicates whether the column is a primary key.
}

Column represents a column in a database table.

type DbType

type DbType int

DbType represents a type of SQL database.

const (
	MySQL DbType = iota + 1
	Postgres
)

These constants represent the supported types of SQL databases.

func (DbType) Index

func (w DbType) Index() int

Index returns the integer representation of the DbType.

func (DbType) String

func (w DbType) String() string

String returns the string representation of the DbType.

type ISQL

type ISQL interface {
	Schema(string) (Table, error)
	Execute(string) ([]byte, error)
	Tables(string) ([]string, error)
}

ISQL is an interface that defines the methods that a SQL database must implement.

type QueryResult

type QueryResult struct {
	Columns []string        `json:"columns"` // Columns are the names of the columns in the result.
	Rows    [][]interface{} `json:"rows"`    // Rows are the rows in the result.
	Time    int64           `json:"time"`    // Time is the time it took to execute the query.
	Error   string          `json:"error"`   // Error is any error that occurred while executing the query.
}

QueryResult represents the result of a database query.

type Table

type Table struct {
	Name        string   `json:"name"`         // Name is the name of the table.
	Columns     []Column `json:"columns"`      // Columns are the columns in the table.
	ColumnCount int64    `json:"column_count"` // ColumnCount is the number of columns in the table.
	Description string   `json:"description"`  // Description is a description of the table.
	Metatags    []string `json:"metatags"`     // Metatags contains all column names.
}

Table represents a database table.