latticedb

package module

Go to main page

Versions in this module

v0

v0.6.0

Sep 6, 2026

Changes in this version

type DB

+ func (db *DB) OperationalStats() (OperationalStats, error)

+ type OperationalStats struct

+ ActiveSnapshots uint64

+ ActiveTransactions uint64

+ ActiveWriterWaits uint64

+ OldestSnapshotAge time.Duration

+ OldestTransactionAge time.Duration

+ OldestWriterWaitAge time.Duration

+ RetainedGenerations uint64

+ RetainedLogicalBytes uint64

+ WriterWaits uint64

v0.5.2

Sep 5, 2026

v0.5.1

Sep 5, 2026

v0.5.0

Sep 5, 2026

Changes in this version

+ var ErrCSVGenerationPruningUnsupported = exporter.ErrCSVGenerationPruningUnsupported

+ var ErrExportOutputLimit = exporter.ErrOutputLimit

+ func DumpContextWithOptions(ctx context.Context, dbPath string, opts ExportOptions) ([]byte, error)

+ func ExportContextWithOptions(ctx context.Context, dbPath string, format ExportFormat, outputPath string, ...) ([]byte, error)

+ func ExportFileContextWithOptions(ctx context.Context, dbPath string, format ExportFormat, outputPath string, ...) error

+ func PruneCSVGenerationsContext(ctx context.Context, manifestPath string, retention CSVGenerationRetention) (int, error)

+ type CSVGenerationLease struct

+ EdgesPath string

+ Generation string

+ NodesPath string

+ func OpenCSVGenerationContext(ctx context.Context, manifestPath string) (*CSVGenerationLease, error)

+ func (lease *CSVGenerationLease) Close() error

+ type CSVGenerationRetention struct

+ KeepLatest uint

+ MinAge time.Duration

type DB

+ func (db *DB) BeginWriteContext(ctx context.Context) (*Tx, error)

+ func (db *DB) CheckpointContext(ctx context.Context) error

+ func (db *DB) CloseContext(ctx context.Context) error

+ func (db *DB) CreateEdgePropertyIndexContext(ctx context.Context, edgeType, property string) error

+ func (db *DB) CreateNodePropertyIndexContext(ctx context.Context, label, property string) error

+ func (db *DB) DumpContextWithOptions(ctx context.Context, opts ExportOptions) ([]byte, error)

+ func (db *DB) DumpToContextWithOptions(ctx context.Context, output io.Writer, opts ExportOptions) error

+ func (db *DB) ExportContextWithOptions(ctx context.Context, format ExportFormat, outputPath string, ...) ([]byte, error)

+ func (db *DB) ExportFileContextWithOptions(ctx context.Context, format ExportFormat, outputPath string, ...) error

+ func (db *DB) ExportToContextWithOptions(ctx context.Context, format ExportFormat, output io.Writer, opts ExportOptions) error

+ func (db *DB) GenerationRetentionStats() (GenerationRetentionStats, error)

+ type ExportOptions struct

+ MaxBytes uint64

+ MaxRecords uint64

+ type GenerationRetentionStats struct

+ ActiveLeases uint64

+ ActiveSnapshotLeases uint64

+ OldestLeaseAge time.Duration

+ RetainedGenerations uint64

+ RetainedLogicalBytes uint64

type OpenOptions

+ MaxGenerationLeases uint64

+ MaxRetainedGenerationLogicalBytes uint64

+ type PersistenceCapabilities struct

+ DirectorySync bool

+ FileLocking bool

+ FullDurability bool

+ LinkIdentityProtection bool

+ func PlatformPersistenceCapabilities() PersistenceCapabilities

v0.4.0

Sep 4, 2026

v0.3.0

Sep 3, 2026

Changes in this version

+ func ExportFile(dbPath string, format ExportFormat, outputPath string) error

+ func ExportFileContext(ctx context.Context, dbPath string, format ExportFormat, outputPath string) error

type DB

+ func (db *DB) ChangesContext(ctx context.Context, afterSequence uint64, opts StreamReadOptions) (StreamReadResult, error)

+ func (db *DB) ExportFile(format ExportFormat, outputPath string) error

+ func (db *DB) ExportFileContext(ctx context.Context, format ExportFormat, outputPath string) error

+ func (db *DB) ReadStreamContext(ctx context.Context, stream string, afterSequence uint64, ...) (StreamReadResult, error)

type OpenOptions

+ RecoveryMaxDecodedBytes uint64

+ RecoveryMaxFrames uint64

+ RecoveryMaxWork uint64

+ type StreamReadOptions struct

+ Limit uint

+ MaxBytes uint64

+ type StreamReadResult struct

+ ByteLimited bool

