persistence

Documentation

Index

• Constants
• func Count(ctx context.Context, q sqlx.QueryerContext, query string, params ...any) (int64, error)
• func MapError(err error) error
• func MapKeywordsToListFn(startMark, endMark string) func(item SearchQueryResultItem) SearchQueryResultItem
• func Scan[T any](rows *sqlx.Rows) (T, error)
• func ScanRows[T any](rows *sqlx.Rows) ([]T, error)
• func ScanRowsQueryResult[T any](rows *sqlx.Rows) ([]T, error)
• func ScanRowsQueryResultAndMap[T, K any](rows *sqlx.Rows, mapFn func(entity T) K) ([]K, error)
• type Basis
• type Db
• type DbConfig
  • func (ds DbConfig) DataSourceFull() string
  • func (ds DbConfig) DataSourceNoDb() string
• type DbContainer
  • func NewNilDbContainer(opts ...DbOption) (DbContainer, error)
  • func NewPgDbContainer(ctx context.Context, image string, opts ...DbOption) (DbContainer, error)
• type DbOption
  • func WithDbName(dbName string) DbOption
  • func WithHost(host string) DbOption
  • func WithPassword(password string) DbOption
  • func WithPort(port string) DbOption
  • func WithSslMode(sslMode string) DbOption
  • func WithUser(user string) DbOption
• type Format
• type Index
• type IndexQuery
• type IndexRecord
• type IndexRecordID
  • func (id *IndexRecordID) Decode(s string) error
  • func (id IndexRecordID) Encode() string
• type IndexRecordQuery
• type ModelTx
• type QueryResult
• type SearchQuery
• type SearchQueryResultItem
• type Tags
  • func (t *Tags) Scan(value any) error
  • func (t Tags) Value() (value driver.Value, err error)
• type Tx
• type Vector

Constants

const (
	PqForeignKeyViolationError = pq.ErrorCode("23503")
	PqUniqueViolationError     = pq.ErrorCode("23505")
)

Functions

func Count

func Count(ctx context.Context, q sqlx.QueryerContext, query string, params ...any) (int64, error)

func MapError

func MapError(err error) error

func MapKeywordsToListFn

func MapKeywordsToListFn(startMark, endMark string) func(item SearchQueryResultItem) SearchQueryResultItem

func Scan

func Scan[T any](rows *sqlx.Rows) (T, error)

func ScanRows

func ScanRows[T any](rows *sqlx.Rows) ([]T, error)

func ScanRowsQueryResult

func ScanRowsQueryResult[T any](rows *sqlx.Rows) ([]T, error)

func ScanRowsQueryResultAndMap

func ScanRowsQueryResultAndMap[T, K any](rows *sqlx.Rows, mapFn func(entity T) K) ([]K, error)

Types

type Basis

type Basis json.RawMessage

type Db

type Db interface {
	// NewModelTx creates new ModelTx object
	NewModelTx(ctx context.Context) ModelTx
	// NewTx creates Tx object
	NewTx(ctx context.Context) Tx
}

Db interface exposes

type DbConfig

type DbConfig struct {
	Host     string
	Port     string
	User     string
	Password string
	DbName   string
	SslMode  string
}

func (DbConfig) DataSourceFull

func (ds DbConfig) DataSourceFull() string

func (DbConfig) DataSourceNoDb

func (ds DbConfig) DataSourceNoDb() string

type DbContainer

type DbContainer interface {
	io.Closer
	DbConfig() DbConfig
}

func NewNilDbContainer

func NewNilDbContainer(opts ...DbOption) (DbContainer, error)

func NewPgDbContainer

func NewPgDbContainer(ctx context.Context, image string, opts ...DbOption) (DbContainer, error)

NewPgDbContainer runs pg database in a docker container.

type DbOption

type DbOption func(cfg *DbConfig)

func WithDbName

func WithDbName(dbName string) DbOption

func WithHost

func WithHost(host string) DbOption

func WithPassword

func WithPassword(password string) DbOption

func WithPort

func WithPort(port string) DbOption

func WithSslMode

func WithSslMode(sslMode string) DbOption

func WithUser

func WithUser(user string) DbOption

type Format

