Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

scio

package module

Go to main page

Versions in this module

v0

v0.0.4

Mar 19, 2026

Changes in this version

+ var ErrInvalidQuery = grub.ErrInvalidQuery

type Catalog

+ Searches func() []Resource

type Registry

+ RegisterSearch func(uri string, search grub.AtomicSearch, opts ...RegistrationOption) error

type Scio

+ func (s *Scio) DeleteDocument(ctx context.Context, uri string) error

+ func (s *Scio) DocumentExists(ctx context.Context, uri string) (bool, error)

+ func (s *Scio) GetDocument(ctx context.Context, uri string) (*grub.AtomicDocument, error)

+ func (s *Scio) IndexDocument(ctx context.Context, uri string, data *atom.Atom) error

+ func (s *Scio) RegisterSearch(uri string, search grub.AtomicSearch, opts ...RegistrationOption) error

+ func (s *Scio) SearchDocuments(ctx context.Context, uri string, search *lucene.Search) ([]grub.AtomicDocument, error)

+ func (s *Scio) Searches() []Resource

+ type SearchOperations interface

+ DeleteDocument func(ctx context.Context, uri string) error

+ DocumentExists func(ctx context.Context, uri string) (bool, error)

+ GetDocument func(ctx context.Context, uri string) (*grub.AtomicDocument, error)

+ IndexDocument func(ctx context.Context, uri string, data *atom.Atom) error

+ SearchDocuments func(ctx context.Context, uri string, search *lucene.Search) ([]grub.AtomicDocument, error)

type Variant

+ const VariantSearch

v0.0.3

Jan 26, 2026

v0.0.2

Jan 25, 2026

Changes in this version

+ var ErrInvalidUUID = errors.New("invalid UUID")

type Catalog

+ Indexes func() []Resource

+ type IndexOperations interface

+ DeleteVector func(ctx context.Context, uri string) error

+ FilterVectors func(ctx context.Context, uri string, filter *vecna.Filter, limit int) ([]grub.AtomicVector, error)

+ GetVector func(ctx context.Context, uri string) (*grub.AtomicVector, error)

+ QueryVectors func(ctx context.Context, uri string, vector []float32, k int, filter *vecna.Filter) ([]grub.AtomicVector, error)

+ SearchVectors func(ctx context.Context, uri string, vector []float32, k int, filter *atom.Atom) ([]grub.AtomicVector, error)

+ UpsertVector func(ctx context.Context, uri string, vector []float32, metadata *atom.Atom) error

+ VectorExists func(ctx context.Context, uri string) (bool, error)

type Registry

+ RegisterIndex func(uri string, index grub.AtomicIndex, opts ...RegistrationOption) error

type Scio

+ func (s *Scio) DeleteVector(ctx context.Context, uri string) error

+ func (s *Scio) FilterVectors(ctx context.Context, uri string, filter *vecna.Filter, limit int) ([]grub.AtomicVector, error)

+ func (s *Scio) GetVector(ctx context.Context, uri string) (*grub.AtomicVector, error)

+ func (s *Scio) Indexes() []Resource

+ func (s *Scio) QueryVectors(ctx context.Context, uri string, vector []float32, k int, filter *vecna.Filter) ([]grub.AtomicVector, error)

+ func (s *Scio) RegisterIndex(uri string, index grub.AtomicIndex, opts ...RegistrationOption) error

+ func (s *Scio) SearchVectors(ctx context.Context, uri string, vector []float32, k int, filter *atom.Atom) ([]grub.AtomicVector, error)

+ func (s *Scio) UpsertVector(ctx context.Context, uri string, vector []float32, metadata *atom.Atom) error

+ func (s *Scio) VectorExists(ctx context.Context, uri string) (bool, error)

type Variant

+ const VariantIndex

v0.0.1

Jan 24, 2026

Changes in this version

+ var ErrConflict = grub.ErrConflict

+ var ErrConstraint = grub.ErrConstraint

+ var ErrDuplicate = grub.ErrDuplicate

+ var ErrInvalidKey = grub.ErrInvalidKey

+ var ErrInvalidURI = errors.New("invalid URI")

+ var ErrKeyNotExpected = errors.New("key not expected")

+ var ErrKeyRequired = errors.New("key required")

+ var ErrNotFound = grub.ErrNotFound

