Merge pull request #22 from wherobots/max/features

Use new runtime names and implement session reuse

Author: mpetazzoni

README.md

@@ -33,7 +33,7 @@ from wherobots.db.runtime import Runtime
 
 with connect(
         api_key='...',
-        runtime=Runtime.SEDONA,
+        runtime=Runtime.TINY,
         region=Region.AWS_US_WEST_2) as conn:
     curr = conn.cursor()
     curr.execute("SHOW SCHEMAS IN wherobots_open_data")
@@ -81,3 +81,6 @@ users may find useful:
     client application. The default is EWKT (string) and the most
     convenient for human inspection while still being usable by
     libraries like Shapely.
+* `reuse_session`: controls whether an existing runtime of the same type
+    and in the same region that is available should be re-used for this
+    connection. This is the default behavior.

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wherobots-python-dbapi"
-version = "0.7.5"
+version = "0.8.0"
 description = "Python DB-API driver for Wherobots DB"
 authors = ["Maxime Petazzoni <max@wherobots.com>"]
 license = "Apache 2.0"

pyproject.toml

@@ -71,8 +71,6 @@
             host=args.api_endpoint,
             token=token,
             api_key=api_key,
-            runtime=Runtime.SEDONA,
-            region=Region.AWS_US_WEST_2,
             shutdown_after_inactive_seconds=args.shutdown_after_inactive_seconds,
             wait_timeout=900,
         )

tests/smoke.py

@@ -7,10 +7,13 @@
 
 DEFAULT_ENDPOINT: str = "api.cloud.wherobots.com"  # "api.cloud.wherobots.com"
 STAGING_ENDPOINT: str = "api.staging.wherobots.com"  # "api.staging.wherobots.com"
-DEFAULT_RUNTIME: Runtime = Runtime.SEDONA
+
+DEFAULT_RUNTIME: Runtime = Runtime.TINY
 DEFAULT_REGION: Region = Region.AWS_US_WEST_2
 DEFAULT_READ_TIMEOUT_SECONDS: float = 0.25
 DEFAULT_SESSION_WAIT_TIMEOUT_SECONDS: float = 900
+DEFAULT_REUSE_SESSION: bool = True
+
 MAX_MESSAGE_SIZE: int = 100 * 2**20  # 100MiB
 PROTOCOL_VERSION: str = "1.0.0"
 

wherobots/db/constants.py

@@ -19,6 +19,7 @@
 from .constants import (
     DEFAULT_ENDPOINT,
     DEFAULT_REGION,
+    DEFAULT_REUSE_SESSION,
     DEFAULT_RUNTIME,
     DEFAULT_READ_TIMEOUT_SECONDS,
     DEFAULT_SESSION_WAIT_TIMEOUT_SECONDS,
@@ -62,6 +63,7 @@ def connect(
     region: Region = None,
     wait_timeout: float = DEFAULT_SESSION_WAIT_TIMEOUT_SECONDS,
     read_timeout: float = DEFAULT_READ_TIMEOUT_SECONDS,
+    reuse_session: bool = DEFAULT_REUSE_SESSION,
     shutdown_after_inactive_seconds: Union[int, None] = None,
     results_format: Union[ResultsFormat, None] = None,
     data_compression: Union[DataCompression, None] = None,
@@ -83,8 +85,8 @@ def connect(
     region = region or DEFAULT_REGION
 
     logging.info(
-        "Requesting %s/%s runtime in %s from %s ...",
-        runtime.name,
+        "%s %s runtime in %s from %s ...",
+        "Recycling" if reuse_session else "Requesting",
         runtime.value,
         region.value,
         host,
@@ -97,7 +99,7 @@ def connect(
     try:
         resp = requests.post(
             url=f"{host}/sql/session",
-            params={"region": region.value},
+            params={"region": region.value, "reuse_session": reuse_session},
             json={
                 "runtimeId": runtime.value,
                 "shutdownAfterInactiveSeconds": shutdown_after_inactive_seconds,

wherobots/db/driver.py

@@ -2,6 +2,27 @@
 
 
 class Runtime(Enum):
+    TINY = "tiny"
+    SMALL = "small"
+    MEDIUM = "medium"
+    LARGE = "large"
+    X_LARGE = "x-large"
+    XX_LARGE = "2x-large"
+    XXXX_LARGE = "4x-large"
+
+    # HIMEM
+    MEDIUM_HIMEM = "medium-himem"
+    LARGE_HIMEM = "large-himem"
+    X_LARGE_HIMEM = "x-large-himem"
+    XX_LARGE_HIMEM = "2x-large-himem"
+    XXXX_LARGE_HIMEM = "4x-large-himem"
+
+    # GPU
+    TINY_A10_GPU = "tiny-a10-gpu"
+    SMALL_A10_GPU = "small-a10-gpu"
+    MEDIUM_A10_GPU = "medium-a10-gpu"
+
+    # Deprecated names; will be removed in a later major version.
     SEDONA = "tiny"
     SAN_FRANCISCO = "small"
     NEW_YORK = "medium"