Expand description
A user-friendly embedded API for the AlopexDB key-value store.
Re-exports§
pub use crate::catalog::CachedTableInfo;pub use crate::catalog::Catalog;pub use crate::catalog_api::CatalogInfo;pub use crate::catalog_api::CatalogManifestCatalog;pub use crate::catalog_api::CatalogManifestColumn;pub use crate::catalog_api::CatalogManifestCompression;pub use crate::catalog_api::CatalogManifestDataSourceFormat;pub use crate::catalog_api::CatalogManifestDataType;pub use crate::catalog_api::CatalogManifestDelta;pub use crate::catalog_api::CatalogManifestIndex;pub use crate::catalog_api::CatalogManifestIndexMethod;pub use crate::catalog_api::CatalogManifestNamespace;pub use crate::catalog_api::CatalogManifestRowIdMode;pub use crate::catalog_api::CatalogManifestStorage;pub use crate::catalog_api::CatalogManifestStorageType;pub use crate::catalog_api::CatalogManifestTable;pub use crate::catalog_api::CatalogManifestTableType;pub use crate::catalog_api::CatalogManifestVectorMetric;pub use crate::catalog_api::ColumnDefinition;pub use crate::catalog_api::ColumnInfo;pub use crate::catalog_api::CreateCatalogRequest;pub use crate::catalog_api::CreateNamespaceRequest;pub use crate::catalog_api::CreateTableRequest;pub use crate::catalog_api::IndexInfo;pub use crate::catalog_api::NamespaceInfo;pub use crate::catalog_api::StorageInfo;pub use crate::catalog_api::TableInfo;pub use crate::catalog_api::CATALOG_MANIFEST_DELTA_FORMAT;pub use crate::columnar_api::ColumnarIndexInfo;pub use crate::columnar_api::ColumnarIndexType;pub use crate::columnar_api::ColumnarRowIterator;pub use crate::columnar_api::EmbeddedConfig;pub use crate::columnar_api::StorageMode;pub use crate::options::DatabaseOptions;pub use crate::owned_session::EmbeddedOwnedSessionFactory;pub use crate::owned_session::OwnedEmbeddedTransaction;pub use crate::owned_sql::OwnedSqlRowOutcome;pub use crate::owned_sql::OwnedSqlStreamPlan;
Modules§
- catalog
- Catalog metadata API (in-memory, primarily for Python bindings). Unity Catalog-like metadata store for embedded usage.
- catalog_
api - Catalog API 向けの公開型定義。
- columnar_
api - カラムナーストレージの埋め込み API 拡張。
- options
- Database configuration options for the embedded API.
- owned_
session - Owned embedded-session factories for long-lived local consumers.
- owned_
sql - Owned, bounded SQL stream planning for embedded-local consumers.
Structs§
- Data
Frame - An eager table backed by one or more Arrow
RecordBatchvalues. - Database
- The main database object.
- Hnsw
Config - HNSW インデックスの設定値。
- Hnsw
Search Result - HNSW 検索結果の 1 件。
- Hnsw
Stats - HNSW インデックスの集計統計。
- Memory
Stats - メモリ使用量の統計(バイト単位)。
- Owned
Read Options - Options shared by owned read session factories.
- Owned
Read Session - A read-only session that owns a transaction until a stream terminal action releases it.
- Owned
Transaction Session - A transaction session that serializes stream leases and owns exactly one terminal action.
- Query
RowIterator - Streaming query row iterator for FR-7 compliance. Streaming query result that yields rows one at a time.
- Search
Result - A search result row containing key, metadata, and similarity score.
- Sort
Options - Sort configuration for
DataFrame::sort. - Streaming
Rows - Streaming row access for FR-7 compliance.
- Transaction
- A database transaction.
- Transaction
Info - Metadata for a persisted KV transaction.
- Transaction
Manager - Manages persisted KV transactions for CLI usage.
Enums§
- Data
Source Format - Error
- The error type for embedded database operations.
- Join
Keys - Join key specification.
- Join
Type - Supported join types for
DataFrame::join. - Metric
- Supported similarity/distance metrics.
- SqlStreaming
Result - Streaming SQL execution result for FR-7 compliance.
- Streaming
Query Result - Result type for callback-based streaming query.
- Table
Type - TxnMode
- The mode in which a transaction is operating.