pyvastbase 0.2.2__py3-none-any.whl

pyvastbase/__init__.py

@@ -0,0 +1,364 @@
+"""
+pyvastbase - Python SDK for Vastbase Vector Database
+
+A PyMilvus-style Python SDK for Vastbase vector database with
+support for vector storage, similarity search, and hybrid queries.
+
+Example:
+    >>> from pyvastbase import connect, Collection
+    >>> 
+    >>> # Connect to database
+    >>> connect(host="localhost", database="mydb")
+    >>> 
+    >>> # Create collection with schema
+    >>> from pyvastbase import FieldSchema, CollectionSchema, DataType
+    >>> 
+    >>> fields = [
+    ...     FieldSchema(name="id", dtype=DataType.INT64, is_primary_key=True),
+    ...     FieldSchema(name="embedding", dtype=DataType.FLOAT_VECTOR, dim=128),
+    ...     FieldSchema(name="text", dtype=DataType.VARCHAR, max_length=65535)
+    ... ]
+    >>> schema = CollectionSchema(name="my_vectors", fields=fields)
+    >>> 
+    >>> # Create and use collection
+    >>> collection = Collection("my_vectors", schema=schema)
+    >>> collection.create()
+    >>> 
+    >>> # Insert data
+    >>> collection.insert([
+    ...     {"id": 1, "embedding": [0.1] * 128, "text": "hello world"},
+    ...     {"id": 2, "embedding": [0.2] * 128, "text": "goodbye world"}
+    ... ])
+    >>> 
+    >>> # Search
+    >>> results = collection.search(
+    ...     data=[[0.15] * 128],
+    ...     anns_field="embedding",
+    ...     top_k=10
+    ... )
+"""
+
+__version__ = "0.2.2"
+__author__ = "pyvastbase contributors"
+
+# Core imports
+from .core.constants import (
+    IndexType,
+    DistanceType,
+    MetricType,
+    QuantizerType,
+    DEFAULT_INDEX_PARAMS,
+    DEFAULT_QUERY_PARAMS,
+    VectorConstraints,
+    VB_VERSION_3_0_9,
+    VB_VERSION_SPARSEVECTOR,
+    VB_VERSION_NEW_VECTOR_TYPES,
+    VB_VERSION_BM25_HIGHLIGHT,
+    VB_VERSION_AUTO_QUANTIZATION,
+)
+
+from .core.exceptions import (
+    VastbaseException,
+    ConnectionError as VastbaseConnectionError,
+    ParamError,
+    SchemaError,
+    IndexError,
+    CollectionError,
+    DataError,
+    SearchError,
+    ExpressionError,
+    VectorDimensionError,
+    IndexNotSupportedError,
+    NotSupportedError,
+    CollectionNotExistsError,
+    MilvusException,
+    MilvusUnavailableException,
+)
+
+from .client import VastbaseClient, MilvusClient
+
+from .core.connections import (
+    ConnectionConfig,
+    Connections,
+    VastbaseConnection,
+)
+
+from .core.schema import (
+    DataType,
+    FieldSchema,
+    CollectionSchema,
+    create_collection_schema,
+)
+
+# Index imports
+from .index.index_builder import (
+    IndexParams,
+    IndexBuilder,
+    create_vector_index,
+    create_fulltext_index,
+)
+
+# Search imports
+from .search.search_builder import (
+    SearchParams,
+    SearchResultItem,
+    SearchResult,
+    SearchQueryBuilder,
+    FulltextSearchBuilder,
+    SearchType,
+    AnnSearchRequest,
+    BaseRanker,
+    RRFRanker,
+    WeightedRRFRanker,
+    WeightedRanker,
+)
+
+from .core.mutation_result import (
+    MutationResult,
+)
+
+# Collection import
+from .collection import Collection, SearchIterator, QueryIterator
+
+# Async imports (renamed from async to async_impl to avoid Python keyword)
+from .async_impl import (
+    AsyncConnections,
+    AsyncVastbaseConnection,
+    AsyncCollection,
+    QueryIterator,
+    add_connection,
+    connect,
+    get_connection,
+    remove_connection,
+    close_all,
+    # Alias management
+    create_alias,
+    drop_alias,
+    alter_alias,
+    # Load state
+    get_load_state,
+)
+
+# Utility imports
+from .utility import (
+    connect,
+    add_connection,
+    get_connection,
+    remove_connection,
+    close_all,
+    list_connections,
+    get_server_version,
+    get_server_status,
+    list_collections,
+    has_collection,
+    describe_collection,
+    create_collection,
+    drop_collection,
+    rename_collection,
+    health_check,
+    normalize_vector,
+    batch_iterator,
+    # Alias management (sync versions override async from async_impl)
+    create_alias,
+    drop_alias,
+    alter_alias,
+    # Load state (sync version overrides async)
+    get_load_state,
+    # User management
+    create_user,
+    drop_user,
+    reset_password,
+    list_users,
+    # Privilege management
+    grant,
+    revoke,
+    # Database management
+    create_database,
+    drop_database,
+    list_databases,
+    describe_database,
+    # User management (extended)
+    describe_user,
+    update_password,
+    # Index management
+    describe_index,
+    alter_index_properties,
+    drop_index_properties,
+    # Alias management (extended)
+    list_aliases,
+    describe_alias,
+    # Collection property management
+    alter_collection_properties,
+    drop_collection_properties,
+    add_collection_field,
+    # Flush
+    flush_all,
+    get_flush_all_state,
+    # Vastbase 3.0.9+ version detection
+    get_vb_version,
+    check_vb_version,
+    # Vastbase 3.0.9+ search highlight
+    bm25_search_highlight,
+    # Vastbase 3.0.9+ buffer inspection
+    vectorbuffer_inspect,
+    bulkbuffer_inspect,
+)
+
+# Public API
+__all__ = sorted([
+    "__version__",
+    "AnnSearchRequest",
+    "AsyncCollection",
+    "AsyncConnections",
+    "AsyncVastbaseConnection",
+    "BaseRanker",
+    "BatchIterator",
+    "Collection",
+    "CollectionError",
+    "CollectionNotExistsError",
+    "CollectionSchema",
+    "ConnectionConfig",
+    "Connections",
+    "DataError",
+    "DataType",
+    "DEFAULT_INDEX_PARAMS",
+    "DEFAULT_QUERY_PARAMS",
+    "DistanceType",
+    "ExpressionError",
+    "FieldSchema",
+    "FulltextSearchBuilder",
+    "IndexBuilder",
+    "IndexError",
+    "IndexNotSupportedError",
+    "IndexParams",
+    "IndexType",
+    "MetricType",
+    "MilvusClient",
+    "MilvusException",
+    "MilvusUnavailableException",
+    "MutationResult",
+    "MutationResultWrapper",
+    "NotSupportedError",
+    "ParamError",
+    "QuantizerType",
+    "QueryIterator",
+    "RRFRanker",
+    "SchemaError",
+    "SearchBuilder",
+    "SearchError",
+    "SearchParams",
+    "SearchQueryBuilder",
+    "SearchResult",
+    "SearchResultItem",
+    "SearchResults",
+    "SearchType",
+    "SearchIterator",
+    "VastbaseClient",
+    "VastbaseConnection",
+    "VastbaseConnectionError",
+    "VastbaseException",
+    "VectorConstraints",
+    "VectorDimensionError",
+    "VB_VERSION_3_0_9",
+    "VB_VERSION_AUTO_QUANTIZATION",
+    "VB_VERSION_BM25_HIGHLIGHT",
+    "VB_VERSION_NEW_VECTOR_TYPES",
+    "VB_VERSION_SPARSEVECTOR",
+    "WeightedRanker",
+    "WeightedRRFRanker",
+    "add_connection",
+    "alter_alias",
+    "batch_iterator",
+    "bm25_search_highlight",
+    "bulkbuffer_inspect",
+    "check_vb_version",
+    "close_all",
+    "configure",
+    "connect",
+    "create_alias",
+    "create_collection",
+    "create_collection_schema",
+    "create_database",
+    "create_fulltext_index",
+    "create_user",
+    "create_vector_index",
+    "describe_collection",
+    "drop_alias",
+    "drop_collection",
+    "drop_database",
+    "drop_user",
+    "get_config",
+    "get_connection",
+    "get_load_state",
+    "get_server_status",
+    "get_server_version",
+    "get_vb_version",
+    "grant",
+    "has_collection",
+    "health_check",
+    "list_collections",
+    "list_connections",
+    "list_databases",
+    "list_users",
+    "normalize_vector",
+    "remove_connection",
+    "rename_collection",
+    "reset_password",
+    "revoke",
+    "add_collection_field",
+    "alter_collection_properties",
+    "alter_index_properties",
+    "describe_alias",
+    "describe_database",
+    "describe_index",
+    "describe_user",
+    "drop_collection_properties",
+    "drop_index_properties",
+    "flush_all",
+    "get_flush_all_state",
+    "list_aliases",
+    "update_password",
+    "vectorbuffer_inspect",
+])
+
+
+def __getattr__(name):
+    """Lazy deprecated aliases — warn on access."""
+    if name == "MutationResultWrapper":
+        import warnings
+        warnings.warn(
+            "MutationResultWrapper is deprecated, use MutationResult instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from .core.mutation_result import MutationResult
+        return MutationResult
+    if name == "SearchResults":
+        import warnings
+        warnings.warn(
+            "SearchResults is deprecated, use SearchResult instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from .core.search_result import SearchResult
+        return SearchResult
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+# Module-level configuration
+_config = {
+    "default_connection": "default",
+    "timeout": 30.0,
+    "pool_size": 10,
+    "max_overflow": 10,
+}
+
+
+def configure(**kwargs) -> None:
+    """Configure pyvastbase settings"""
+    _config.update(kwargs)
+
+
+def get_config() -> dict:
+    """Get current configuration"""
+    return _config.copy()

pyvastbase/async_impl/__init__.py

@@ -0,0 +1,159 @@
+"""
+Vastbase Vector Database SDK - Async Module
+
+Async implementations for async/await patterns.
+Fully compatible with the sync API - same method names, parameters, and return types.
+
+Example:
+    # Sync version
+    from pyvastbase import Collection, connect
+    connect(host="localhost", database="mydb")
+    collection = Collection("my_vectors")
+    collection.insert([{"id": 1, "vector": [0.1] * 128}])
+    
+    # Async version - same API, async/await
+    from pyvastbase.async_impl import AsyncCollection, connect
+    await connect(host="localhost", database="mydb")
+    collection = AsyncCollection("my_vectors")
+    await collection.insert([{"id": 1, "vector": [0.1] * 128}])
+"""
+
+# Async connections
+from .connections import (
+    AsyncConnections,
+    AsyncVastbaseConnection,
+    ConnectionConfig,
+    add_connection,
+    connect,
+    get_connection,
+    remove_connection,
+    close_all,
+)
+
+# Async collection (main class)
+from .collection import AsyncCollection, QueryIterator
+
+
+# Async index builder
+from .index_builder import AsyncIndexBuilder
+
+# Async index CRUD functions
+from .index_builder import (
+    async_drop_index,
+    async_list_indexes,
+    async_describe_index,
+    async_index_exists,
+)
+
+# Async search builder
+from .search_builder import (
+    AsyncSearchBuilder,
+    AsyncSearchResultItem,
+    AsyncSearchResult,
+    AsyncSearchQueryBuilder,
+    AsyncFulltextSearchBuilder,
+)
+
+# Utility functions
+from .search_builder import (
+    async_search_vector,
+    async_search_fulltext,
+)
+
+# Alias and load state utilities
+from .utility import (
+    create_alias,
+    drop_alias,
+    alter_alias,
+    get_load_state,
+    wait_for_loading_complete,
+    get_loading_progress,
+    calc_distance,
+    async_calc_distance,
+    search_iterator,
+    async_search_iterator,
+    AsyncSearchIterator,
+    # User management
+    create_user,
+    drop_user,
+    reset_password,
+    list_users,
+    # Privilege management
+    grant,
+    revoke,
+    # Database management
+    create_database,
+    drop_database,
+    list_databases,
+    # Flush & Collection Load/Release
+    flush,
+    get_flush_state,
+    flush_sync,
+    load_collection,
+    release_collection,
+)
+
+# For convenience, also export from connections module
+__all__ = [
+    # Connections
+    "AsyncConnections",
+    "AsyncVastbaseConnection", 
+    "ConnectionConfig",
+    "add_connection",
+    "connect",
+    "get_connection",
+    "remove_connection",
+    "close_all",
+    # Collection
+    "AsyncCollection",
+    "QueryIterator",
+# Index Builder
+    "AsyncIndexBuilder",
+    "async_drop_index",
+    "async_list_indexes",
+    "async_describe_index",
+    "async_index_exists",
+    # Search Builder
+    "AsyncSearchBuilder",
+    "AsyncSearchResultItem",
+    "AsyncSearchResult",
+    "AsyncSearchResult",
+    "AsyncSearchQueryBuilder",
+    "AsyncFulltextSearchBuilder",
+    # Utility functions
+    "async_search_vector",
+    "async_search_fulltext",
+    # Alias management
+    "create_alias",
+    "drop_alias",
+    "alter_alias",
+    "get_load_state",
+    # Loading progress
+    "wait_for_loading_complete",
+    "get_loading_progress",
+    # Distance calculation
+    "calc_distance",
+    "async_calc_distance",
+    # Search iterator
+    "search_iterator",
+    "async_search_iterator",
+    "AsyncSearchIterator",
+    # User management
+    "create_user",
+    "drop_user",
+    "reset_password",
+    "list_users",
+    # Privilege management
+    "grant",
+    "revoke",
+    # Database management
+    "create_database",
+    "drop_database",
+    "list_databases",
+    # Flush & Collection Load/Release
+    "flush",
+    "get_flush_state",
+    "flush_sync",
+    "load_collection",
+    "release_collection",
+]