xdbutils_sqlite

README

xdbutils_sqlite

Dependencies

• None

Documents

Types

• type ErrNo int
• type ErrNoExtended int
• type SQLiteConfig struct
• type SQLiteDriverOptions struct

Variables

• None

Constants

• ...

Functions

• func CheckSQLiteErrorExtendedCodeByReflect(err error, code int) bool
• func WithExtensions(extensions []string) SQLiteDriverOption
• func WithAggregatorRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption
• func WithAuthorizerRegisterer(callback func(int, string, string, string) int) SQLiteDriverOption
• func WithCollationRegisterer(name string, cmp func(string, string) int) SQLiteDriverOption
• func WithCommitHookRegisterer(callback func() int) SQLiteDriverOption
• func WithFuncRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption
• func WithPreUpdateHookRegister(callback func(interface{})) SQLiteDriverOption
• func WithRollbackHookRegisterer(callback func()) SQLiteDriverOption
• func WithUpdateHookRegisterer(callback func(int, string, string, int64)) SQLiteDriverOption
• func WithSQLiteConnectionHooker(hooker func(interface{}) error) SQLiteDriverOption

Methods

• func (err ErrNo) Extend(by int) ErrNoExtended
• func (s *SQLiteConfig) FormatDSN() string

Documentation

Index

• Constants
• func CheckSQLiteErrorExtendedCodeByReflect(err error, code int) bool
• type ErrNo
  • func (err ErrNo) Extend(by int) ErrNoExtended
• type ErrNoExtended
• type SQLiteConfig
  • func (s *SQLiteConfig) FormatDSN() string
• type SQLiteDriverOption
  • func WithAggregatorRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption
  • func WithAuthorizerRegisterer(callback func(int, string, string, string) int) SQLiteDriverOption
  • func WithCollationRegisterer(name string, cmp func(string, string) int) SQLiteDriverOption
  • func WithCommitHookRegisterer(callback func() int) SQLiteDriverOption
  • func WithExtensions(extensions []string) SQLiteDriverOption
  • func WithFuncRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption
  • func WithPreUpdateHookRegister(callback func(interface{})) SQLiteDriverOption
  • func WithRollbackHookRegisterer(callback func()) SQLiteDriverOption
  • func WithSQLiteConnectionHooker(hooker func(interface{}) error) SQLiteDriverOption
  • func WithUpdateHookRegisterer(callback func(int, string, string, int64)) SQLiteDriverOption
• type SQLiteDriverOptions

Constants

const (
	ErrError      = ErrNo(1)  /* SQL error or missing database */
	ErrInternal   = ErrNo(2)  /* Internal logic error in SQLite */
	ErrPerm       = ErrNo(3)  /* Access permission denied */
	ErrAbort      = ErrNo(4)  /* Callback routine requested an abort */
	ErrBusy       = ErrNo(5)  /* The database file is locked */
	ErrLocked     = ErrNo(6)  /* A table in the database is locked */
	ErrNomem      = ErrNo(7)  /* A malloc() failed */
	ErrReadonly   = ErrNo(8)  /* Attempt to write a readonly database */
	ErrInterrupt  = ErrNo(9)  /* Operation terminated by sqlite3_interrupt() */
	ErrIoErr      = ErrNo(10) /* Some kind of disk I/O error occurred */
	ErrCorrupt    = ErrNo(11) /* The database disk image is malformed */
	ErrNotFound   = ErrNo(12) /* Unknown opcode in sqlite3_file_control() */
	ErrFull       = ErrNo(13) /* Insertion failed because database is full */
	ErrCantOpen   = ErrNo(14) /* Unable to open the database file */
	ErrProtocol   = ErrNo(15) /* Database lock protocol error */
	ErrEmpty      = ErrNo(16) /* Database is empty */
	ErrSchema     = ErrNo(17) /* The database schema changed */
	ErrTooBig     = ErrNo(18) /* String or BLOB exceeds size limit */
	ErrConstraint = ErrNo(19) /* Abort due to constraint violation */
	ErrMismatch   = ErrNo(20) /* Data type mismatch */
	ErrMisuse     = ErrNo(21) /* Library used incorrectly */
	ErrNoLFS      = ErrNo(22) /* Uses OS features not supported on host */
	ErrAuth       = ErrNo(23) /* Authorization denied */
	ErrFormat     = ErrNo(24) /* Auxiliary database format error */
	ErrRange      = ErrNo(25) /* 2nd parameter to sqlite3_bind out of range */
	ErrNotADB     = ErrNo(26) /* File opened that is not a database file */
	ErrNotice     = ErrNo(27) /* Notifications from sqlite3_log() */
	ErrWarning    = ErrNo(28) /* Warnings from sqlite3_log() */
)

