persistence

type Basis json.RawMessage

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

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 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 struct {
	Format        string
	Tags          Tags
	CreatedAfter  time.Time
	CreatedBefore time.Time
	FromID        string
	Limit         int
}

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 struct {
	IndexID  string `json:"index_id"`
	RecordID string `json:"record_id"`
}

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

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) (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)

	// CreateIndexRecords creates index records entries
	CreateIndexRecords(records ...IndexRecord) error
	// GetIndexRecord retrieves index record entry by ID
	GetIndexRecord(ID string) (IndexRecord, error)
	// UpdateIndexRecord updates index record
	UpdateIndexRecord(record IndexRecord) error
	// DeleteIndexRecords deletes index records by IDs
	DeleteIndexRecords(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 groonga manual
	// for the `&@~` operator, useful links:
	// - https://pgroonga.github.io/reference/operators/query-v2.html
	// - https://groonga.org/docs/reference/grn_expr/query_syntax.html
	Search(query SearchQuery) (QueryResult[SearchQueryResultItem, string], error)
}

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

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 struct {
	IndexRecord
	Score int
}

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

type Tags map[string]string

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
}

type Vector json.RawMessage