database

Documentation

Overview

Package database provides a portable database API with cross-cutting concerns.

Index

• type Database
  • func NewDatabase(d driver.Database, opts ...Option) *Database
  • func (db *Database) BatchGetItems(ctx context.Context, table string, keys []map[string]any) ([]map[string]any, error)
  • func (db *Database) BatchPutItems(ctx context.Context, table string, items []map[string]any) error
  • func (db *Database) CreateIndex(ctx context.Context, table string, cfg driver.GSIConfig) (*driver.IndexInfo, error)
  • func (db *Database) CreateTable(ctx context.Context, config driver.TableConfig) error
  • func (db *Database) DeleteIndex(ctx context.Context, table, indexName string) error
  • func (db *Database) DeleteItem(ctx context.Context, table string, key map[string]any) error
  • func (db *Database) DeleteTable(ctx context.Context, name string) error
  • func (db *Database) DescribeIndex(ctx context.Context, table, indexName string) (*driver.IndexInfo, error)
  • func (db *Database) DescribeTTL(ctx context.Context, table string) (*driver.TTLConfig, error)
  • func (db *Database) DescribeTable(ctx context.Context, name string) (*driver.TableConfig, error)
  • func (db *Database) GetItem(ctx context.Context, table string, key map[string]any) (map[string]any, error)
  • func (db *Database) GetStreamRecords(ctx context.Context, table string, limit int, token string) (*driver.StreamIterator, error)
  • func (db *Database) ListIndexes(ctx context.Context, table string) ([]driver.IndexInfo, error)
  • func (db *Database) ListTables(ctx context.Context) ([]string, error)
  • func (db *Database) ListTagsOfResource(ctx context.Context, table string) (map[string]string, error)
  • func (db *Database) PutItem(ctx context.Context, table string, item map[string]any) error
  • func (db *Database) Query(ctx context.Context, input driver.QueryInput) (*driver.QueryResult, error)
  • func (db *Database) Scan(ctx context.Context, input driver.ScanInput) (*driver.QueryResult, error)
  • func (db *Database) TagResource(ctx context.Context, table string, tags map[string]string) error
  • func (db *Database) TransactWriteItems(ctx context.Context, table string, puts []map[string]any, ...) error
  • func (db *Database) UntagResource(ctx context.Context, table string, tagKeys []string) error
  • func (db *Database) UpdateItem(ctx context.Context, input driver.UpdateItemInput) (map[string]any, error)
  • func (db *Database) UpdateStreamConfig(ctx context.Context, table string, cfg driver.StreamConfig) error
  • func (db *Database) UpdateTTL(ctx context.Context, table string, cfg driver.TTLConfig) error
• type Option
  • func WithErrorInjection(i *inject.Injector) Option
  • func WithLatency(dur time.Duration) Option
  • func WithMetrics(m *metrics.Collector) Option
  • func WithRateLimiter(l *ratelimit.Limiter) Option
  • func WithRecorder(r *recorder.Recorder) Option

Types

type Database

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

Database is the portable database type wrapping a driver.

func NewDatabase

func NewDatabase(d driver.Database, opts ...Option) *Database

NewDatabase creates a new portable Database.

func (*Database) BatchGetItems

func (db *Database) BatchGetItems(ctx context.Context, table string, keys []map[string]any) ([]map[string]any, error)

func (*Database) BatchPutItems

func (db *Database) BatchPutItems(ctx context.Context, table string, items []map[string]any) error

func (*Database) CreateIndex

func (db *Database) CreateIndex(ctx context.Context, table string, cfg driver.GSIConfig) (*driver.IndexInfo, error)

func (*Database) CreateTable

func (db *Database) CreateTable(ctx context.Context, config driver.TableConfig) error

func (*Database) DeleteIndex

func (db *Database) DeleteIndex(ctx context.Context, table, indexName string) error

func (*Database) DeleteItem

func (db *Database) DeleteItem(ctx context.Context, table string, key map[string]any) error

func (*Database) DeleteTable

func (db *Database) DeleteTable(ctx context.Context, name string) error

func (*Database) DescribeIndex

func (db *Database) DescribeIndex(ctx context.Context, table, indexName string) (*driver.IndexInfo, error)

func (*Database) DescribeTTL

func (db *Database) DescribeTTL(ctx context.Context, table string) (*driver.TTLConfig, error)

func (*Database) DescribeTable

func (db *Database) DescribeTable(ctx context.Context, name string) (*driver.TableConfig, error)

func (*Database) GetItem

func (db *Database) GetItem(ctx context.Context, table string, key map[string]any) (map[string]any, error)

func (*Database) GetStreamRecords

func (db *Database) GetStreamRecords(
	ctx context.Context, table string, limit int, token string,
) (*driver.StreamIterator, error)

func (*Database) ListIndexes

func (db *Database) ListIndexes(ctx context.Context, table string) ([]driver.IndexInfo, error)

func (*Database) ListTables

func (db *Database) ListTables(ctx context.Context) ([]string, error)

func (*Database) ListTagsOfResource

func (db *Database) ListTagsOfResource(ctx context.Context, table string) (map[string]string, error)

func (*Database) PutItem

func (db *Database) PutItem(ctx context.Context, table string, item map[string]any) error

func (*Database) Query

func (db *Database) Query(ctx context.Context, input driver.QueryInput) (*driver.QueryResult, error)

func (*Database) Scan

func (db *Database) Scan(ctx context.Context, input driver.ScanInput) (*driver.QueryResult, error)

func (*Database) TagResource

func (db *Database) TagResource(ctx context.Context, table string, tags map[string]string) error

func (*Database) TransactWriteItems

func (db *Database) TransactWriteItems(
	ctx context.Context, table string, puts []map[string]any, deletes []map[string]any,
) error

func (*Database) UntagResource

func (db *Database) UntagResource(ctx context.Context, table string, tagKeys []string) error

func (*Database) UpdateItem

func (db *Database) UpdateItem(ctx context.Context, input driver.UpdateItemInput) (map[string]any, error)

func (*Database) UpdateStreamConfig

func (db *Database) UpdateStreamConfig(ctx context.Context, table string, cfg driver.StreamConfig) error

func (*Database) UpdateTTL

func (db *Database) UpdateTTL(ctx context.Context, table string, cfg driver.TTLConfig) error

type Option

type Option func(*Database)

Option configures a portable Database.

func WithErrorInjection

func WithErrorInjection(i *inject.Injector) Option

func WithLatency

func WithLatency(dur time.Duration) Option

func WithMetrics

func WithMetrics(m *metrics.Collector) Option

func WithRateLimiter

func WithRateLimiter(l *ratelimit.Limiter) Option

func WithRecorder

func WithRecorder(r *recorder.Recorder) Option