sqlds

package module

v0.0.0-...-239b36c Latest Latest Go to latest Published: Aug 12, 2020 License: MIT Imports: 7 Imported by: 1

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/0xProject/sql-datastore

Links

Open Source Insights

README ¶

SQL Datastore

An implementation of the datastore interface that can be backed by any sql database.

Usage

import (
	"database/sql"
	"github.com/whyrusleeping/sql-datastore"
)

mydb, _ := sql.Open("yourdb", "yourdbparameters")

ds := sqlds.NewSqlDatastore(mydb)

License

MIT

Documentation ¶

Index ¶

Variables
func NewQueriesForTable(tableName string) *queries
func QueryWithParams(d *Datastore, q dsq.Query) (*sql.Rows, error)
type Datastore
- func NewDatastore(db *sql.DB, queries Queries) *Datastore
type Options
- func (opts *Options) CreatePostgres() (*Datastore, error)
type Queries

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidType = errors.New("invalid value type")
)

Functions ¶

func NewQueriesForTable ¶

func NewQueriesForTable(tableName string) *queries

func QueryWithParams ¶

func QueryWithParams(d *Datastore, q dsq.Query) (*sql.Rows, error)

QueryWithParams applies prefix, limit, and offset params in pg query

Types ¶

type Datastore ¶

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

func (*Datastore) Batch ¶

func (d *Datastore) Batch() (ds.Batch, error)

func (*Datastore) Close ¶

func (d *Datastore) Close() error

func (*Datastore) Delete ¶

func (d *Datastore) Delete(key ds.Key) error

func (*Datastore) Get ¶

func (d *Datastore) Get(key ds.Key) (value []byte, err error)

func (*Datastore) GetSize ¶

func (d *Datastore) GetSize(key ds.Key) (int, error)

func (*Datastore) Has ¶

func (d *Datastore) Has(key ds.Key) (exists bool, err error)

func (*Datastore) Put ¶

func (d *Datastore) Put(key ds.Key, value []byte) error

func (*Datastore) Query ¶

func (d *Datastore) Query(q dsq.Query) (dsq.Results, error)

func (*Datastore) RawQuery ¶

func (d *Datastore) RawQuery(q dsq.Query) (dsq.Results, error)

func (*Datastore) Sync ¶

func (*Datastore) Sync(prefix ds.Key) error

Sync guarantees that any Put or Delete calls under prefix that returned before Sync(prefix) was called will be observed after Sync(prefix) returns, even if the program crashes. If Put/Delete operations already satisfy these requirements then Sync may be a no-op.

If the prefix fails to Sync this method returns an error.

type Options ¶

type Options struct {
	Host     string
	Port     string
	User     string
	Password string
	Database string
	Table    string
}

Options are the postgres datastore options, reexported here for convenience.

func (*Options) CreatePostgres ¶

func (opts *Options) CreatePostgres() (*Datastore, error)

Create returns a datastore connected to postgres initialized with a table

type Queries ¶

type Queries interface {
	Delete() string
	Exists() string
	Get() string
	Put() string
	Query() string
	Prefix() string
	Limit() string
	Offset() string
	GetSize() string
}

Source Files ¶

View all Source files

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