+ LastSequence uint64

+ Records []StreamRecord

v0.2.1

Aug 31, 2026

v0.2.0

Aug 31, 2026

v0.1.1

Aug 31, 2026

Changes in this version

type OpenOptions

+ ChangefeedMaxBytes uint64

v0.1.0

Aug 30, 2026

Changes in this version

+ const EmbeddingAPIFormatOllama

+ const EmbeddingAPIFormatOpenAI

+ var ErrAlreadyExists = engine.ErrAlreadyExists

+ var ErrCommitOutcomeUnknown = engine.ErrCommitOutcomeUnknown

+ var ErrDatabaseClosed = engine.ErrDatabaseClosed

+ var ErrDatabaseLayoutConflict = engine.ErrDatabaseLayoutConflict

+ var ErrDatabaseLocked = engine.ErrDatabaseLocked

+ var ErrEmbeddingClosed = errors.New("embedding client is closed")

+ var ErrInactiveTx = engine.ErrInactiveTx

+ var ErrInvalidArgument = engine.ErrInvalidArgument

+ var ErrManagedTransaction = engine.ErrManagedTransaction

+ var ErrReadOnly = engine.ErrReadOnly

+ var ErrReadOnlyDatabase = ErrReadOnly

+ var ErrReadOnlyTx = ErrReadOnly

+ var ErrRecoveryRequired = engine.ErrRecoveryRequired

+ var ErrResourceLimit = engine.ErrResourceLimit

+ var ErrSnapshotActive = engine.ErrSnapshotActive

+ var ErrTransactionsActive = engine.ErrTransactionsActive

+ var ErrUnsupportedOption = engine.ErrUnsupportedOption

+ var ErrVectorIndexMaintenanceRequired = engine.ErrVectorIndexMaintenanceRequired

+ var ErrWriteConflict = engine.ErrWriteConflict

+ var ErrWriteTxActive = engine.ErrWriteTxActive

+ func Dump(dbPath string) ([]byte, error)

+ func DumpContext(ctx context.Context, dbPath string) ([]byte, error)

+ func Export(dbPath string, format ExportFormat, outputPath string) ([]byte, error)

+ func ExportContext(ctx context.Context, dbPath string, format ExportFormat, outputPath string) ([]byte, error)

+ func HashEmbed(text string, dimensions uint16) ([]float32, error)

+ func SimulateCrash(dbPath string) error

+ func Version() string

+ type CreateEdgeOptions struct

+ Properties map[string]Value

+ type CreateNodeOptions struct

+ Labels []string

+ Properties map[string]Value

+ type DB struct

+ func Deserialize(data []byte, opts OpenOptions) (*DB, error)

+ func Open(path string, opts OpenOptions) (*DB, error)

+ func OpenContext(ctx context.Context, path string, opts OpenOptions) (*DB, error)

+ func (db *DB) Begin(readOnly bool) (*Tx, error)

+ func (db *DB) BeginRead() (*Tx, error)

+ func (db *DB) BeginSnapshot() (*Snapshot, error)

+ func (db *DB) BeginWrite() (*Tx, error)

+ func (db *DB) CacheClear() error

+ func (db *DB) CacheStats() (QueryCacheStats, error)

+ func (db *DB) Changes(afterSequence uint64, limit uint, timeoutMS uint32) ([]StreamRecord, error)

+ func (db *DB) Checkpoint() error

+ func (db *DB) Close() error

+ func (db *DB) CreateEdgePropertyIndex(edgeType, property string) error

+ func (db *DB) CreateNodePropertyIndex(label, property string) error

+ func (db *DB) DropEdgePropertyIndex(edgeType, property string) error

+ func (db *DB) DropNodePropertyIndex(label, property string) error

+ func (db *DB) Dump() ([]byte, error)

+ func (db *DB) DumpContext(ctx context.Context) ([]byte, error)

+ func (db *DB) DumpTo(output io.Writer) error

+ func (db *DB) DumpToContext(ctx context.Context, output io.Writer) error

+ func (db *DB) Export(format ExportFormat, outputPath string) ([]byte, error)

+ func (db *DB) ExportContext(ctx context.Context, format ExportFormat, outputPath string) ([]byte, error)

+ func (db *DB) ExportTo(format ExportFormat, output io.Writer) error

+ func (db *DB) ExportToContext(ctx context.Context, format ExportFormat, output io.Writer) error

+ func (db *DB) FTSSearch(query string, opts FTSSearchOptions) ([]FTSSearchResult, error)

+ func (db *DB) FTSSearchContext(ctx context.Context, query string, opts FTSSearchOptions) ([]FTSSearchResult, error)

