postgres

Documentation

Overview

Package postgres provides a PostgreSQL pgvector-backed Reliquary index.

Index

• type Config
• type Index
  • func New(pool *pgxpool.Pool, cfg Config) (*Index, error)
  • func (i *Index) DeleteDocument(ctx context.Context, documentID string) error
  • func (i *Index) Migrate(ctx context.Context) error
  • func (i *Index) ReplaceDocuments(ctx context.Context, replacements []indexcontract.DocumentReplacement) error
  • func (i *Index) Reset(ctx context.Context) error
  • func (i *Index) Search(ctx context.Context, query indexcontract.IndexQuery) ([]*retrieval.Result, error)
  • func (i *Index) Upsert(ctx context.Context, items []*retrieval.Result) error

Types

type Config

type Config struct {
	Table string
}

Config controls PostgreSQL index storage. Migrate must be called explicitly before the index is used.

type Index

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

Index stores retrieval candidates in a caller-owned PostgreSQL pool.

func New

func New(pool *pgxpool.Pool, cfg Config) (*Index, error)

New validates configuration without connecting or performing migrations.

func (*Index) DeleteDocument

func (i *Index) DeleteDocument(ctx context.Context, documentID string) error

DeleteDocument transactionally removes all results for a document.

func (*Index) Migrate

func (i *Index) Migrate(ctx context.Context) error

Migrate idempotently creates retrieval-owned PostgreSQL schema. It is never called implicitly by New or data operations.

func (*Index) ReplaceDocuments

func (i *Index) ReplaceDocuments(ctx context.Context, replacements []indexcontract.DocumentReplacement) error

ReplaceDocuments atomically replaces complete document revisions. The table lock serializes retained-corpus dimension and identity discovery with all other writers.

func (*Index) Reset

func (i *Index) Reset(ctx context.Context) error

Reset destructively removes all indexed results.

func (*Index) Search

func (i *Index) Search(ctx context.Context, query indexcontract.IndexQuery) ([]*retrieval.Result, error)

Search retrieves candidates in PostgreSQL and performs final Reliquary scoring over only that bounded candidate set.

func (*Index) Upsert

func (i *Index) Upsert(ctx context.Context, items []*retrieval.Result) error

Upsert transactionally inserts or overwrites results by ID.