mirror of
https://gitee.com/johng/gf.git
synced 2024-12-06 06:08:38 +08:00
178 lines
5.2 KiB
Go
178 lines
5.2 KiB
Go
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
|
|
//
|
|
// This Source Code Form is subject to the terms of the MIT License.
|
|
// If a copy of the MIT was not distributed with this file,
|
|
// You can obtain one at https://github.com/gogf/gf.
|
|
//
|
|
// Note:
|
|
// 1. It needs manually import: _ "github.com/mattn/go-sqlite3"
|
|
// 2. It does not support Save/Replace features.
|
|
|
|
// Package sqlite implements gdb.Driver, which supports operations for SQLite.
|
|
package sqlite
|
|
|
|
import (
|
|
_ "github.com/mattn/go-sqlite3"
|
|
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/gogf/gf/v2/container/gmap"
|
|
"github.com/gogf/gf/v2/database/gdb"
|
|
"github.com/gogf/gf/v2/errors/gcode"
|
|
"github.com/gogf/gf/v2/errors/gerror"
|
|
"github.com/gogf/gf/v2/os/gfile"
|
|
"github.com/gogf/gf/v2/text/gstr"
|
|
)
|
|
|
|
// Driver is the driver for sqlite database.
|
|
type Driver struct {
|
|
*gdb.Core
|
|
}
|
|
|
|
var (
|
|
// tableFieldsMap caches the table information retrieved from database.
|
|
tableFieldsMap = gmap.New(true)
|
|
)
|
|
|
|
func init() {
|
|
if err := gdb.Register(`sqlite`, New()); err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
|
|
// New create and returns a driver that implements gdb.Driver, which supports operations for SQLite.
|
|
func New() gdb.Driver {
|
|
return &Driver{}
|
|
}
|
|
|
|
// New creates and returns a database object for sqlite.
|
|
// It implements the interface of gdb.Driver for extra database driver installation.
|
|
func (d *Driver) New(core *gdb.Core, node *gdb.ConfigNode) (gdb.DB, error) {
|
|
return &Driver{
|
|
Core: core,
|
|
}, nil
|
|
}
|
|
|
|
// Open creates and returns a underlying sql.DB object for sqlite.
|
|
func (d *Driver) Open(config *gdb.ConfigNode) (db *sql.DB, err error) {
|
|
var (
|
|
source string
|
|
underlyingDriverName = "sqlite3"
|
|
)
|
|
if config.Link != "" {
|
|
source = config.Link
|
|
} else {
|
|
source = config.Name
|
|
}
|
|
// It searches the source file to locate its absolute path..
|
|
if absolutePath, _ := gfile.Search(source); absolutePath != "" {
|
|
source = absolutePath
|
|
}
|
|
if db, err = sql.Open(underlyingDriverName, source); err != nil {
|
|
err = gerror.WrapCodef(
|
|
gcode.CodeDbOperationError, err,
|
|
`sql.Open failed for driver "%s" by source "%s"`, underlyingDriverName, source,
|
|
)
|
|
return nil, err
|
|
}
|
|
return
|
|
}
|
|
|
|
// FilteredLink retrieves and returns filtered `linkInfo` that can be using for
|
|
// logging or tracing purpose.
|
|
func (d *Driver) FilteredLink() string {
|
|
return d.GetConfig().Link
|
|
}
|
|
|
|
// GetChars returns the security char for this type of database.
|
|
func (d *Driver) GetChars() (charLeft string, charRight string) {
|
|
return "`", "`"
|
|
}
|
|
|
|
// DoFilter deals with the sql string before commits it to underlying sql driver.
|
|
func (d *Driver) DoFilter(ctx context.Context, link gdb.Link, sql string, args []interface{}) (newSql string, newArgs []interface{}, err error) {
|
|
return d.Core.DoFilter(ctx, link, sql, args)
|
|
}
|
|
|
|
// Tables retrieves and returns the tables of current schema.
|
|
// It's mainly used in cli tool chain for automatically generating the models.
|
|
func (d *Driver) Tables(ctx context.Context, schema ...string) (tables []string, err error) {
|
|
var result gdb.Result
|
|
link, err := d.SlaveLink(schema...)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
result, err = d.DoSelect(ctx, link, `SELECT NAME FROM SQLITE_MASTER WHERE TYPE='table' ORDER BY NAME`)
|
|
if err != nil {
|
|
return
|
|
}
|
|
for _, m := range result {
|
|
for _, v := range m {
|
|
tables = append(tables, v.String())
|
|
}
|
|
}
|
|
return
|
|
}
|
|
|
|
// TableFields retrieves and returns the fields' information of specified table of current schema.
|
|
//
|
|
// Also see DriverMysql.TableFields.
|
|
func (d *Driver) TableFields(ctx context.Context, table string, schema ...string) (fields map[string]*gdb.TableField, err error) {
|
|
charL, charR := d.GetChars()
|
|
table = gstr.Trim(table, charL+charR)
|
|
if gstr.Contains(table, " ") {
|
|
return nil, gerror.NewCode(gcode.CodeInvalidParameter, "function TableFields supports only single table operations")
|
|
}
|
|
useSchema := d.GetSchema()
|
|
if len(schema) > 0 && schema[0] != "" {
|
|
useSchema = schema[0]
|
|
}
|
|
v := tableFieldsMap.GetOrSetFuncLock(
|
|
fmt.Sprintf(`sqlite_table_fields_%s_%s@group:%s`, table, useSchema, d.GetGroup()),
|
|
func() interface{} {
|
|
var (
|
|
result gdb.Result
|
|
link gdb.Link
|
|
)
|
|
if link, err = d.SlaveLink(useSchema); err != nil {
|
|
return nil
|
|
}
|
|
result, err = d.DoSelect(ctx, link, fmt.Sprintf(`PRAGMA TABLE_INFO(%s)`, table))
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
fields = make(map[string]*gdb.TableField)
|
|
for i, m := range result {
|
|
fields[strings.ToLower(m["name"].String())] = &gdb.TableField{
|
|
Index: i,
|
|
Name: strings.ToLower(m["name"].String()),
|
|
Type: strings.ToLower(m["type"].String()),
|
|
}
|
|
}
|
|
return fields
|
|
},
|
|
)
|
|
if v != nil {
|
|
fields = v.(map[string]*gdb.TableField)
|
|
}
|
|
return
|
|
}
|
|
|
|
// DoInsert is not supported in sqlite.
|
|
func (d *Driver) DoInsert(ctx context.Context, link gdb.Link, table string, list gdb.List, option gdb.DoInsertOption) (result sql.Result, err error) {
|
|
switch option.InsertOption {
|
|
case gdb.InsertOptionSave:
|
|
return nil, gerror.NewCode(gcode.CodeNotSupported, `Save operation is not supported by sqlite driver`)
|
|
|
|
case gdb.InsertOptionReplace:
|
|
return nil, gerror.NewCode(gcode.CodeNotSupported, `Replace operation is not supported by sqlite driver`)
|
|
|
|
default:
|
|
return d.Core.DoInsert(ctx, link, table, list, option)
|
|
}
|
|
}
|