"""Client class definition."""
from typing import Any, Optional, Tuple, Union
from typing_extensions import deprecated
from weaviate.client_executor import _WeaviateClientExecutor
from .auth import AuthCredentials
from .backup import _Backup, _BackupAsync
from .collections.batch.client import _BatchClientWrapper
from .collections.cluster import _Cluster, _ClusterAsync
from .collections.collections import _Collections, _CollectionsAsync
from .config import AdditionalConfig
from .connect import executor
from .connect.base import (
ConnectionParams,
)
from .connect.v4 import ConnectionAsync, ConnectionSync
from .debug import _Debug, _DebugAsync
from .embedded import EmbeddedOptions
from .rbac import _Roles, _RolesAsync
from .types import NUMBER
from .users import _Users, _UsersAsync
TIMEOUT_TYPE = Union[Tuple[NUMBER, NUMBER], NUMBER]
[docs]
@executor.wrap("async")
class WeaviateAsyncClient(_WeaviateClientExecutor[ConnectionAsync]):
"""The v4 Python-native Weaviate Client class that encapsulates Weaviate functionalities in one object.
WARNING: This client is only compatible with Weaviate v1.23.6 and higher!
A Client instance creates all the needed objects to interact with Weaviate, and connects all of
them to the same Weaviate instance. See below the Attributes of the Client instance. For the
per attribute functionality see that attribute's documentation.
Attributes:
backup (_BackupAsync): Backup object instance connected to the same Weaviate instance as the Client.
This namespace contains all the functionality to upload data in batches to Weaviate for all collections and tenants.
cluster (_ClusterAsync): Cluster object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to inspect the connected Weaviate cluster.
collections (_CollectionsAsync): Collections object instance connected to the same Weaviate instance as the Client.
This namespace contains all the functionality to manage Weaviate data collections. It is your main entry point for all
collection-related functionality. Use it to retrieve collection objects using `client.collections.get("MyCollection")`
or to create new collections using `client.collections.create("MyCollection", ...)`.
debug (_DebugAsync): Debug object instance connected to the same Weaviate instance as the Client.
This namespace contains functionality used to debug Weaviate clusters. As such, it is deemed experimental and is subject to change.
We can make no guarantees about the stability of this namespace nor the potential for future breaking changes. Use at your own risk.
roles (_RolesAsync): Roles object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to manage Weaviate's RBAC functionality.
users (_UsersAsync): Users object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to manage Weaviate users.
"""
def __init__(
self,
connection_params: Optional[ConnectionParams] = None,
embedded_options: Optional[EmbeddedOptions] = None,
auth_client_secret: Optional[AuthCredentials] = None,
additional_headers: Optional[dict] = None,
additional_config: Optional[AdditionalConfig] = None,
skip_init_checks: bool = False,
) -> None:
self._connection_type = ConnectionAsync
super().__init__(
connection_params=connection_params,
embedded_options=embedded_options,
auth_client_secret=auth_client_secret,
additional_headers=additional_headers,
additional_config=additional_config,
skip_init_checks=skip_init_checks,
)
self.backup = _BackupAsync(self._connection)
self.cluster = _ClusterAsync(self._connection)
self.collections = _CollectionsAsync(self._connection)
self.debug = _DebugAsync(self._connection)
self.roles = _RolesAsync(self._connection)
self.users = _UsersAsync(self._connection)
async def __aenter__(self) -> "WeaviateAsyncClient":
await executor.aresult(self.connect())
return self
async def __aexit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
await executor.aresult(self.close())
[docs]
@executor.wrap("sync")
class WeaviateClient(_WeaviateClientExecutor[ConnectionSync]):
"""The v4 Python-native Weaviate Client class that encapsulates Weaviate functionalities in one object.
WARNING: This client is only compatible with Weaviate v1.23.6 and higher!
A Client instance creates all the needed objects to interact with Weaviate, and connects all of
them to the same Weaviate instance. See below the Attributes of the Client instance. For the
per attribute functionality see that attribute's documentation.
Attributes:
backup (_Backup): Backup object instance connected to the same Weaviate instance as the Client.
This namespace contains all the functionality to upload data in batches to Weaviate for all collections and tenants.
batch (_BatchClientWrapper): BatchClient object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to backup data.
cluster (_Cluster): Cluster object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to inspect the connected Weaviate cluster.
collections (_Collections): Collections object instance connected to the same Weaviate instance as the Client.
This namespace contains all the functionality to manage Weaviate data collections. It is your main entry point for all
collection-related functionality. Use it to retrieve collection objects using `client.collections.get("MyCollection")`
or to create new collections using `client.collections.create("MyCollection", ...)`.
debug (_Debug): Debug object instance connected to the same Weaviate instance as the Client.
This namespace contains functionality used to debug Weaviate clusters. As such, it is deemed experimental and is subject to change.
We can make no guarantees about the stability of this namespace nor the potential for future breaking changes. Use at your own risk.
roles (_Roles): Roles object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to manage Weaviate's RBAC functionality.
users (_Users): Users object instance connected to the same Weaviate instance as the Client.
This namespace contains all functionality to manage Weaviate users.
"""
def __init__(
self,
connection_params: Optional[ConnectionParams] = None,
embedded_options: Optional[EmbeddedOptions] = None,
auth_client_secret: Optional[AuthCredentials] = None,
additional_headers: Optional[dict] = None,
additional_config: Optional[AdditionalConfig] = None,
skip_init_checks: bool = False,
) -> None:
self._connection_type = ConnectionSync
super().__init__(
connection_params=connection_params,
embedded_options=embedded_options,
auth_client_secret=auth_client_secret,
additional_headers=additional_headers,
additional_config=additional_config,
skip_init_checks=skip_init_checks,
)
collections = _Collections(self._connection)
self.batch = _BatchClientWrapper(self._connection, config=collections)
self.backup = _Backup(self._connection)
self.cluster = _Cluster(self._connection)
self.collections = collections
self.debug = _Debug(self._connection)
self.roles = _Roles(self._connection)
self.users = _Users(self._connection)
def __enter__(self) -> "WeaviateClient":
executor.result(self.connect())
return self
def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
executor.result(self.close())
@deprecated(
"""
Python client v3 `weaviate.Client(...)` has been removed.
Upgrade your code to use Python client v4 `weaviate.WeaviateClient` connections and methods.
- For Python Client v4 usage, see: https://weaviate.io/developers/weaviate/client-libraries/python
- For code migration, see: https://weaviate.io/developers/weaviate/client-libraries/python/v3_v4_migration
If you have to use v3 code, install the v3 client and pin the v3 dependency in your requirements file: `weaviate-client>=3.26.7;<4.0.0`"""
)
class Client:
def __init__(
self,
) -> None:
raise ValueError(
"""
Python client v3 `weaviate.Client(...)` has been removed.
Upgrade your code to use Python client v4 `weaviate.WeaviateClient` connections and methods.
- For Python Client v4 usage, see: https://weaviate.io/developers/weaviate/client-libraries/python
- For code migration, see: https://weaviate.io/developers/weaviate/client-libraries/python/v3_v4_migration
If you have to use v3 code, install the v3 client and pin the v3 dependency in your requirements file: `weaviate-client>=3.26.7;<4.0.0`"""
)