postgres

Documentation

Index

• func MigrateDown(db *sql.DB, steps int, logger kitlog.Logger) error
• func MigrateDownAll(db *sql.DB, logger kitlog.Logger) error
• func MigrateUp(db *sql.DB, logger kitlog.Logger) error
• func NewMigration(dirName, migrationName string, logger kitlog.Logger) error
• func Open(connStr string) (*sqlx.DB, error)
• type Cursor
• type DB
  • func NewDB(connStr string, verbose bool, logger kitlog.Logger) *DB
  • func (d *DB) DeleteData(before time.Time, execute bool) error
  • func (d *DB) ReadData(publicKey string, pageSize uint64, startTime, endTime time.Time, ...) ([]*Event, error)
  • func (d *DB) Start() error
  • func (d *DB) Stop() error
  • func (d *DB) WriteData(publicKey string, data []byte) error
• type Event

Functions

func MigrateDown

func MigrateDown(db *sql.DB, steps int, logger kitlog.Logger) error

MigrateDown attempts to run down migrations against Postgres. It takes as parameters an sql.DB instance, the number of steps to run, and a logger instance. Migrations are loaded from a bindata generated module that is compiled into the binary.

func MigrateDownAll

func MigrateDownAll(db *sql.DB, logger kitlog.Logger) error

MigrateDownAll attempts to run all down migrations against Postgres. It takes as parameters an sql.DB instance, and a logger instance. Migrations are loaded from a bindata generated module that is compiled into the binary.

func MigrateUp

func MigrateUp(db *sql.DB, logger kitlog.Logger) error

MigrateUp attempts to run all up migrations against Postgres. Migrations are loaded from a bindata generated module that is compiled into the binary. It takes as parameters an sql.DB instance, and a logger instance.

func NewMigration

func NewMigration(dirName, migrationName string, logger kitlog.Logger) error

NewMigration creates a new pair of files into which an SQL migration should be written. All this is doing is ensuring files created are correctly named.

func Open

func Open(connStr string) (*sqlx.DB, error)

Open takes as input a connection string for a DB, and returns either a sqlx.DB instance or an error.

Types

type Cursor

type Cursor struct {
	EventID   int64     `json:"eventID"`
	Timestamp time.Time `json:"timestamp"`
}

Cursor is an internal type used for serializing or parsing page cursors.

type DB

type DB struct {
	DB *sqlx.DB
	// contains filtered or unexported fields
}

DB is a struct that wraps an sqlx.DB instance that exposes some methods to read and write data.

func NewDB

func NewDB(connStr string, verbose bool, logger kitlog.Logger) *DB

NewDB is a constructor that returns a new DB instance for the given configuration. We pass in a connection string for the database, and in addition we can pass in a verbose flag which causes the binary to output more verbose log information.

func (*DB) DeleteData

func (d *DB) DeleteData(before time.Time, execute bool) error

DeleteData takes as input a timestamp, and after it is executed will have deleted all events in the database from before the submitted time interval for any policy. This function also takes a `execute` parameter. If set to true the delete operation is performed and committed, but if set to false it is executed without committing the transaction. This allows a caller to see how many events would be deleted.

func (*DB) ReadData

func (d *DB) ReadData(publicKey string, pageSize uint64, startTime, endTime time.Time, pageCursor string) ([]*Event, error)

ReadData returns a list of Event types for the given query parameters.

func (*DB) Start

func (d *DB) Start() error

Start connects to the database, and runs any pending up migrations.

func (*DB) Stop

func (d *DB) Stop() error

Stop terminates the DB connection, closing the pool of connections.

func (*DB) WriteData

func (d *DB) WriteData(publicKey string, data []byte) error

WriteData is the function that is responsible for writing data to the actual database. Takes as input a public key representing the policy we are storing data for and a byte slice containing the encrypted data to be persisted.

type Event

type Event struct {
	ID         int64     `db:"id"`
	RecordedAt time.Time `db:"recorded_at"`
	Data       []byte    `db:"data"`
}

Event is a type used to read encrypted events back from the database