+ func (db *DB) FTSSearchFuzzy(query string, opts FTSSearchOptions) ([]FTSSearchResult, error)

+ func (db *DB) GetNodesByLabel(label string) ([]NodeID, error)

+ func (db *DB) GetStreamOffset(stream, consumer string) (uint64, bool, error)

+ func (db *DB) IsOpen() bool

+ func (db *DB) Path() string

+ func (db *DB) Query(query string, params map[string]Value) (QueryResult, error)

+ func (db *DB) QueryContext(ctx context.Context, query string, params map[string]Value, opts QueryOptions) (QueryResult, error)

+ func (db *DB) ReadStream(stream string, afterSequence uint64, limit uint, timeoutMS uint32) ([]StreamRecord, error)

+ func (db *DB) RebuildVectorIndexContext(ctx context.Context) error

+ func (db *DB) Serialize() ([]byte, error)

+ func (db *DB) Update(fn func(*Tx) error) error

+ func (db *DB) UpdateContext(ctx context.Context, fn func(*Tx) error) error

+ func (db *DB) VectorIndexStats() (VectorIndexStats, error)

+ func (db *DB) VectorSearch(vector []float32, opts VectorSearchOptions) ([]VectorSearchResult, error)

+ func (db *DB) VectorSearchContext(ctx context.Context, vector []float32, opts VectorSearchOptions) ([]VectorSearchResult, error)

+ func (db *DB) View(fn func(*Tx) error) error

+ type DurabilityMode uint8

+ const DurabilityFull

+ const DurabilityStandard

+ type Edge struct

+ ID uint64

+ Properties map[string]Value

+ SourceID uint64

+ TargetID uint64

+ Type string

+ type EdgeID = uint64

+ type EmbeddingAPIFormat = latticeembedding.APIFormat

+ type EmbeddingClient struct

+ func NewEmbeddingClient(config EmbeddingConfig) (*EmbeddingClient, error)

+ func (client *EmbeddingClient) Close() error

+ func (client *EmbeddingClient) Embed(text string) ([]float32, error)

+ type EmbeddingConfig = latticeembedding.Config

+ type Error struct

+ Code ErrorCode

+ Message string

+ func (e *Error) Error() string

+ func (e *Error) Is(target error) bool

+ func (e *Error) Unwrap() error

+ type ErrorCode int

+ const ErrorAlreadyExists

+ const ErrorChecksum

+ const ErrorCorruption

+ const ErrorDatabaseLocked

+ const ErrorFull

+ const ErrorGeneric

+ const ErrorIO

+ const ErrorInvalidArg

+ const ErrorLockTimeout

+ const ErrorNotFound

+ const ErrorOK

+ const ErrorOutOfMemory

+ const ErrorReadOnly

+ const ErrorTxnAborted

+ const ErrorUnsupported

+ const ErrorValueTooLarge

+ const ErrorVersionMismatch

+ type ExportFormat string

+ const ExportFormatCSV

+ const ExportFormatDOT

+ const ExportFormatJSON

+ const ExportFormatJSONL

+ type FTSSearchOptions struct

+ Limit uint32

+ MaxBytes uint64

+ MaxDistance uint32

+ MaxWork uint64

+ MinTermLength uint32

+ type FTSSearchResult = engine.FTSSearchResult

+ type Node struct

+ ID uint64

+ Labels []string

+ Properties map[string]Value

+ type NodeID = uint64

+ type OpenOptions struct

+ CacheSizeMB uint32

+ Create bool

+ DerivedIndexBuildMaxLogicalBytes uint64

+ DerivedIndexBuildMaxWork uint64

+ DisableLock bool

+ DisableWAL bool

+ Durability DurabilityMode

+ EnableAdjacencyCache bool

+ EnableVector bool

+ EnableVectors bool

+ EnableWAL bool

+ MaxDatabaseSnapshotBytes uint64

+ PageSize uint32

+ ReadOnly bool

+ VectorDimensions uint16

+ VectorIndexBuildMaxLogicalBytes uint64

+ VectorIndexBuildMaxWork uint64

+ VectorIndexMode VectorIndexMode

+ WALCheckpointThresholdBytes uint64

+ type QueryCacheStats struct

+ Entries uint32

+ Hits uint64

+ Misses uint64

+ type QueryError struct

+ Code ErrorCode

+ DiagnosticCode string

+ Location *QueryErrorLocation

+ Message string

+ Stage QueryErrorStage

+ func (e *QueryError) Error() string

+ func (e *QueryError) Unwrap() error

+ type QueryErrorLocation struct

+ Column uint32

+ Length uint32

+ Line uint32

+ type QueryErrorStage int

+ const QueryErrorStageExecution

+ const QueryErrorStageNone

