anyrow

README

anyrow - fetches generic data row(s) with metadata

Uses pgx.

Documentation

Index

• func FetchColumns(ctx context.Context, conn Querier, tableName string) ([]*pb.ColumnSchema, error)
• func FetchRowSet(ctx context.Context, conn Querier, metadataCacheKey, tableName string, ...) (*pb.RowSet, error)
• func FetchSchemas(ctx context.Context, conn Querier) ([]string, error)
• func FetchTableNames(ctx context.Context, conn Querier, schema string) ([]string, error)
• func FilterLimit(limit int) filterOption
• type PrimaryKeyAndValue
  • func NewPrimaryKeyAndValue(column string, value any) PrimaryKeyAndValue
• type PrimaryKeysAndValues
  • func NewPrimaryKeyAndValues(column string, value ...any) PrimaryKeysAndValues
  • func NewPrimaryKeysAndValues(pairs []PrimaryKeyAndValue) PrimaryKeysAndValues
• type Querier
• type Record
  • func FetchRecords(ctx context.Context, conn Querier, metadataCacheKey, tableName string, ...) ([]Record, error)
  • func FilterRecords(ctx context.Context, conn Querier, metadataCacheKey, tableName string, ...) ([]Record, error)

Functions

func FetchColumns

func FetchColumns(ctx context.Context, conn Querier, tableName string) ([]*pb.ColumnSchema, error)

FetchColumns returns a list of column schemas for a public tablename.

func FetchRowSet

func FetchRowSet(ctx context.Context, conn Querier, metadataCacheKey, tableName string, pkv PrimaryKeysAndValues) (*pb.RowSet, error)

FetchObjects returns a protobuf RowSet for the given list primary key values.

func FetchSchemas

func FetchSchemas(ctx context.Context, conn Querier) ([]string, error)

func FetchTableNames

func FetchTableNames(ctx context.Context, conn Querier, schema string) ([]string, error)

FetchTablenames returns a list of public tablenames.

func FilterLimit

func FilterLimit(limit int) filterOption

Types

type PrimaryKeyAndValue

type PrimaryKeyAndValue struct {
	Column string
	Value  any
}

func NewPrimaryKeyAndValue

func NewPrimaryKeyAndValue(column string, value any) PrimaryKeyAndValue

NewPrimaryKeyAndValue creates a parameter object.

type PrimaryKeysAndValues

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

PrimaryKeysAndValues is a parameter object holding the column name(s) and one or more values.

func NewPrimaryKeyAndValues

func NewPrimaryKeyAndValues(column string, value ...any) PrimaryKeysAndValues

NewPrimaryKeyAndValues creates a parameter object.

func NewPrimaryKeysAndValues

func NewPrimaryKeysAndValues(pairs []PrimaryKeyAndValue) PrimaryKeysAndValues

MewPrimaryKeysAndValues creates a parameter object.

type Querier

type Querier interface {
	Query(ctx context.Context, sql string, args ...any) (pgx.Rows, error)
}

Querier is the interface that is used from a database connection. Known implementations are *pgx.Conn and *pgx.Tx and *pgxpool.Conn.

type Record

type Record map[string]any

Record represents a Table row as a Map.

func FetchRecords

func FetchRecords(ctx context.Context, conn Querier, metadataCacheKey, tableName string, pkv PrimaryKeysAndValues) ([]Record, error)

FetchRecords returns a list of Objects (generic maps) for the given list primary key values.

func FilterRecords

func FilterRecords(ctx context.Context, conn Querier, metadataCacheKey, tableName string, where string, options ...filterOption) ([]Record, error)

FilterRecords queries a table using a WHERE clause. Unless option is given, the limit is 1000.