Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v1

v1.68.6

Mar 13, 2026

Changes in this version

type ExecResult

+ Pagination *Pagination

+ type Pagination struct

+ CurrentPage int

+ PageSize int

+ TotalItems int

+ TotalPages int

type SelectStmt

+ Page int

+ PageSize int

v1.68.5

Mar 13, 2026

v1.68.4

Mar 12, 2026

v1.68.3

Mar 12, 2026

v1.68.1

Mar 12, 2026

v1.68.0

Mar 12, 2026

v1.66.5

Mar 13, 2026

Changes in this version

+ var ErrSystemTableAccessDenied = fmt.Errorf("system table access denied: super_admin role required")

+ type AggFunc string

+ const AggAvg

+ const AggCount

+ const AggMax

+ const AggMin

+ const AggNone

+ const AggSum

+ type AlterTableStmt struct

+ Plan kernal.AlterTablePlan

+ Table string

+ func (s AlterTableStmt) TableName() string

+ func (s AlterTableStmt) Type() StatementType

+ type Backend string

+ const BackendDriver

+ const BackendKernal

+ type CreateTableStmt struct

+ Schema kernal.TableSchema

+ Table string

+ func (s CreateTableStmt) TableName() string

+ func (s CreateTableStmt) Type() StatementType

+ type DeleteStmt struct

+ Conditions []kernal.QueryCondition

+ Table string

+ func (s DeleteStmt) TableName() string

+ func (s DeleteStmt) Type() StatementType

+ type DropTableStmt struct

+ Table string

+ func (s DropTableStmt) TableName() string

+ func (s DropTableStmt) Type() StatementType

+ type Engine struct

+ Actor *driver.AuthenticatedUser

+ Backend Backend

+ Database string

+ func NewEngine(database string, backend Backend) *Engine

+ func (e *Engine) Close() error

+ func (e *Engine) Execute(sql string) (ExecResult, error)

+ func (e *Engine) ExecuteStatement(stmt Statement) (ExecResult, error)

+ func (e *Engine) Parse(sql string) (Statement, error)

+ func (e *Engine) WithActor(user *driver.AuthenticatedUser) *Engine

+ func (e *Engine) WithDBAttrs(attrs ...kernal.SchemaAttributer) *Engine

+ func (e *Engine) WithSharedCacheFrom(other *Engine) *Engine

+ type ExecResult struct

+ Affected int

+ Inserted kernal.Row

+ InsertedRows []kernal.Row

+ Rows []kernal.Row

+ Statement StatementType

+ Updated kernal.Row

+ UpdatedRows []kernal.Row

+ type InsertStmt struct

+ Row kernal.Row

+ Rows []kernal.Row

+ Table string

+ func (s InsertStmt) TableName() string

+ func (s InsertStmt) Type() StatementType

+ type JoinClause struct

+ LeftAlias string

+ RightAlias string

+ Table string

+ Type JoinType

+ type JoinType string

+ const JoinInner

+ const JoinLeft

+ type SelectField struct

+ Agg AggFunc

+ AggField string

+ Alias string

+ Field string

+ Star bool

+ type SelectStmt struct

+ Conditions []kernal.QueryCondition

+ Fields []SelectField

+ GroupBy []string

+ Joins []JoinClause

+ Limit int

+ Offset int

+ OrderBy string

+ OrderDesc bool

+ SubConds []SubqueryCondition

+ Table string

+ func (s SelectStmt) TableName() string

+ func (s SelectStmt) Type() StatementType

+ type Statement interface

+ TableName func() string

+ Type func() StatementType

+ func Parse(sql string) (Statement, error)

+ type StatementType string

+ const StmtAlterTable

+ const StmtCreateTable

+ const StmtDelete

+ const StmtDropTable

+ const StmtInsert

+ const StmtSelect

+ const StmtTruncate

+ const StmtUpdate

+ type SubqueryCondition struct

+ Field string

+ NotIn bool

+ SubStmt SelectStmt

+ type TruncateTableStmt struct

+ Table string

+ func (s TruncateTableStmt) TableName() string

+ func (s TruncateTableStmt) Type() StatementType

+ type UpdateStmt struct

+ PrimaryKey any

+ PrimaryKeys []any

+ Table string

+ Updates kernal.Row

+ func (s UpdateStmt) TableName() string

+ func (s UpdateStmt) Type() StatementType