sqlite

Documentation

Index

• func Build(phrase string) *sqlx.Builder
• func MarshalSpec(v interface{}, marshaler schemaspec.Marshaler) ([]byte, error)
• func UnmarshalSpec(data []byte, unmarshaler schemaspec.Unmarshaler, v interface{}) error
• type AutoIncrement
• type CreateStmt
• type Driver
  • func Open(db schema.ExecQuerier) (*Driver, error)
  • func (d Driver) Diff() schema.Differ
  • func (d *Driver) FormatType(t schema.Type) (string, error)
  • func (d *Driver) InspectRealm(ctx context.Context, opts *schema.InspectRealmOption) (*schema.Realm, error)
  • func (d *Driver) InspectSchema(ctx context.Context, name string, opts *schema.InspectOptions) (*schema.Schema, error)
  • func (d *Driver) InspectTable(ctx context.Context, name string, opts *schema.InspectTableOptions) (*schema.Table, error)
  • func (d *Driver) Migrate() schema.Execer
• type File
• type IndexOrigin
• type IndexPredicate
• type UUIDType
• type WithoutRowID

Functions

func Build

func Build(phrase string) *sqlx.Builder

Build instantiates a new builder and writes the given phrase to it.

func MarshalSpec

func MarshalSpec(v interface{}, marshaler schemaspec.Marshaler) ([]byte, error)

MarshalSpec marshals v into an Atlas DDL document using a schemaspec.Marshaler.

func UnmarshalSpec

func UnmarshalSpec(data []byte, unmarshaler schemaspec.Unmarshaler, v interface{}) error

UnmarshalSpec unmarshals an Atlas DDL document using an unmarshaler into v.

Types

type AutoIncrement

type AutoIncrement struct {
	schema.Attr
}

AutoIncrement describes the `AUTOINCREMENT` configuration. https://www.sqlite.org/autoinc.html

type CreateStmt

type CreateStmt struct {
	schema.Attr
	S string
}

CreateStmt describes the SQL statement used to create a resource.

type Driver

type Driver struct {
	schema.ExecQuerier
	// contains filtered or unexported fields
}

Driver represents an SQLite driver for introspecting database schemas and apply migrations changes on them.

func Open

func Open(db schema.ExecQuerier) (*Driver, error)

Open opens a new SQLite driver.

func (Driver) Diff

func (d Driver) Diff() schema.Differ

Diff returns a SQLite schema differ.

func (*Driver) FormatType

func (d *Driver) FormatType(t schema.Type) (string, error)

FormatType converts types to one format. A lowered format. This is due to SQLite flexibility to allow any data types and use a set of rules to define the type affinity. See: https://www.sqlite.org/datatype3.html

func (*Driver) InspectRealm

func (d *Driver) InspectRealm(ctx context.Context, opts *schema.InspectRealmOption) (*schema.Realm, error)

InspectRealm returns schema descriptions of all resources in the given realm.

func (*Driver) InspectSchema

func (d *Driver) InspectSchema(ctx context.Context, name string, opts *schema.InspectOptions) (*schema.Schema, error)

InspectSchema returns schema descriptions of all tables in the given schema.

func (*Driver) InspectTable

func (d *Driver) InspectTable(ctx context.Context, name string, opts *schema.InspectTableOptions) (*schema.Table, error)

InspectTable returns the schema description of the given table.

func (*Driver) Migrate

func (d *Driver) Migrate() schema.Execer

Migrate returns a SQLite schema executor.

type File

type File struct {
	schema.Attr
	Name string
}

File describes a database file.

type IndexOrigin

type IndexOrigin struct {
	schema.Attr
	O string
}

IndexOrigin describes how the index was created. See: https://www.sqlite.org/pragma.html#pragma_index_list

type IndexPredicate

type IndexPredicate struct {
	schema.Attr
	P string
}

IndexPredicate describes a partial index predicate. See: https://www.sqlite.org/partialindex.html

type UUIDType

type UUIDType struct {
	schema.Type
	T string
}

A UUIDType defines a UUID type.

type WithoutRowID

type WithoutRowID struct {
	schema.Attr
}

WithoutRowID describes the `WITHOUT ROWID` configuration. See: https://sqlite.org/withoutrowid.html