database

Documentation

Overview

Package database provides the database access functions and schema.

Index

• Variables
• func CreateExtendedTable(ctx context.Context, tx *sql.Tx, object ExtendedTable) (int64, error)
• func DeleteExtendedTable(ctx context.Context, tx *sql.Tx, key string) error
• func ExtendedTableExists(ctx context.Context, tx *sql.Tx, key string) (bool, error)
• func GetExtendedTableID(ctx context.Context, tx *sql.Tx, key string) (int64, error)
• func UpdateExtendedTable(ctx context.Context, tx *sql.Tx, key string, object ExtendedTable) error
• type ExtendedTable
  • func GetExtendedTable(ctx context.Context, tx *sql.Tx, key string) (*ExtendedTable, error)
  • func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTableFilter) ([]ExtendedTable, error)
• type ExtendedTableFilter

Variables

var SchemaExtensions = []db.Update{
	schemaAppend1,
	schemaAppend2,
}

SchemaExtensions is a list of schema extensions that can be passed to the MicroCluster daemon. Each entry will increase the database schema version by one, and will be applied after internal schema updates.

Functions

func CreateExtendedTable

func CreateExtendedTable(ctx context.Context, tx *sql.Tx, object ExtendedTable) (int64, error)

CreateExtendedTable adds a new extended_table to the database.

func DeleteExtendedTable

func DeleteExtendedTable(ctx context.Context, tx *sql.Tx, key string) error

DeleteExtendedTable deletes the extended_table matching the given key parameters.

func ExtendedTableExists

func ExtendedTableExists(ctx context.Context, tx *sql.Tx, key string) (bool, error)

ExtendedTableExists checks if a extended_table with the given key exists.

func GetExtendedTableID

func GetExtendedTableID(ctx context.Context, tx *sql.Tx, key string) (int64, error)

GetExtendedTableID return the ID of the extended_table with the given key.

func UpdateExtendedTable

func UpdateExtendedTable(ctx context.Context, tx *sql.Tx, key string, object ExtendedTable) error

UpdateExtendedTable updates the extended_table matching the given key parameters.

Types

type ExtendedTable

type ExtendedTable struct {
	ID    int
	Key   string `db:"primary=yes"`
	Value string
}

ExtendedTable is an example of a database table. In this case named `extended_table`.

func GetExtendedTable

func GetExtendedTable(ctx context.Context, tx *sql.Tx, key string) (*ExtendedTable, error)

GetExtendedTable returns the extended_table with the given key.

func GetExtendedTables

func GetExtendedTables(ctx context.Context, tx *sql.Tx, filters ...ExtendedTableFilter) ([]ExtendedTable, error)

GetExtendedTables returns all available extended_tables.

type ExtendedTableFilter

type ExtendedTableFilter struct {
	Key *string
}

ExtendedTableFilter is used for filtering fields on database fetches. In this case we will only support filtering by Key.