Result codes from http://www.sqlite.org/c3ref/c_abort.html.

const (
	ErrIoErrRead              = ErrNoExtended(ErrIoErr | 1<<8)       // ErrIoErr.Extend(1) => ErrIoErr = ErrNo(10)
	ErrIoErrShortRead         = ErrNoExtended(ErrIoErr | 2<<8)       // ErrIoErr.Extend(2)
	ErrIoErrWrite             = ErrNoExtended(ErrIoErr | 3<<8)       // ErrIoErr.Extend(3)
	ErrIoErrFsync             = ErrNoExtended(ErrIoErr | 4<<8)       // ErrIoErr.Extend(4)
	ErrIoErrDirFsync          = ErrNoExtended(ErrIoErr | 5<<8)       // ErrIoErr.Extend(5)
	ErrIoErrTruncate          = ErrNoExtended(ErrIoErr | 6<<8)       // ErrIoErr.Extend(6)
	ErrIoErrFstat             = ErrNoExtended(ErrIoErr | 7<<8)       // ErrIoErr.Extend(7)
	ErrIoErrUnlock            = ErrNoExtended(ErrIoErr | 8<<8)       // ErrIoErr.Extend(8)
	ErrIoErrRDlock            = ErrNoExtended(ErrIoErr | 9<<8)       // ErrIoErr.Extend(9)
	ErrIoErrDelete            = ErrNoExtended(ErrIoErr | 10<<8)      // ErrIoErr.Extend(10)
	ErrIoErrBlocked           = ErrNoExtended(ErrIoErr | 11<<8)      // ErrIoErr.Extend(11)
	ErrIoErrNoMem             = ErrNoExtended(ErrIoErr | 12<<8)      // ErrIoErr.Extend(12)
	ErrIoErrAccess            = ErrNoExtended(ErrIoErr | 13<<8)      // ErrIoErr.Extend(13)
	ErrIoErrCheckReservedLock = ErrNoExtended(ErrIoErr | 14<<8)      // ErrIoErr.Extend(14)
	ErrIoErrLock              = ErrNoExtended(ErrIoErr | 15<<8)      // ErrIoErr.Extend(15)
	ErrIoErrClose             = ErrNoExtended(ErrIoErr | 16<<8)      // ErrIoErr.Extend(16)
	ErrIoErrDirClose          = ErrNoExtended(ErrIoErr | 17<<8)      // ErrIoErr.Extend(17)
	ErrIoErrSHMOpen           = ErrNoExtended(ErrIoErr | 18<<8)      // ErrIoErr.Extend(18)
	ErrIoErrSHMSize           = ErrNoExtended(ErrIoErr | 19<<8)      // ErrIoErr.Extend(19)
	ErrIoErrSHMLock           = ErrNoExtended(ErrIoErr | 20<<8)      // ErrIoErr.Extend(20)
	ErrIoErrSHMMap            = ErrNoExtended(ErrIoErr | 21<<8)      // ErrIoErr.Extend(21)
	ErrIoErrSeek              = ErrNoExtended(ErrIoErr | 22<<8)      // ErrIoErr.Extend(22)
	ErrIoErrDeleteNoent       = ErrNoExtended(ErrIoErr | 23<<8)      // ErrIoErr.Extend(23)
	ErrIoErrMMap              = ErrNoExtended(ErrIoErr | 24<<8)      // ErrIoErr.Extend(24)
	ErrIoErrGetTempPath       = ErrNoExtended(ErrIoErr | 25<<8)      // ErrIoErr.Extend(25)
	ErrIoErrConvPath          = ErrNoExtended(ErrIoErr | 26<<8)      // ErrIoErr.Extend(26)
	ErrLockedSharedCache      = ErrNoExtended(ErrLocked | 1<<8)      // ErrLocked.Extend(1) => ErrLocked = ErrNo(6)
	ErrBusyRecovery           = ErrNoExtended(ErrBusy | 1<<8)        // ErrBusy.Extend(1) => ErrBusy = ErrNo(5)
	ErrBusySnapshot           = ErrNoExtended(ErrBusy | 2<<8)        // ErrBusy.Extend(2)
	ErrCantOpenNoTempDir      = ErrNoExtended(ErrCantOpen | 1<<8)    // ErrCantOpen.Extend(1) => ErrCantOpen = ErrNo(14)
	ErrCantOpenIsDir          = ErrNoExtended(ErrCantOpen | 2<<8)    // ErrCantOpen.Extend(2)
	ErrCantOpenFullPath       = ErrNoExtended(ErrCantOpen | 3<<8)    // ErrCantOpen.Extend(3)
	ErrCantOpenConvPath       = ErrNoExtended(ErrCantOpen | 4<<8)    // ErrCantOpen.Extend(4)
	ErrCorruptVTab            = ErrNoExtended(ErrCorrupt | 1<<8)     // ErrCorrupt.Extend(1) => ErrCorrupt = ErrNo(11)
	ErrReadonlyRecovery       = ErrNoExtended(ErrReadonly | 1<<8)    // ErrReadonly.Extend(1) => ErrReadonly = ErrNo(8)
	ErrReadonlyCantLock       = ErrNoExtended(ErrReadonly | 2<<8)    // ErrReadonly.Extend(2)
	ErrReadonlyRollback       = ErrNoExtended(ErrReadonly | 3<<8)    // ErrReadonly.Extend(3)
	ErrReadonlyDbMoved        = ErrNoExtended(ErrReadonly | 4<<8)    // ErrReadonly.Extend(4)
	ErrAbortRollback          = ErrNoExtended(ErrAbort | 2<<8)       // ErrAbort.Extend(2) => ErrAbort = ErrNo(4)
	ErrConstraintCheck        = ErrNoExtended(ErrConstraint | 1<<8)  // ErrConstraint.Extend(1) => ErrConstraint = ErrNo(19)
	ErrConstraintCommitHook   = ErrNoExtended(ErrConstraint | 2<<8)  // ErrConstraint.Extend(2)
	ErrConstraintForeignKey   = ErrNoExtended(ErrConstraint | 3<<8)  // ErrConstraint.Extend(3)
	ErrConstraintFunction     = ErrNoExtended(ErrConstraint | 4<<8)  // ErrConstraint.Extend(4)
	ErrConstraintNotNull      = ErrNoExtended(ErrConstraint | 5<<8)  // ErrConstraint.Extend(5)
	ErrConstraintPrimaryKey   = ErrNoExtended(ErrConstraint | 6<<8)  // ErrConstraint.Extend(6)
	ErrConstraintTrigger      = ErrNoExtended(ErrConstraint | 7<<8)  // ErrConstraint.Extend(7)
	ErrConstraintUnique       = ErrNoExtended(ErrConstraint | 8<<8)  // ErrConstraint.Extend(8)
	ErrConstraintVTab         = ErrNoExtended(ErrConstraint | 9<<8)  // ErrConstraint.Extend(9)
	ErrConstraintRowID        = ErrNoExtended(ErrConstraint | 10<<8) // ErrConstraint.Extend(10)
	ErrNoticeRecoverWAL       = ErrNoExtended(ErrNotice | 1<<8)      // ErrNotice.Extend(1) => ErrNotice = ErrNo(27)
	ErrNoticeRecoverRollback  = ErrNoExtended(ErrNotice | 2<<8)      // ErrNotice.Extend(2)
	ErrWarningAutoIndex       = ErrNoExtended(ErrWarning | 1<<8)     // ErrWarning.Extend(1) => ErrWarning = ErrNo(28)
)

