README
¶
GORM KingbaseES Driver
基于 KingbaseES 数据库官方 Go 驱动源码 二次开发整理的开箱即用的 GORM KingbaseES 数据库驱动， 无需单独复制驱动源码到项目中。
获取 KingbaseES 最新官方 Go 驱动请访问 https://www.kingbase.com.cn/download.html#drive。
最低要求
- go
1.25：https://go.dev/dl/ - gorm
v1.31.2：https://github.com/go-gorm/gorm - KES
V008R006C009B0014：https://www.kingbase.com.cn/download.html#database
快速上手
安装
go get github.com/godoes/gorm-kingbase
默认用例
import (
"github.com/godoes/gorm-kingbase"
"gorm.io/gorm"
)
// https://docs.kingbase.com.cn/cn/KES-V9R1C10/application/client_interface/GO/Gokb/go-2/
dsn := "host=localhost user=SYSTEM password=123456 dbname=TEST port=54321 sslmode=disable"
db, err := gorm.Open(kingbase.Open(dsn), &gorm.Config{})
配置用例
import (
"github.com/godoes/gorm-kingbase"
"gorm.io/gorm"
)
db, err := gorm.Open(kingbase.New(kingbase.Config{
// data source name, refer https://docs.kingbase.com.cn/cn/KES-V9R1C10/application/client_interface/GO/Gokb/go-2/
DSN: "host=localhost user=SYSTEM password=123456 dbname=TEST port=54321 sslmode=disable",
// disables implicit prepared statement usage. By default pgx automatically uses the extended protocol
PreferSimpleProtocol: true,
}), &gorm.Config{})
参考文档
KingbaseES 技术文档
- 产品简介：https://docs.kingbase.com.cn/cn/KES-V9R1C10/introduction
- 常见问题：https://docs.kingbase.com.cn/cn/KES-V9R1C10/question/
- GO 客户端编程接口 https://docs.kingbase.com.cn/cn/KES-V9R1C10/category/gokb
- 应用开发指南：https://docs.kingbase.com.cn/cn/KES-V9R1C10/application/application-develop-guide/
GORM 文档
- 文档首页：https://gorm.io/zh_CN/docs/
- 声明模型：https://gorm.io/zh_CN/docs/models.html
- 连接到数据库：https://gorm.io/zh_CN/docs/connecting_to_the_database.html
Documentation
¶
Index ¶
- Constants
- func BuildUrl(user, password, host string, port int, dbname string, ...) string
- func New(config Config) gorm.Dialector
- func Open(dsn string) gorm.Dialector
- type Config
- type Dialector
- func (dialector Dialector) Apply(config *gorm.Config) error
- func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})
- func (dialector Dialector) DataTypeOf(field *schema.Field) string
- func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression
- func (dialector Dialector) Explain(sql string, vars ...interface{}) string
- func (dialector Dialector) Initialize(db *gorm.DB) (err error)
- func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator
- func (dialector Dialector) Name() string
- func (dialector Dialector) QuoteTo(writer clause.Writer, str string)
- func (dialector Dialector) RollbackTo(tx *gorm.DB, name string) error
- func (dialector Dialector) SavePoint(tx *gorm.DB, name string) error
- func (dialector Dialector) Translate(err error) error
- type ErrMessage
- type Index
- type Migrator
- func (m Migrator) AddColumn(value interface{}, field string) error
- func (m Migrator) AlterColumn(value interface{}, field string) error
- func (m Migrator) BuildIndexOptions(opts []schema.IndexOption, stmt *gorm.Statement) (results []interface{})
- func (m Migrator) ColumnTypes(value interface{}) (columnTypes []gorm.ColumnType, err error)
- func (m Migrator) CreateIndex(value interface{}, name string) error
- func (m Migrator) CreateSequence(tx *gorm.DB, stmt *gorm.Statement, field *schema.Field, ...) (err error)
- func (m Migrator) CreateTable(values ...interface{}) (err error)
- func (m Migrator) CurrentDatabase() (name string)
- func (m Migrator) CurrentSchema(stmt *gorm.Statement, table string) (interface{}, interface{})
- func (m Migrator) DeleteSequence(tx *gorm.DB, stmt *gorm.Statement, field *schema.Field, fileType clause.Expr) (err error)
- func (m Migrator) DropColumn(dst interface{}, field string) error
- func (m Migrator) DropIndex(value interface{}, name string) error
- func (m Migrator) DropTable(values ...interface{}) error
- func (m Migrator) GetIndexes(value interface{}) ([]gorm.Index, error)
- func (m Migrator) GetRows(currentSchema interface{}, table interface{}) (*sql.Rows, error)
- func (m Migrator) GetTables() (tableList []string, err error)
- func (m Migrator) GetTypeAliases(databaseTypeName string) []string
- func (m Migrator) HasColumn(value interface{}, field string) bool
- func (m Migrator) HasConstraint(value interface{}, name string) bool
- func (m Migrator) HasIndex(value interface{}, name string) bool
- func (m Migrator) HasTable(value interface{}) bool
- func (m Migrator) MigrateColumn(value interface{}, field *schema.Field, columnType gorm.ColumnType) error
- func (m Migrator) RenameColumn(dst interface{}, oldName, field string) error
- func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error
- func (m Migrator) UpdateSequence(tx *gorm.DB, stmt *gorm.Statement, field *schema.Field, ...) (err error)
Constants ¶
View Source
const DriverName = "kingbase"
DriverName 数据库驱动、连接字符串协议名称
Variables ¶
This section is empty.
Functions ¶
func BuildUrl ¶
func BuildUrl(user, password, host string, port int, dbname string, options ...map[string]string) string
BuildUrl 构建 KES 数据库连接字符串
- 如： kingbase://user:password@host1[,host2]:port/dbname?search_path=public[&propName2=propValue2]…
- 可用连接参数请参考 gokb 包文档及： https://github.com/godoes/gorm-kingbase/blob/master/gokb/conn.go#L3277
Types ¶
type Dialector ¶
type Dialector struct {
*Config
}
func (Dialector) DefaultValueOf ¶
func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression
type Index ¶
type Index struct {
TableName string `gorm:"column:table_name"`
ColumnName string `gorm:"column:column_name"`
IndexName string `gorm:"column:index_name"`
NonUnique bool `gorm:"column:non_unique"`
Primary bool `gorm:"column:primary"`
}
Index table index info
type Migrator ¶
func (Migrator) AlterColumn ¶
AlterColumn alter value's `field` column' type based on schema definition
func (Migrator) BuildIndexOptions ¶
func (m Migrator) BuildIndexOptions(opts []schema.IndexOption, stmt *gorm.Statement) (results []interface{})
func (Migrator) ColumnTypes ¶
func (m Migrator) ColumnTypes(value interface{}) (columnTypes []gorm.ColumnType, err error)
func (Migrator) CreateIndex ¶
func (Migrator) CreateSequence ¶
func (Migrator) CreateTable ¶
func (Migrator) CurrentDatabase ¶
func (Migrator) CurrentSchema ¶
func (Migrator) DeleteSequence ¶
func (Migrator) DropColumn ¶
func (Migrator) GetTypeAliases ¶
func (Migrator) HasConstraint ¶
func (Migrator) MigrateColumn ¶
func (Migrator) RenameColumn ¶
func (Migrator) RenameIndex ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package gokb
|
Package gokb |
|
oid
Package oid 包定义了服务端数据类型的oid
|
Package oid 包定义了服务端数据类型的oid |
|
scram
Package scram
|
Package scram |
|
sm3
Package sm3 ***************************************************************************** * 版权信息：中电科金仓（北京）科技股份有限公司
|
Package sm3 ***************************************************************************** * 版权信息：中电科金仓（北京）科技股份有限公司 |
Click to show internal directories.
Click to hide internal directories.