wherobots-python-dbapi 0.19.0__tar.gz → 0.21.0__tar.gz

{wherobots_python_dbapi-0.19.0 → wherobots_python_dbapi-0.21.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: wherobots-python-dbapi
-Version: 0.19.0
+Version: 0.21.0
 Summary: Python DB-API driver for Wherobots DB
 Project-URL: Homepage, https://github.com/wherobots/wherobots-python-dbapi-driver
 Project-URL: Tracker, https://github.com/wherobots/wherobots-python-dbapi-driver/issues
 Author-email: Maxime Petazzoni <max@wherobots.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
-Requires-Python: ~=3.8
+Requires-Python: <4,>=3.8
 Requires-Dist: cbor2>=5.6.3
 Requires-Dist: packaging
 Requires-Dist: pandas
@@ -103,6 +103,12 @@ into. Wherobots Cloud supports the following compute regions:
 > and customers; other regions are currently reserved to Professional
 > Edition customers.
 
+> [!WARNING]
+> To prepare for the expansion of Wherobots Cloud to new regions and cloud providers, the `region` parameter will become mandatory in a future SDK version.
+> Before this support for new regions is added, we will release an updated version of the SDK.
+> While you can continue using an older SDK version for your development,
+> any new or existing SQL session you initialize without specifying the `region` parameter will be hosted in the `aws-us-west-2` region.
+
 ### Advanced parameters
 
 The `connect()` method takes some additional parameters that advanced
@@ -123,12 +129,26 @@ users may find useful:
     to you, if you need to pin your usage to a particular, supported
     WherobotsDB version. Defaults to `"latest"`.
 * `session_type`: `"single"` or `"multi"`; if set to `"single"`, then
-   each call to `connect()` establishes an exclusive connection to a
-   distinct and dedicated Wherobots runtime; if set to "multi", then
-   multiple `connect()` calls with the same arguments and credentials
-   will connect to the same shared Wherobots runtime; `"multi"` is the
-   default.
-
-   Consider multi-session for potential cost savings, but be mindful of
-   performance impacts from shared resources. You might need to adjust
-   cluster size if slowdowns occur, which could affect overall cost.
+    each call to `connect()` establishes an exclusive connection to a
+    distinct and dedicated Wherobots runtime; if set to "multi", then
+    multiple `connect()` calls with the same arguments and credentials
+    will connect to the same shared Wherobots runtime; `"multi"` is the
+    default.
+
+    Consider multi-session for potential cost savings, but be mindful of
+    performance impacts from shared resources. You might need to adjust
+    cluster size if slowdowns occur, which could affect overall cost.
+* `force_new`: passing `force_new=True` forces Wherobots Cloud to create
+    and start a new SQL Session runtime for this connection instead of
+    attempting to reuse an existing, available one. Note that this can
+    severely impact the delay in obtaining a connection to your runtime.
+* `shutdown_after_inactive_seconds`: how long the runtime waits and
+    stays running after all clients have disconnected. This delay gives
+    an opportunity for clients to reconnect to a previously-established
+    runtime without having to start a new one.
+
+    If you're using a simple "connect-query-disconnect" pattern from
+    your application, you can set this parameter to a value greater than
+    your expected time between queries and effectively get a continuously
+    running SQL session runtime without any complex connection management
+    in your application.

{wherobots_python_dbapi-0.19.0 → wherobots_python_dbapi-0.21.0}/README.md

@@ -79,6 +79,12 @@ into. Wherobots Cloud supports the following compute regions:
 > and customers; other regions are currently reserved to Professional
 > Edition customers.
 
+> [!WARNING]
+> To prepare for the expansion of Wherobots Cloud to new regions and cloud providers, the `region` parameter will become mandatory in a future SDK version.
+> Before this support for new regions is added, we will release an updated version of the SDK.
+> While you can continue using an older SDK version for your development,
+> any new or existing SQL session you initialize without specifying the `region` parameter will be hosted in the `aws-us-west-2` region.
+
 ### Advanced parameters
 
 The `connect()` method takes some additional parameters that advanced
@@ -99,12 +105,26 @@ users may find useful:
     to you, if you need to pin your usage to a particular, supported
     WherobotsDB version. Defaults to `"latest"`.
 * `session_type`: `"single"` or `"multi"`; if set to `"single"`, then
-   each call to `connect()` establishes an exclusive connection to a
-   distinct and dedicated Wherobots runtime; if set to "multi", then
-   multiple `connect()` calls with the same arguments and credentials
-   will connect to the same shared Wherobots runtime; `"multi"` is the
-   default.
-
-   Consider multi-session for potential cost savings, but be mindful of
-   performance impacts from shared resources. You might need to adjust
-   cluster size if slowdowns occur, which could affect overall cost.
+    each call to `connect()` establishes an exclusive connection to a
+    distinct and dedicated Wherobots runtime; if set to "multi", then
+    multiple `connect()` calls with the same arguments and credentials
+    will connect to the same shared Wherobots runtime; `"multi"` is the
+    default.
+
+    Consider multi-session for potential cost savings, but be mindful of
+    performance impacts from shared resources. You might need to adjust
+    cluster size if slowdowns occur, which could affect overall cost.
+* `force_new`: passing `force_new=True` forces Wherobots Cloud to create
+    and start a new SQL Session runtime for this connection instead of
+    attempting to reuse an existing, available one. Note that this can
+    severely impact the delay in obtaining a connection to your runtime.
+* `shutdown_after_inactive_seconds`: how long the runtime waits and
+    stays running after all clients have disconnected. This delay gives
+    an opportunity for clients to reconnect to a previously-established
+    runtime without having to start a new one.
+
+    If you're using a simple "connect-query-disconnect" pattern from
+    your application, you can set this parameter to a value greater than
+    your expected time between queries and effectively get a continuously
+    running SQL session runtime without any complex connection management
+    in your application.

{wherobots_python_dbapi-0.19.0 → wherobots_python_dbapi-0.21.0}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "wherobots-python-dbapi"
-version = "0.19.0"
+version = "0.21.0"
 description = "Python DB-API driver for Wherobots DB"
 authors = [{ name = "Maxime Petazzoni", email = "max@wherobots.com" }]
-requires-python = "~=3.8"
+requires-python = ">=3.8, <4"
 readme = "README.md"
 license = "Apache-2.0"
 dependencies = [

{wherobots_python_dbapi-0.19.0 → wherobots_python_dbapi-0.21.0}/wherobots/db/driver.py

@@ -68,6 +68,7 @@ def connect(
     wait_timeout: float = DEFAULT_SESSION_WAIT_TIMEOUT_SECONDS,
     read_timeout: float = DEFAULT_READ_TIMEOUT_SECONDS,
     session_type: Union[SessionType, None] = None,
+    force_new: bool = False,
     shutdown_after_inactive_seconds: Union[int, None] = None,
     results_format: Union[ResultsFormat, None] = None,
     data_compression: Union[DataCompression, None] = None,
@@ -91,7 +92,8 @@ def connect(
     session_type = session_type or DEFAULT_SESSION_TYPE
 
     logging.info(
-        "Requesting %s runtime running %s in %s from %s ...",
+        "Requesting %s%s runtime running %s in %s from %s ...",
+        "new " if force_new else "",
         runtime.value,
         version,
         region.value,
@@ -105,7 +107,7 @@ def connect(
     try:
         resp = requests.post(
             url=f"{host}/sql/session",
-            params={"region": region.value},
+            params={"region": region.value, "force_new": force_new},
             json={
                 "runtimeId": runtime.value,
                 "shutdownAfterInactiveSeconds": shutdown_after_inactive_seconds,
@@ -116,7 +118,15 @@ def connect(
         )
         resp.raise_for_status()
     except requests.HTTPError as e:
-        raise InterfaceError("Failed to create SQL session!", e)
+        details = str(e)
+        try:
+            info = e.response.json()
+            errors = info.get("errors", [])
+            if errors and isinstance(errors, list):
+                details = f"{errors[0]['message']}: {errors[0]['details']}"
+        except requests.JSONDecodeError:
+            pass
+        raise InterfaceError(f"Failed to create SQL session: {details}") from e
 
     # At this point we've been redirected to /sql/session/{session_id}, which we'll need to keep polling until the
     # session is in READY state.

{wherobots_python_dbapi-0.19.0 → wherobots_python_dbapi-0.21.0}/wherobots/db/runtime.py

@@ -2,6 +2,7 @@ from enum import Enum
 
 
 class Runtime(Enum):
+    MICRO = "micro"
     TINY = "tiny"
     SMALL = "small"
     MEDIUM = "medium"
@@ -18,6 +19,7 @@ class Runtime(Enum):
     XXXX_LARGE_HIMEM = "4x-large-himem"
 
     # GPU
+    MICRO_A10_GPU = "micro-a10-gpu"
     TINY_A10_GPU = "tiny-a10-gpu"
     SMALL_A10_GPU = "small-a10-gpu"
     MEDIUM_A10_GPU = "medium-a10-gpu"