Result codes from http://www.sqlite.org/c3ref/c_abort_rollback.html.

Functions

func CheckSQLiteErrorExtendedCodeByReflect

func CheckSQLiteErrorExtendedCodeByReflect(err error, code int) bool

CheckSQLiteErrorExtendedCodeByReflect checks whether given err can be regarded as SQLite error (github.com/mattn/go-sqlite3), and whether its extended code is given code or not.

Types

type ErrNo

type ErrNo int

ErrNo represents sqlite3.Error's Error field, which inherits errno.

func (ErrNo) Extend

func (err ErrNo) Extend(by int) ErrNoExtended

Extend returns extended errno.

type ErrNoExtended

type ErrNoExtended int

ErrNoExtended represents sqlite3.Error's ExtendedCode field, which is extended errno.

type SQLiteConfig

type SQLiteConfig struct {
	// SQLite specified parameters
	Filename  string // Database filename (<filepath>, ":memory:", empty string)
	VFS       string // The name of a VFS object
	Mode      string // Access Mode (ro, rw, rwc, memory)
	Cache     string // Shared-Cache Mode (shared, private)
	Psow      *bool  // ...
	NoLock    *bool  // ...
	Immutable *bool  // ...

	// go-sqlite3 package parameters
	Auth                   bool   // UA - Create, defaults to false
	AuthUser               string // UA - Username
	AuthPass               string // UA - Password
	AuthCrypt              string // UA - Crypt (SHA1, SSHA1, SHA256, SSHA256, SHA384, SSHA384, SHA512, SSHA512)
	AuthSalt               string // UA - Salt
	AutoVacuum             string // Auto Vacuum (none, full, incremental), defaults to ignore this option
	BusyTimeout            *int   // Busy Timeout, default to 5000
	CaseSensitiveLike      *bool  // Case Sensitive LIKE, defaults to ignore this option
	DeferForeignKeys       *bool  // Defer Foreign Keys, defaults to ignore this option
	ForeignKeys            *bool  // Foreign Keys, defaults to ignore this option
	IgnoreCheckConstraints *bool  // Ignore CHECK Constraints, defaults to ignore this option
	JournalMode            string // Journal Mode (DELETE, TRUNCATE, PERSIST, MEMORY, WAL, OFF), defaults to ignore this option
	LockingMode            string // Locking Mode (NORMAL, EXCLUSIVE), defaults to NORMAL
	Mutex                  string // Mutex Locking (no, full), defaults to full
	QueryOnly              *bool  // Query Only, defaults to ignore this option
	RecursiveTriggers      *bool  // Recursive Triggers, defaults to ignore this option
	SecureDelete           string // Secure Delete (default, yes, no, fast), defaults to default
	Synchronous            string // Synchronous (OFF, NORMAL, FULL, EXTRA), defaults to normal
	Loc                    string // Time Zone Location (auto, ...), defaults to ignore this option
	TransactionLock        string // Transaction Lock (immediate, deferred, exclusive), defaults to deferred
	WritableSchema         *bool  // Writable Schema, defaults to ignore this option
	CacheSize              *int   // Cache Size, defaults to ignore this option
}

SQLiteConfig is a configuration for SQLite, can be used to generate DSN by FormatDSN method.

Please visit the follow links for more information: - https://github.com/mattn/go-sqlite3#connection-string - https://www.sqlite.org/c3ref/open.html

func (*SQLiteConfig) FormatDSN

func (s *SQLiteConfig) FormatDSN() string

FormatDSN generates formatted DSN string from SQLiteConfig.

type SQLiteDriverOption

type SQLiteDriverOption func(*SQLiteDriverOptions)

SQLiteDriverOption represents an option type for NewSQLiteDriver's option, can be created by WithXXX functions.

func WithAggregatorRegisterer

func WithAggregatorRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption

WithAggregatorRegisterer creates an SQLiteDriverOption to specify the aggregator registerer for sqlite driver.

func WithAuthorizerRegisterer

func WithAuthorizerRegisterer(callback func(int, string, string, string) int) SQLiteDriverOption

WithAuthorizerRegisterer creates an SQLiteDriverOption to specify the authorizer registerer for sqlite driver.

func WithCollationRegisterer

func WithCollationRegisterer(name string, cmp func(string, string) int) SQLiteDriverOption

WithCollationRegisterer creates an SQLiteDriverOption to specify the collation registerer for sqlite driver.

func WithCommitHookRegisterer

func WithCommitHookRegisterer(callback func() int) SQLiteDriverOption

WithCommitHookRegisterer creates an SQLiteDriverOption to specify the commit hook registerer for sqlite driver.

func WithExtensions

func WithExtensions(extensions []string) SQLiteDriverOption

WithExtensions creates an SQLiteDriverOption to specify the extensions for sqlite driver.

func WithFuncRegisterer

func WithFuncRegisterer(name string, impl interface{}, pure bool) SQLiteDriverOption

WithFuncRegisterer creates an SQLiteDriverOption to specify the func registerer for sqlite driver.

func WithPreUpdateHookRegister

func WithPreUpdateHookRegister(callback func(interface{})) SQLiteDriverOption

WithPreUpdateHookRegister creates an SQLiteDriverOption to specify the pre-update hook registerer for sqlite driver.

func WithRollbackHookRegisterer

func WithRollbackHookRegisterer(callback func()) SQLiteDriverOption

WithRollbackHookRegisterer creates an SQLiteDriverOption to specify the rollback hook registerer for sqlite driver.

func WithSQLiteConnectionHooker

func WithSQLiteConnectionHooker(hooker func(interface{}) error) SQLiteDriverOption

WithSQLiteConnectionHooker creates an SQLiteDriverOption to specify the sqlite connection hooker for sqlite driver.

func WithUpdateHookRegisterer

func WithUpdateHookRegisterer(callback func(int, string, string, int64)) SQLiteDriverOption

WithUpdateHookRegisterer creates an SQLiteDriverOption to specify the update hook registerer for sqlite driver.

type SQLiteDriverOptions

type SQLiteDriverOptions struct {
	// contains filtered or unexported fields
}

SQLiteDriverOptions is a type of NewSQLiteDriver's option, each field can be set by SQLiteDriverOption function type.