sqlite

README

gorm-sqlite-cipher

Description

Go sqlite3 driver for GORM with an AES-256 encrypted sqlite3 database conforming to the built-in database/sql interface. It is based on:

• Go sqlite3 driver: https://github.com/mattn/go-sqlite3
• SQLite extension with AES-256 codec: https://github.com/sqlcipher/sqlcipher
• AES-256 implementation from: https://github.com/libtom/libtomcrypt
• GORM sqlite driver : https://github.com/go-gorm/sqlite

SQLite itself is part of SQLCipher.

Installation

This package can be installed with the go get command:

go get github.com/jackfr0st13/gorm-sqlite-cipher

USAGE

import (
  sqliteEncrypt "github.com/jackfr0st13/gorm-sqlite-cipher"
  "gorm.io/gorm"
)
key := "passphrase"
dbname := "go-sqlcipher.sqlite"
dbnameWithDSN := dbname + fmt.Sprintf("?_pragma_key=%s&_pragma_cipher_page_size=4096", key)
db, err := gorm.Open(sqliteEncrypt.Open(dbnameWithDSN), &gorm.Config{})

License

The code of the originating packages is covered by their respective licenses. See LICENSE file for details.

Documentation

Index

• Constants
• Variables
• func Open(dsn string) gorm.Dialector
• type Dialector
  • func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})
  • func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder
  • 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 (dialectopr Dialector) RollbackTo(tx *gorm.DB, name string) error
  • func (dialectopr Dialector) SavePoint(tx *gorm.DB, name string) error
• type Migrator
  • func (m Migrator) AlterColumn(value interface{}, name string) error
  • func (m Migrator) BuildIndexOptions(opts []schema.IndexOption, stmt *gorm.Statement) (results []interface{})
  • func (m Migrator) CreateConstraint(value interface{}, name string) error
  • func (m Migrator) CreateIndex(value interface{}, name string) error
  • func (m Migrator) CurrentDatabase() (name string)
  • func (m Migrator) DropColumn(value interface{}, name string) error
  • func (m Migrator) DropConstraint(value interface{}, name string) error
  • func (m Migrator) DropIndex(value interface{}, name string) error
  • func (m Migrator) DropTable(values ...interface{}) error
  • func (m Migrator) GetTables() (tableList []string, err error)
  • func (m Migrator) HasColumn(value interface{}, name 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) RenameIndex(value interface{}, oldName, newName string) error
  • func (m *Migrator) RunWithoutForeignKey(fc func() error) error

Constants

const DriverName = "sqlite3"

DriverName is the default driver name for SQLite.

Variables

var (
	ErrConstraintsNotImplemented = errors.New("constraints not implemented on sqlite, consider using DisableForeignKeyConstraintWhenMigrating, more details https://github.com/go-gorm/gorm/wiki/GORM-V2-Release-Note-Draft#all-new-migrator")
)

Functions

func Open

func Open(dsn string) gorm.Dialector

Types

type Dialector

type Dialector struct {
	DriverName string
	DSN        string
	Conn       gorm.ConnPool
}

func (Dialector) BindVarTo

func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v interface{})

func (Dialector) ClauseBuilders

func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder

func (Dialector) DataTypeOf

func (dialector Dialector) DataTypeOf(field *schema.Field) string

func (Dialector) DefaultValueOf

func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression

func (Dialector) Explain

func (dialector Dialector) Explain(sql string, vars ...interface{}) string

func (Dialector) Initialize

func (dialector Dialector) Initialize(db *gorm.DB) (err error)

func (Dialector) Migrator

func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator

func (Dialector) Name

func (dialector Dialector) Name() string

func (Dialector) QuoteTo

func (dialector Dialector) QuoteTo(writer clause.Writer, str string)

func (Dialector) RollbackTo

func (dialectopr Dialector) RollbackTo(tx *gorm.DB, name string) error

func (Dialector) SavePoint

func (dialectopr Dialector) SavePoint(tx *gorm.DB, name string) error

type Migrator

type Migrator struct {
	migrator.Migrator
}

func (Migrator) AlterColumn

func (m Migrator) AlterColumn(value interface{}, name string) error

func (Migrator) BuildIndexOptions

func (m Migrator) BuildIndexOptions(opts []schema.IndexOption, stmt *gorm.Statement) (results []interface{})

func (Migrator) CreateConstraint

func (m Migrator) CreateConstraint(value interface{}, name string) error

func (Migrator) CreateIndex

func (m Migrator) CreateIndex(value interface{}, name string) error

func (Migrator) CurrentDatabase

func (m Migrator) CurrentDatabase() (name string)

func (Migrator) DropColumn

func (m Migrator) DropColumn(value interface{}, name string) error

func (Migrator) DropConstraint

func (m Migrator) DropConstraint(value interface{}, name string) error

func (Migrator) DropIndex

func (m Migrator) DropIndex(value interface{}, name string) error

func (Migrator) DropTable

func (m Migrator) DropTable(values ...interface{}) error

func (Migrator) GetTables

func (m Migrator) GetTables() (tableList []string, err error)

func (Migrator) HasColumn

func (m Migrator) HasColumn(value interface{}, name string) bool

func (Migrator) HasConstraint

func (m Migrator) HasConstraint(value interface{}, name string) bool

func (Migrator) HasIndex

func (m Migrator) HasIndex(value interface{}, name string) bool

func (Migrator) HasTable

func (m Migrator) HasTable(value interface{}) bool

func (Migrator) RenameIndex

func (m Migrator) RenameIndex(value interface{}, oldName, newName string) error

func (*Migrator) RunWithoutForeignKey

func (m *Migrator) RunWithoutForeignKey(fc func() error) error