persistence

Documentation

Index

• Constants
• func CheckVector(basis Basis, vector Vector) error
• func NewMigration(driverName, dataSourceName string) *migration
• type Basis
  • func NewBasis(dims ...Dimension) (Basis, error)
  • func (b *Basis) Scan(value any) error
  • func (b Basis) Value() (value driver.Value, err error)
• type Component
  • func FromNumber(f float64) Component
  • func FromString(s string) Component
• type Db
  • func NewDb(driverName, dataSourceName string) Db
• type Dimension
• type Format
• type Index
• type IndexQuery
• type IndexRecord
• type IndexRecordQuery
• type ModelTx
• type QueryResult
• type SearchQuery
• type SearchQueryResultItem
• type SqlTestSuite
  • func (s *SqlTestSuite) AfterTest(suiteName, testName string)
  • func (s *SqlTestSuite) BeforeTest(suiteName, testName string)
  • func (s *SqlTestSuite) GetDb() Db
  • func (s *SqlTestSuite) SetupSuite()
  • func (s *SqlTestSuite) TearDownSuite()
• type Tags
  • func (t *Tags) Scan(value any) error
  • func (t Tags) Value() (value driver.Value, err error)
• type Tx
• type Type
  • func DType(c Component) Type
• type Vector
  • func NewVector(basis Basis, comps ...Component) (Vector, error)
  • func (v *Vector) Scan(value any) error
  • func (v Vector) Value() (value driver.Value, err error)

Constants

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

Functions

func CheckVector

func CheckVector(basis Basis, vector Vector) error

func NewMigration

func NewMigration(driverName, dataSourceName string) *migration

Types

type Basis

type Basis []Dimension

func NewBasis

func NewBasis(dims ...Dimension) (Basis, error)

func (*Basis) Scan

func (b *Basis) Scan(value any) error

func (Basis) Value

func (b Basis) Value() (value driver.Value, err error)

type Component

type Component any

func FromNumber

func FromNumber(f float64) Component

func FromString

func FromString(s string) Component

type Db

type Db interface {
	// NewModelTx creates new ModelTx object
	NewModelTx() ModelTx
	// NewTx creates Tx object
	NewTx() Tx
}

Db interface exposes

func NewDb

func NewDb(driverName, dataSourceName string) Db

NewDb creates new db object

type Dimension

type Dimension struct {
	Name string `json:"name"`
	Type Type   `json:"type"`
	Min  int64  `json:"min"`
	Max  int64  `json:"max"`
}

type Format

type Format struct {
	ID        string    `db:"id"`
	Name      string    `db:"name"`
	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 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) (string, error)
	// GetFormat retrieves format entry by name
	GetFormat(name string) (Format, error)
	// DeleteFormat deletes format entry by name (only if not referenced)
	DeleteFormat(name string) error
	// ListFormats lists all the existing format entries
	ListFormats() ([]Format, error)

	// CreateIndex creates index entry based on source ID
	CreateIndex(index Index) (string, 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)

	// CreateIndexRecord creates index record entry
	CreateIndexRecord(record IndexRecord) (string, error)
	// GetIndexRecord retrieves index record entry by ID
	GetIndexRecord(ID string) (IndexRecord, error)
	// UpdateIndexRecord updates index record
	UpdateIndexRecord(record IndexRecord) error
	// DeleteIndexRecord deletes index record by ID
	DeleteIndexRecord(ID string) error
	// QueryIndexRecords lists query matching index record entries
	QueryIndexRecords(query IndexRecordQuery) (QueryResult[IndexRecord, string], error)

	// Search performs full text search across existing index records
	// the query string should be formed in accordance with the pgroonga manual
	// for the `&@~` operator (https://pgroonga.github.io/reference/operators/query-v2.html)
	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
	FromID   string
	Limit    int
}

type SearchQueryResultItem

type SearchQueryResultItem struct {
	IndexRecord
	Score int
}

type SqlTestSuite

type SqlTestSuite struct {
	Dir string
	suite.Suite
	// contains filtered or unexported fields
}

SqlTestSuite struct used to wrap all related database connection stuff into one suite

func (*SqlTestSuite) AfterTest

func (s *SqlTestSuite) AfterTest(suiteName, testName string)

func (*SqlTestSuite) BeforeTest

func (s *SqlTestSuite) BeforeTest(suiteName, testName string)

func (*SqlTestSuite) GetDb

func (s *SqlTestSuite) GetDb() Db

func (*SqlTestSuite) SetupSuite

func (s *SqlTestSuite) SetupSuite()

func (*SqlTestSuite) TearDownSuite

func (s *SqlTestSuite) TearDownSuite()

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(ctx context.Context)
	// 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 Type

type Type string

const (
	DTypeNumber Type = "number"
	DTypeString Type = "string"
)

func DType

func DType(c Component) Type

type Vector

type Vector []Component

func NewVector

func NewVector(basis Basis, comps ...Component) (Vector, error)

func (*Vector) Scan

func (v *Vector) Scan(value any) error

func (Vector) Value

func (v Vector) Value() (value driver.Value, err error)