+ const QueryErrorStageParse

+ const QueryErrorStagePlan

+ const QueryErrorStageSemantic

+ type QueryOptions struct

+ MaxBytes uint64

+ MaxRows uint64

+ MaxWork uint64

+ type QueryResult struct

+ Columns []string

+ Rows []map[string]Value

+ type Snapshot struct

+ func (snapshot *Snapshot) Backup(path string) error

+ func (snapshot *Snapshot) Close() error

+ type StreamRecord = engine.StreamRecord

+ type Tx struct

+ func (tx *Tx) BatchInsert(label string, vectors [][]float32) ([]uint64, error)

+ func (tx *Tx) BatchInsertVectors(label string, vectors [][]float32) ([]uint64, error)

+ func (tx *Tx) Commit() error

+ func (tx *Tx) CommitContext(ctx context.Context) error

+ func (tx *Tx) CreateEdge(sourceID uint64, targetID uint64, edgeType string, opts CreateEdgeOptions) (Edge, error)

+ func (tx *Tx) CreateNode(opts CreateNodeOptions) (Node, error)

+ func (tx *Tx) DeleteAppMetadata(key []byte) error

+ func (tx *Tx) DeleteEdge(sourceID, targetID NodeID, edgeType string) error

+ func (tx *Tx) DeleteNode(nodeID uint64) error

+ func (tx *Tx) FTSIndex(nodeID uint64, text string) error

+ func (tx *Tx) FTSIndexContext(ctx context.Context, nodeID uint64, text string) error

+ func (tx *Tx) FindEdgesByTypeProperty(edgeType, property string, value Value, limit uint) ([]uint64, error)

+ func (tx *Tx) FindNodesByLabelProperty(label, property string, value Value, limit uint) ([]uint64, error)

+ func (tx *Tx) GetAppMetadata(key []byte) ([]byte, bool, error)

+ func (tx *Tx) GetEdgeProperty(edgeID uint64, key string) (Value, bool, error)

+ func (tx *Tx) GetIncomingEdges(nodeID uint64) ([]Edge, error)

+ func (tx *Tx) GetIncomingEdgesByType(nodeID uint64, edgeType string, limit uint) ([]Edge, error)

+ func (tx *Tx) GetNode(nodeID uint64) (*Node, error)

+ func (tx *Tx) GetOutgoingEdges(nodeID uint64) ([]Edge, error)

+ func (tx *Tx) GetOutgoingEdgesByType(nodeID uint64, edgeType string, limit uint) ([]Edge, error)

+ func (tx *Tx) GetProperty(nodeID uint64, key string) (Value, bool, error)

+ func (tx *Tx) IsActive() bool

+ func (tx *Tx) IsReadOnly() bool

+ func (tx *Tx) NodeExists(nodeID uint64) (bool, error)

+ func (tx *Tx) PublishStream(stream, kind string, payload Value) error

+ func (tx *Tx) PublishStreamGetSequence(stream, kind string, payload Value) (uint64, error)

+ func (tx *Tx) PutAppMetadata(key, value []byte) error

+ func (tx *Tx) Query(query string, params map[string]Value) (QueryResult, error)

+ func (tx *Tx) QueryContext(ctx context.Context, query string, params map[string]Value, opts QueryOptions) (QueryResult, error)

+ func (tx *Tx) RemoveEdgeProperty(edgeID uint64, key string) error

+ func (tx *Tx) Rollback() error

+ func (tx *Tx) SetEdgeProperty(edgeID uint64, key string, value Value) error

+ func (tx *Tx) SetProperty(nodeID uint64, key string, value Value) error

+ func (tx *Tx) SetStreamOffset(stream, consumer string, sequence uint64) error

+ func (tx *Tx) SetVector(nodeID uint64, key string, vector []float32) error

+ func (tx *Tx) TrimStream(stream string, beforeSequence uint64) error

+ type Value = any

+ type VectorIndexMode uint8

+ const VectorIndexExactOnly

+ const VectorIndexHNSWSynchronous

+ type VectorIndexStats struct

+ DebtUntilRebuild uint64

+ EstimatedBuildLogicalBytes uint64

+ ExactFallbacks uint64

+ IndexEntries uint64

+ LiveEntries uint64

+ MutationDebt uint64

+ RebuildNanoseconds uint64

+ RebuildThreshold uint64

+ Rebuilds uint64

+ TombstoneBytes uint64

+ TombstoneBytesUntilRebuild uint64

+ Tombstones uint64

+ type VectorSearchOptions struct

+ EfSearch uint16

+ Exact bool

+ K uint32

+ MaxBytes uint64

+ MaxWork uint64

+ type VectorSearchResult = engine.VectorSearchResult

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL