document

Jun 20, 2023

Changes in this version

+ const DefaultDocumentIDField

+ const DefaultDocumentMaxNestedFields

+ const DocumentBLOBField

+ const GeneratedDocIDLength

+ const MaxDocumentIDLength

+ var ErrCollectionAlreadyExists = errors.New("collection already exists")

+ var ErrCollectionDoesNotExist = errors.New("collection does not exist")

+ var ErrConflict = errors.New(...)

+ var ErrDocumentNotFound = errors.New("document not found")

+ var ErrFieldAlreadyExists = errors.New("field already exists")

+ var ErrFieldDoesNotExist = errors.New("field does not exist")

+ var ErrIllegalArguments = store.ErrIllegalArguments

+ var ErrLimitedIndexCreation = errors.New("index creation is only supported on empty collections")

+ var ErrMaxLengthExceeded = errors.New("max length exceeded")

+ var ErrMultipleDocumentsFound = errors.New("multiple documents found")

+ var ErrNoMoreDocuments = errors.New("no more documents")

+ var ErrReservedName = errors.New("reserved name")

+ var ErrUnexpectedValue = errors.New("unexpected value")

+ var ErrUnsupportedType = errors.New("unsupported type")

+ type DocumentID []byte

+ func NewDocumentIDFromHexEncodedString(hexEncodedDocID string) (DocumentID, error)

+ func NewDocumentIDFromRawBytes(b []byte) (DocumentID, error)

+ func NewDocumentIDFromTimestamp(timestamp time.Time, txID uint64) DocumentID

+ func NewDocumentIDFromTx(txID uint64) DocumentID

+ func (id DocumentID) EncodeToHexString() string

+ func (id DocumentID) Timestamp() time.Time

+ type DocumentReader interface

+ Close func() error

+ Read func(ctx context.Context) (*protomodel.DocumentAtRevision, error)

+ ReadN func(ctx context.Context, count int) ([]*protomodel.DocumentAtRevision, error)

+ type EncodedDocument struct

+ EncodedDocument []byte

+ KVMetadata *store.KVMetadata

+ Revision uint64

+ TxID uint64

+ type Engine struct

+ func NewEngine(store *store.ImmuStore, opts *Options) (*Engine, error)

+ func (e *Engine) AuditDocument(ctx context.Context, collectionName string, docID DocumentID, desc bool, ...) ([]*protomodel.DocumentAtRevision, error)

+ func (e *Engine) CopyCatalogToTx(ctx context.Context, tx *store.OngoingTx) error

+ func (e *Engine) CountDocuments(ctx context.Context, query *protomodel.Query, offset int64) (int64, error)

+ func (e *Engine) CreateCollection(ctx context.Context, name, documentIdFieldName string, ...) error

+ func (e *Engine) CreateIndex(ctx context.Context, collectionName string, fields []string, isUnique bool) error

+ func (e *Engine) DeleteCollection(ctx context.Context, collectionName string) error

+ func (e *Engine) DeleteDocuments(ctx context.Context, query *protomodel.Query) error

+ func (e *Engine) DeleteIndex(ctx context.Context, collectionName string, fields []string) error

+ func (e *Engine) GetCollection(ctx context.Context, collectionName string) (*protomodel.Collection, error)

+ func (e *Engine) GetCollections(ctx context.Context) ([]*protomodel.Collection, error)

+ func (e *Engine) GetDocuments(ctx context.Context, query *protomodel.Query, offset int64) (DocumentReader, error)

+ func (e *Engine) GetEncodedDocument(ctx context.Context, collectionName string, docID DocumentID, txID uint64) (collectionID uint32, documentIdFieldName string, encodedDoc *EncodedDocument, ...)

+ func (e *Engine) InsertDocument(ctx context.Context, collectionName string, doc *structpb.Struct) (txID uint64, docID DocumentID, err error)

+ func (e *Engine) InsertDocuments(ctx context.Context, collectionName string, docs []*structpb.Struct) (txID uint64, docIDs []DocumentID, err error)

+ func (e *Engine) ReplaceDocuments(ctx context.Context, query *protomodel.Query, doc *structpb.Struct) (revisions []*protomodel.DocumentAtRevision, err error)

+ func (e *Engine) UpdateCollection(ctx context.Context, collectionName string, documentIdFieldName string) error

+ type Options struct

+ func DefaultOptions() *Options

+ func (opts *Options) Validate() error

+ func (opts *Options) WithMaxNestedFields(maxNestedFields int) *Options

+ func (opts *Options) WithPrefix(prefix []byte) *Options