Documentation
¶
Index ¶
- Constants
- func GenerateAddOnQuery(ctx context.Context, reqData *TableRequest) (string, []interface{}, error)
- type BaseColumn
- type CUDConstructData
- type CUDResponse
- type Follower
- type Master
- type QueryOpts
- type ResponseMetaData
- type SQL
- type SQLConfig
- type SQLs
- type SelectResponse
- type TableRequest
- type TimeCol
- type Transaction
- type Transactions
Constants ¶
View Source
const ( MySQLEngine = "mysql" PostgresEngine = "postgres" )
Variables ¶
This section is empty.
Functions ¶
func GenerateAddOnQuery ¶ added in v0.5.19
func GenerateAddOnQuery(ctx context.Context, reqData *TableRequest) (string, []interface{}, error)
Types ¶
type BaseColumn ¶
type CUDConstructData ¶
type CUDConstructData struct {
Cols []string `json:"cols"`
Values []interface{} `json:"values"`
ColsInsert string
BulkValues string
BulkQuery string
Action string
TableName string
}
func (*CUDConstructData) SetValues ¶ added in v0.0.3
func (req *CUDConstructData) SetValues(value interface{})
type CUDResponse ¶
type CUDResponse struct {
Status bool `json:"status"`
RowsAffected int64 `json:"rows_affected"`
LastInsertID int64 `json:"last_insert_id"`
// contains filtered or unexported fields
}
func (*CUDResponse) GetGeneratedQuery ¶ added in v1.5.9
func (e *CUDResponse) GetGeneratedQuery() map[string][]interface{}
GetGeneratedQuery - return query + params with format map[<query>]<params>
type Follower ¶
type Follower interface {
// Get from follower database
Get(dest interface{}, query string, args ...interface{}) error
// Select from follower database
Select(dest interface{}, query string, args ...interface{}) error
// Query from follower database
Query(query string, args ...interface{}) (*sql.Rows, error)
// QueryRow executes QueryRow against follower DB
QueryRow(query string, args ...interface{}) *sql.Row
// QueryRowContext from sql database
QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
// NamedQuery do named query on follower DB
NamedQuery(query string, arg interface{}) (*sqlx.Rows, error)
// GetContext from sql database
GetContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
// SelectContext from sql database
SelectContext(ctx context.Context, dest interface{}, query string, args ...interface{}) error
// QueryContext from sql database
QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
// QueryxContext queries the database and returns an *sqlx.Rows. Any placeholder parameters are replaced with supplied args.
QueryxContext(ctx context.Context, query string, args ...interface{}) (*sqlx.Rows, error)
// QueryRowxContext queries the database and returns an *sqlx.Row. Any placeholder parameters are replaced with supplied args.
QueryRowxContext(ctx context.Context, query string, args ...interface{}) *sqlx.Row
// NamedQueryContext do named query on follower DB
NamedQueryContext(ctx context.Context, query string, arg interface{}) (*sqlx.Rows, error)
}
Follower defines operation that will be executed to follower DB
type Master ¶
type Master interface {
Exec(query string, args ...interface{}) (sql.Result, error)
// ExecContext use master database to exec query
ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
// Begin transaction on master DB
Begin() (*sql.Tx, error)
// BeginTx begins transaction on master DB
BeginTx(ctx context.Context, opts *sql.TxOptions) (*sql.Tx, error)
// Rebind a query from the default bindtype (QUESTION) to the target bindtype.
Rebind(sql string) string
// NamedExec do named exec on master DB
NamedExec(query string, arg interface{}) (sql.Result, error)
// NamedExecContext do named exec on master DB
NamedExecContext(ctx context.Context, query string, arg interface{}) (sql.Result, error)
// BindNamed do BindNamed on master DB
BindNamed(query string, arg interface{}) (string, []interface{}, error)
// QueryRow executes QueryRow against follower DB
QueryRow(query string, args ...interface{}) *sql.Row
// QueryRowContext from sql database
QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
}
type QueryOpts ¶
type QueryOpts struct {
BaseQuery string
QueryDescription string
Conditions func(ctx context.Context)
ExcludeColumns string
Columns string
OptionalTableName string // for view name
SelectRequest *TableRequest
CUDRequest *CUDConstructData
Result interface{}
IsList bool
Trx *sql.Tx
// contains filtered or unexported fields
}
func (*QueryOpts) GetGeneratedQuery ¶ added in v1.5.9
func (e *QueryOpts) GetGeneratedQuery() map[string][]interface{}
GetGeneratedQuery - return query + params with format map[<query>]<params>
type ResponseMetaData ¶ added in v1.9.1
type SQLConfig ¶
type SQLConfig struct {
Username string `yaml:"username"`
Password string `yaml:"password"`
Host string `yaml:"host"`
Port string `yaml:"port"`
Engine string `yaml:"engine"`
DBName string `yaml:"db_name"`
Timeout int `yaml:"timeout"`
MaxConnLifetime int `yaml:"max_conn_lifetime"`
MaxIdleTime int `yaml:"max_idle_time"`
MaxOpenConn int `yaml:"max_open_conn"`
MaxIdleConn int `yaml:"max_idle_conn"`
ConnString string `yaml:"conn_string"`
}
type SelectResponse ¶
type SelectResponse struct {
Data interface{} `json:"data"`
*ResponseMetaData
}
type TableRequest ¶
type TableRequest struct {
Keyword string `json:"keyword,omitempty" schema:"keyword"`
SearchColsStr string `json:"search_cols,omitempty" schema:"search_cols"`
SearchCols []string `json:"-"`
Page int `json:"page,omitempty" schema:"page"`
Limit int `json:"limit,omitempty" schema:"limit"`
OrderBy string `json:"order_by,omitempty" schema:"order_by"`
GroupBy string `json:"group_by,omitempty,omitempty" schema:"group_by"`
CreatedStart string `json:"date_start,omitempty" schema:"date_start"`
CreatedEnd string `json:"date_end,omitempty" schema:"date_end"`
InitiateWhere []string `json:"-"` // will be defined manually at each of usecase services
InitiateWhereValues []interface{} `json:"-"` // will be defined manually at each of usecase services
IncludeDeleted bool `json:"-"`
NotContainsDeletedCol bool `json:"-"`
MainTableAlias string `json:"-"`
IsDeleted string `json:"is_deleted,omitempty" schema:"is_deleted"`
}
func (*TableRequest) SetWhereCondition ¶ added in v0.0.3
func (req *TableRequest) SetWhereCondition(condition string, value ...interface{})
type Transaction ¶ added in v0.0.4
type Transaction struct {
// contains filtered or unexported fields
}
func NewTransaction ¶ added in v0.0.4
func NewTransaction(db *sqlx.DB) *Transaction
Click to show internal directories.
Click to hide internal directories.