+ var ErrReadOnly = grub.ErrReadOnly

+ var ErrResourceExists = errors.New("resource already exists")

+ var ErrResourceNotFound = errors.New("resource not found")

+ var ErrTTLNotSupported = grub.ErrTTLNotSupported

+ var ErrUnknownVariant = errors.New("unknown variant")

+ var ErrVariantMismatch = errors.New("variant mismatch")

+ type Catalog interface

+ Buckets func() []Resource

+ Databases func() []Resource

+ FindByField func(field string) []Resource

+ FindBySpec func(spec atom.Spec) []Resource

+ Related func(uri string) []Resource

+ Sources func() []Resource

+ Spec func(uri string) (atom.Spec, error)

+ Stores func() []Resource

+ type Metadata struct

+ Description string

+ Tags map[string]string

+ Version string

+ type Operations interface

+ Delete func(ctx context.Context, uri string) error

+ Exists func(ctx context.Context, uri string) (bool, error)

+ Get func(ctx context.Context, uri string) (*atom.Atom, error)

+ Put func(ctx context.Context, uri string, obj *grub.AtomicObject) error

+ Query func(ctx context.Context, uri string, stmt edamame.QueryStatement, ...) ([]*atom.Atom, error)

+ Select func(ctx context.Context, uri string, stmt edamame.SelectStatement, ...) (*atom.Atom, error)

+ Set func(ctx context.Context, uri string, data *atom.Atom) error

+ SetWithTTL func(ctx context.Context, uri string, data *atom.Atom, ttl time.Duration) error

+ type RegistrationOption func(*registrationConfig)

+ func WithDescription(desc string) RegistrationOption

+ func WithTag(key, value string) RegistrationOption

+ func WithVersion(ver string) RegistrationOption

+ type Registry interface

+ RegisterBucket func(uri string, bucket grub.AtomicBucket, opts ...RegistrationOption) error

+ RegisterDatabase func(uri string, db grub.AtomicDatabase, opts ...RegistrationOption) error

+ RegisterStore func(uri string, store grub.AtomicStore, opts ...RegistrationOption) error

+ type Resource struct

+ Metadata Metadata

+ Name string

+ Spec atom.Spec

+ URI string

+ Variant Variant

+ type Scio struct

+ func New() *Scio

+ func (s *Scio) Buckets() []Resource

+ func (s *Scio) Databases() []Resource

+ func (s *Scio) Delete(ctx context.Context, uri string) error

+ func (s *Scio) Exists(ctx context.Context, uri string) (bool, error)

+ func (s *Scio) FindByField(field string) []Resource

+ func (s *Scio) FindBySpec(spec atom.Spec) []Resource

+ func (s *Scio) Get(ctx context.Context, uri string) (*atom.Atom, error)

+ func (s *Scio) Put(ctx context.Context, uri string, obj *grub.AtomicObject) error

+ func (s *Scio) Query(ctx context.Context, uri string, stmt edamame.QueryStatement, ...) ([]*atom.Atom, error)

+ func (s *Scio) RegisterBucket(uri string, bucket grub.AtomicBucket, opts ...RegistrationOption) error

+ func (s *Scio) RegisterDatabase(uri string, db grub.AtomicDatabase, opts ...RegistrationOption) error

+ func (s *Scio) RegisterStore(uri string, store grub.AtomicStore, opts ...RegistrationOption) error

+ func (s *Scio) Related(uri string) []Resource

+ func (s *Scio) Resource(uri string) *Resource

+ func (s *Scio) Select(ctx context.Context, uri string, stmt edamame.SelectStatement, ...) (*atom.Atom, error)

+ func (s *Scio) Set(ctx context.Context, uri string, data *atom.Atom) error

+ func (s *Scio) SetWithTTL(ctx context.Context, uri string, data *atom.Atom, ttl time.Duration) error

+ func (s *Scio) Sources() []Resource

+ func (s *Scio) Spec(uri string) (atom.Spec, error)

+ func (s *Scio) Stores() []Resource

+ type URI struct

+ Key string

+ Resource string

+ Variant Variant

+ func ParseURI(raw string) (*URI, error)

+ func (u *URI) ResourceURI() string

+ func (u *URI) String() string

+ type Variant string

+ const VariantBucket

+ const VariantDatabase

+ const VariantStore