type Format struct {
	ID        string    `db:"id"`
	Basis     Basis     `db:"basis"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

type Index

type Index struct {
	ID        string    `db:"id"`
	Format    string    `db:"format"`
	Tags      Tags      `db:"tags"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

type IndexQuery

type IndexQuery struct {
	Format        string
	Tags          Tags
	CreatedAfter  time.Time
	CreatedBefore time.Time
	FromID        string
	Limit         int
}

type IndexRecord

type IndexRecord struct {
	ID        string    `db:"id"`
	IndexID   string    `db:"index_id"`
	Segment   string    `db:"segment"`
	Vector    Vector    `db:"vector"`
	CreatedAt time.Time `db:"created_at"`
	UpdatedAt time.Time `db:"updated_at"`
}

type IndexRecordID

type IndexRecordID struct {
	IndexID  string `json:"index_id"`
	RecordID string `json:"record_id"`
}

func (*IndexRecordID) Decode

func (id *IndexRecordID) Decode(s string) error

func (IndexRecordID) Encode

func (id IndexRecordID) Encode() string

type IndexRecordQuery

type IndexRecordQuery struct {
	IndexIDs      []string
	CreatedAfter  time.Time
	CreatedBefore time.Time
	FromID        string
	Limit         int
}

type ModelTx

type ModelTx interface {
	Tx

	// CreateFormat creates format entry
	CreateFormat(format Format) (Format, error)
	// GetFormat retrieves format entry by ID
	GetFormat(ID string) (Format, error)
	// DeleteFormat deletes format entry by ID (only if not referenced)
	DeleteFormat(ID string) error
	// ListFormats lists all the existing format entries
	ListFormats() ([]Format, error)

	// CreateIndex creates index entry based on source ID
	CreateIndex(index Index) (Index, error)
	// GetIndex retrieves index info by ID
	GetIndex(ID string) (Index, error)
	// UpdateIndex updates index info
	UpdateIndex(index Index) error
	// DeleteIndex deletes index entry and all the related records
	DeleteIndex(ID string) error
	// QueryIndexes lists query matching index entries
	QueryIndexes(query IndexQuery) (QueryResult[Index, string], error)

	// UpsertIndexRecords creates or updates index record entries
	UpsertIndexRecords(records ...IndexRecord) error
	// GetIndexRecord retrieves index record entry
	GetIndexRecord(ID, indexID string) (IndexRecord, error)
	// UpdateIndexRecord updates index record
	UpdateIndexRecord(record IndexRecord) error
	// DeleteIndexRecords deletes index record entries
	DeleteIndexRecords(records ...IndexRecord) (int, error)
	// QueryIndexRecords lists query matching index record entries
	QueryIndexRecords(query IndexRecordQuery) (QueryResult[IndexRecord, string], error)

	// Search performs search across existing index records
	// the query string should be formed in accordance with the query
	// language of the underlying search engine
	Search(query SearchQuery) (QueryResult[SearchQueryResultItem, string], error)
}

ModelTx provides a transaction with some methods for accessing to the Model objects

type QueryResult

type QueryResult[T any, N any] struct {
	Items  []T
	NextID N
	Total  int64
}

type SearchQuery

type SearchQuery struct {
	IndexIDs     []string
	Query        string // underlying search engine query
	Tags         Tags   // index tags
	Distinct     bool   // if true, returns at most 1 result per index
	OrderByScore bool   // if true, sorts the result by the result relevancy score
	FromID       string
	Offset       int
	Limit        int
}

type SearchQueryResultItem

type SearchQueryResultItem struct {
	IndexRecord
	MatchedKeywordsList []string // mapped manually after filling the MatchedKeywords
	MatchedKeywords     string   `db:"matched_keywords"`
	Score               float32  `db:"score"`
}

type Tags

type Tags map[string]string

func (*Tags) Scan

func (t *Tags) Scan(value any) error

func (Tags) Value

func (t Tags) Value() (value driver.Value, err error)

type Tx

type Tx interface {
	// MustBegin starts the transaction
	MustBegin()
	// MustBeginSerializable starts new transaction with Serializable isolation level
	MustBeginSerializable()
	// Commit commits the changes made within the transaction
	Commit() error
	// Rollback rolls the transaction back
	Rollback() error
	// ExecScript allows to execute the sql statements from the file provided
	ExecScript(sqlScript string) error
}

Tx interface describes an abstract DB transaction.

type Vector

type Vector json.RawMessage