db

package

v2.2.0+incompatible Latest Latest Go to latest Published: Apr 19, 2016 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/abhishekshivanna/rqlite

Links

Open Source Insights

Documentation ¶

Overview ¶

Package db exposes a lightweight abstraction over the SQLite code. It performs some basic mapping of lower-level types to rqlite types.

Index ¶

Variables
type Config
- func NewConfig() *Config
- func (c *Config) FQDSN(path string) string
type DB
- func Open(dbPath string) (*DB, error)
- func OpenWithConfiguration(dbPath string, conf *Config) (*DB, error)
type Result
type Rows

Constants ¶

This section is empty.

Variables ¶

View Source

var DBVersion string

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	DSN    string // Datasource name
	Memory bool   // In-memory database enabled?
}

Config represents the configuration of the SQLite database.

func NewConfig ¶

func NewConfig() *Config

NewConfig returns an instance of Config for the database at path.

func (*Config) FQDSN ¶

func (c *Config) FQDSN(path string) string

FQDSN returns the fully-qualified datasource name.

type DB ¶

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

DB is the SQL database.

func Open ¶

func Open(dbPath string) (*DB, error)

Open an existing database, creating it if it does not exist.

func OpenWithConfiguration ¶

func OpenWithConfiguration(dbPath string, conf *Config) (*DB, error)

OpenWithConfiguration an existing database, creating it if it does not exist.

func (*DB) Backup ¶

func (db *DB) Backup(path string) error

Backup writes a consistent snapshot of the database to the given file.

func (*DB) Close ¶

func (db *DB) Close() error

Close closes the underlying database connection.

func (*DB) Execute ¶

func (db *DB) Execute(queries []string, tx, xTime bool) ([]*Result, error)

Execute executes queries that modify the database.

func (*DB) Query ¶

func (db *DB) Query(queries []string, tx, xTime bool) ([]*Rows, error)

Query executes queries that return rows, but don't modify the database.

type Result ¶

type Result struct {
	LastInsertID int64   `json:"last_insert_id,omitempty"`
	RowsAffected int64   `json:"rows_affected,omitempty"`
	Error        string  `json:"error,omitempty"`
	Time         float64 `json:"time,omitempty"`
}

Result represents the outcome of an operation that changes rows.

type Rows ¶

type Rows struct {
	Columns []string        `json:"columns,omitempty"`
	Types   []string        `json:"types,omitempty"`
	Values  [][]interface{} `json:"values,omitempty"`
	Error   string          `json:"error,omitempty"`
	Time    float64         `json:"time,omitempty"`
}

Rows represents the outcome of an operation that returns query data.

Source Files ¶

View all Source files

db.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL