dbutil

package

v0.15.3 Latest Latest Go to latest Published: Dec 17, 2023 License: MIT Imports: 21 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/genjidb/genji

Links

Open Source Insights

Documentation ¶

Index ¶

func Bench(db *genji.DB, query string, opt BenchOptions) error
func CanReadFromStandardInput() bool
func Dump(db *genji.DB, w io.Writer, tables ...string) error
func DumpPebble(c context.Context, db *pebble.DB, opt DumpPebbleOptions) error
func DumpSchema(db *genji.DB, w io.Writer, tables ...string) error
func ExecSQL(ctx context.Context, db *genji.DB, r io.Reader, w io.Writer) error
func InsertJSON(db *genji.DB, table string, r io.Reader) error
func ListIndexes(db *genji.DB, tableName string) ([]string, error)
func OpenDB(ctx context.Context, dbPath string) (*genji.DB, error)
func QueryTables(tx *genji.Tx, tables []string, fn func(name, query string) error) error
func Restore(ctx context.Context, db *genji.DB, dumpFile, dbPath string) error
type BenchOptions
type DumpPebbleOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Bench ¶ added in v0.14.0

func Bench(db *genji.DB, query string, opt BenchOptions) error

Bench takes a database and dumps its content as SQL queries in the given writer. If tables is provided, only selected tables will be outputted.

func CanReadFromStandardInput ¶

func CanReadFromStandardInput() bool

CanReadFromStandardInput returns whether there is data to be read in stdin.

func Dump ¶

func Dump(db *genji.DB, w io.Writer, tables ...string) error

Dump takes a database and dumps its content as SQL queries in the given writer. If tables is provided, only selected tables will be outputted.

func DumpPebble ¶ added in v0.15.3

func DumpPebble(c context.Context, db *pebble.DB, opt DumpPebbleOptions) error

func DumpSchema ¶ added in v0.12.0

func DumpSchema(db *genji.DB, w io.Writer, tables ...string) error

DumpSchema takes a database and dumps its schema as SQL queries in the given writer. If tables are provided, only selected tables will be outputted.

func ExecSQL ¶

func ExecSQL(ctx context.Context, db *genji.DB, r io.Reader, w io.Writer) error

ExecSQL reads SQL queries from reader and executes them until the reader is exhausted. If the query has results, they will be outputted to w.

func InsertJSON ¶

func InsertJSON(db *genji.DB, table string, r io.Reader) error

InsertJSON reads json documents from r and inserts them into the selected table. The reader can be either a stream of json objects or an array of objects.

func ListIndexes ¶ added in v0.13.0

func ListIndexes(db *genji.DB, tableName string) ([]string, error)

func OpenDB ¶

func OpenDB(ctx context.Context, dbPath string) (*genji.DB, error)

OpenDB is a helper function that takes raw unvalidated parameters and opens a database.

func QueryTables ¶ added in v0.13.0

func QueryTables(tx *genji.Tx, tables []string, fn func(name, query string) error) error

func Restore ¶ added in v0.15.3

func Restore(ctx context.Context, db *genji.DB, dumpFile, dbPath string) error

Restore a database from a file created by genji dump. This function can be provided with an existing database (genji cli use case), otherwise new database is being created.

Types ¶

type BenchOptions ¶ added in v0.14.0

type BenchOptions struct {
	Init       string
	N          int
	SampleSize int
	SameTx     bool
	Prepare    bool
	CSV        bool
}

type DumpPebbleOptions ¶ added in v0.15.3

type DumpPebbleOptions struct {
	KeysOnly bool
}

Source Files ¶

View all Source files

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