sqlite

Documentation

Overview

Package sqlite provides the schema interface for an SQLite database.

Index

• Constants
• type Column
  • func (col Column) ColumnType() ColumnType
  • func (col Column) Default() (interface{}, error)
  • func (col Column) GoType() interface{}
  • func (col Column) Hidden() bool
  • func (col Column) Index() int
  • func (col Column) IsPrimary() (bool, int)
  • func (col Column) Name() string
  • func (col Column) Nullable() bool
  • func (col Column) RawType() string
  • func (col Column) Type() (typ string)
• type ColumnType
• type DB
  • func New(filename string) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) Database() *sql.DB
  • func (db *DB) Init() error
  • func (db *DB) SchemaName() string
  • func (db *DB) Schemata() ([]schema.Schema, error)
• type ForeignKey
  • func (key ForeignKey) FromColumn() string
  • func (key ForeignKey) FromTable() string
  • func (key ForeignKey) ID() int
  • func (key ForeignKey) Match() string
  • func (key ForeignKey) OnDelete() string
  • func (key ForeignKey) OnUpdate() string
  • func (key ForeignKey) Seq() int
  • func (key ForeignKey) ToColumn() string
  • func (key ForeignKey) ToTable() string
• type Index
  • func (index Index) Columns() (cols []schema.Column, err error)
  • func (index Index) Name() string
  • func (index Index) Table() string
• type Object
  • func (obj Object) AsIndex(s *Schema) Index
  • func (obj Object) AsTable(s *Schema) Table
  • func (obj Object) AsTrigger(s *Schema) Trigger
  • func (obj Object) AsView(s *Schema) View
• type RowScanner
• type Schema
  • func (s Schema) Indexes() (indexes []schema.Index, err error)
  • func (s Schema) Name() string
  • func (s Schema) Tables() (tables []schema.Table, err error)
  • func (s Schema) Triggers() (triggers []schema.Trigger, err error)
  • func (s Schema) Views() (views []schema.View, err error)
• type Table
  • func (tbl Table) Columns() (cols []schema.Column, err error)
  • func (tbl Table) ForeignKeys() (keys []schema.ForeignKey, err error)
  • func (tbl Table) Indexes() (indexes []schema.Index, err error)
  • func (tbl Table) Name() string
  • func (tbl Table) SQL() string
  • func (tbl Table) Temporary() bool
  • func (tbl Table) Triggers() (triggers []schema.Trigger, err error)
• type Trigger
  • func (t Trigger) Name() string
  • func (t Trigger) SQL() string
  • func (t Trigger) Table() string
• type View
  • func (view View) Columns() (cols []schema.Column, err error)
  • func (view View) Name() string
  • func (view View) SQL() string

Constants

const (
	ObjectTypeTrigger = "trigger"
	ObjectTypeTable   = "table"
	ObjectTypeIndex   = "index"
	ObjectTypeView    = "view"
)

const (
	ColumnTypeStandard = ColumnType(iota)
	ColumnTypeHidden
	ColumnTypeGeneratedStored
	ColumnTypeGeneratedVirtual
)

Types

type Column

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

func (Column) ColumnType

func (col Column) ColumnType() ColumnType

func (Column) Default

func (col Column) Default() (interface{}, error)

func (Column) GoType

func (col Column) GoType() interface{}

func (Column) Hidden

func (col Column) Hidden() bool

func (Column) Index

func (col Column) Index() int

func (Column) IsPrimary

func (col Column) IsPrimary() (bool, int)

func (Column) Name

func (col Column) Name() string

func (Column) Nullable

func (col Column) Nullable() bool

func (Column) RawType

func (col Column) RawType() string

func (Column) Type

func (col Column) Type() (typ string)

type ColumnType

type ColumnType int

type DB

type DB struct {
	// We will start by using the sql.DB object, which is generic, and switch to the sqlite3.SQLiteConn object
	// if we need to.
	DB     database
	DBName string

	*Schema
	// contains filtered or unexported fields
}

func New

func New(filename string) (*DB, error)

func (*DB) Close

func (db *DB) Close() error

func (*DB) Database

func (db *DB) Database() *sql.DB

func (*DB) Init

func (db *DB) Init() error

func (*DB) SchemaName

func (db *DB) SchemaName() string

func (*DB) Schemata

func (db *DB) Schemata() ([]schema.Schema, error)

type ForeignKey

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

func (ForeignKey) FromColumn

func (key ForeignKey) FromColumn() string

func (ForeignKey) FromTable

func (key ForeignKey) FromTable() string

func (ForeignKey) ID

func (key ForeignKey) ID() int

func (ForeignKey) Match

func (key ForeignKey) Match() string

func (ForeignKey) OnDelete

func (key ForeignKey) OnDelete() string

func (ForeignKey) OnUpdate

func (key ForeignKey) OnUpdate() string

func (ForeignKey) Seq

func (key ForeignKey) Seq() int

func (ForeignKey) ToColumn

func (key ForeignKey) ToColumn() string

func (ForeignKey) ToTable

func (key ForeignKey) ToTable() string

type Index

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

func (Index) Columns

func (index Index) Columns() (cols []schema.Column, err error)

func (Index) Name

func (index Index) Name() string

func (Index) Table

func (index Index) Table() string

type Object

type Object struct {
	Name      string
	TableName string
	Type      string
	SQL       string
}

func (Object) AsIndex

func (obj Object) AsIndex(s *Schema) Index

func (Object) AsTable

func (obj Object) AsTable(s *Schema) Table

func (Object) AsTrigger

func (obj Object) AsTrigger(s *Schema) Trigger

func (Object) AsView

func (obj Object) AsView(s *Schema) View

type RowScanner

type RowScanner interface {
	Scan(dest ...interface{}) error
}

type Schema

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

func (Schema) Indexes

func (s Schema) Indexes() (indexes []schema.Index, err error)

func (Schema) Name

func (s Schema) Name() string

func (Schema) Tables

func (s Schema) Tables() (tables []schema.Table, err error)

func (Schema) Triggers

func (s Schema) Triggers() (triggers []schema.Trigger, err error)

func (Schema) Views

func (s Schema) Views() (views []schema.View, err error)

type Table

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

func (Table) Columns

func (tbl Table) Columns() (cols []schema.Column, err error)

func (Table) ForeignKeys

func (tbl Table) ForeignKeys() (keys []schema.ForeignKey, err error)

func (Table) Indexes

func (tbl Table) Indexes() (indexes []schema.Index, err error)

func (Table) Name

func (tbl Table) Name() string

func (Table) SQL

func (tbl Table) SQL() string

func (Table) Temporary

func (tbl Table) Temporary() bool

func (Table) Triggers

func (tbl Table) Triggers() (triggers []schema.Trigger, err error)

type Trigger

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

func (Trigger) Name

func (t Trigger) Name() string

func (Trigger) SQL

func (t Trigger) SQL() string

func (Trigger) Table

func (t Trigger) Table() string

type View

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

func (View) Columns

func (view View) Columns() (cols []schema.Column, err error)

func (View) Name

func (view View) Name() string

func (View) SQL

func (view View) SQL() string