singlestoredb 1.4.3__py3-none-any.whl → 1.5.0__py3-none-any.whl

singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.4.3'
+__version__ = '1.5.0'
 
 from typing import Any
 

singlestoredb/config.py

@@ -221,6 +221,17 @@ register_option(
     environ='SINGLESTOREDB_ENABLE_EXTENDED_DATA_TYPES',
 )
 
+register_option(
+    'vector_data_format', 'string',
+    functools.partial(
+        check_str,
+        valid_values=['json', 'binary'],
+    ),
+    'binary',
+    'Format for vector data values',
+    environ='SINGLESTOREDB_VECTOR_DATA_FORMAT',
+)
+
 register_option(
     'fusion.enabled', 'bool', check_bool, False,
     'Should Fusion SQL queries be enabled?',

singlestoredb/connection.py

@@ -1304,6 +1304,7 @@ def connect(
     encoding_errors: Optional[str] = None,
     track_env: Optional[bool] = None,
     enable_extended_data_types: Optional[bool] = None,
+    vector_data_format: Optional[str] = None,
 ) -> Connection:
     """
     Return a SingleStoreDB connection.
@@ -1387,6 +1388,8 @@ def connect(
         Should the connection track the SINGLESTOREDB_URL environment variable?
     enable_extended_data_types : bool, optional
         Should extended data types (BSON, vector) be enabled?
+    vector_data_format : str, optional
+        Format for vector types: json or binary
 
     Examples
     --------

singlestoredb/fusion/handlers/workspace.py

@@ -13,6 +13,59 @@ from .utils import get_workspace_group
 from .utils import get_workspace_manager
 
 
+class UseWorkspaceHandler(SQLHandler):
+    """
+    USE WORKSPACE workspace [ with_database ];
+
+    # Workspace
+    workspace = { workspace_id | workspace_name }
+
+    # ID of workspace
+    workspace_id = ID '<workspace-id>'
+
+    # Name of workspace
+    workspace_name = '<workspace-name>'
+
+    # Name of database
+    with_database = WITH DATABASE 'database-name'
+
+    Description
+    -----------
+    Change the workspace and database in the notebook.
+
+    Arguments
+    ---------
+    * ``<workspace-id>``: The ID of the workspace to delete.
+    * ``<workspace-name>``: The name of the workspace to delete.
+
+    Remarks
+    -------
+    * Specify the ``WITH DATABASE`` clause to select a default
+      database for the session.
+    * This command only works in a notebook session in the
+      Managed Service.
+
+    Example
+    -------
+    The following command sets the workspace to ``examplews`` and
+    select 'dbname' as the default database::
+
+        USE WORKSPACE 'examplews' WITH DATABASE 'dbname';
+
+    """
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        from singlestoredb.notebook import portal
+        if params.get('with_database'):
+            portal.connection = params['workspace']['workspace_name'], \
+                                params['with_database']
+        else:
+            portal.workspace = params['workspace']['workspace_name']
+        return None
+
+
+UseWorkspaceHandler.register(overwrite=True)
+
+
 class ShowRegionsHandler(SQLHandler):
     """
     SHOW REGIONS [ <like> ]

singlestoredb/http/connection.py

@@ -1243,5 +1243,7 @@ def connect(
     inf_as_null: Optional[bool] = None,
     encoding_errors: Optional[str] = None,
     track_env: Optional[bool] = None,
+    enable_extended_data_types: Optional[bool] = None,
+    vector_data_format: Optional[str] = None,
 ) -> Connection:
     return Connection(**dict(locals()))

singlestoredb/mysql/connection.py

@@ -280,6 +280,8 @@ class Connection(BaseConnection):
         Should the connection track the SINGLESTOREDB_URL environment variable?
     enable_extended_data_types : bool, optional
         Should extended data types (BSON, vector) be enabled?
+    vector_data_format : str, optional
+        Specify the data type of vector values: json or binary
 
     See `Connection <https://www.python.org/dev/peps/pep-0249/#connection-objects>`_
     in the specification.
@@ -350,6 +352,7 @@ class Connection(BaseConnection):
         encoding_errors='strict',
         track_env=False,
         enable_extended_data_types=True,
+        vector_data_format='binary',
     ):
         BaseConnection.__init__(**dict(locals()))
 
@@ -634,6 +637,13 @@ class Connection(BaseConnection):
         self._in_sync = False
         self._track_env = bool(track_env) or self.host == 'singlestore.com'
         self._enable_extended_data_types = enable_extended_data_types
+        if vector_data_format.lower() in ['json', 'binary']:
+            self._vector_data_format = vector_data_format
+        else:
+            raise ValueError(
+                'unknown value for vector_data_format, '
+                f'expecting "json" or "binary": {vector_data_format}',
+            )
         self._connection_info = {}
         events.subscribe(self._handle_event)
 
@@ -1117,6 +1127,15 @@ class Connection(BaseConnection):
                     pass
                 c.close()
 
+            if self._vector_data_format:
+                c = self.cursor()
+                try:
+                    val = self._vector_data_format
+                    c.execute(f'SET @@SESSION.vector_type_project_format={val}')
+                except self.OperationalError:
+                    pass
+                c.close()
+
             if self.init_command is not None:
                 c = self.cursor()
                 c.execute(self.init_command)

singlestoredb/notebook/_portal.py

@@ -9,6 +9,7 @@ from typing import Callable
 from typing import Dict
 from typing import List
 from typing import Optional
+from typing import Tuple
 
 from . import _objects as obj
 from ..management import workspace as mgr
@@ -187,6 +188,37 @@ class Portal(object):
             timeout_message='timeout waiting for workspace update',
         )
 
+    deployment = workspace
+
+    @property
+    def connection(self) -> Tuple[obj.Workspace, Optional[str]]:
+        """Workspace and default database name."""
+        return self.workspace, self.default_database
+
+    @connection.setter
+    def connection(self, workspace_and_default_database: Tuple[str, str]) -> None:
+        """Set workspace and default database name."""
+        name_or_id, default_database = workspace_and_default_database
+        if re.match(
+            r'[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}',
+            name_or_id, flags=re.I,
+        ):
+            w = mgr.get_workspace(name_or_id)
+        else:
+            w = mgr.get_workspace_group(self.workspace_group_id).workspaces[name_or_id]
+
+        if w.state and w.state.lower() not in ['active', 'resumed']:
+            raise RuntimeError('workspace is not active')
+
+        id = w.id
+
+        self._call_javascript(
+            'changeConnection', [id, default_database],
+            wait_on_condition=lambda: self.workspace_id == id and
+            self.default_database == default_database,  # type: ignore
+            timeout_message='timeout waiting for workspace update',
+        )
+
     @property
     def cluster_id(self) -> Optional[str]:
         """Cluster ID."""

{singlestoredb-1.4.3.dist-info → singlestoredb-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: singlestoredb
-Version: 1.4.3
+Version: 1.5.0
 Summary: Interface to the SingleStoreDB database and workspace management APIs
 Home-page: https://github.com/singlestore-labs/singlestoredb-python
 Author: SingleStore

{singlestoredb-1.4.3.dist-info → singlestoredb-1.5.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
-singlestoredb/__init__.py,sha256=NTrIpxhbm7oMxrNbbjVKdK-4ShuyvUChQlP3z-kL9Ko,1634
+singlestoredb/__init__.py,sha256=uEuDac8tSZiJCE2NiWh3zAtGwMalgs9DTd-xAsWHGYM,1634
 singlestoredb/auth.py,sha256=u8D9tpKzrqa4ssaHjyZnGDX1q8XBpGtuoOkTkSv7B28,7599
-singlestoredb/config.py,sha256=H4pQxqBEGGCmVHg40VEnAdqGXHun8ougZzj-Ed6ZLH4,11822
-singlestoredb/connection.py,sha256=WL_TSSHhhjLV0pnJOtaeMAf0o1DI-PJv9xnLFf_cM08,45173
+singlestoredb/config.py,sha256=0qU2lweqHIA5yuV0ZN_JS-cZCfLIxIHutgS2YKRuwXw,12067
+singlestoredb/connection.py,sha256=Gzq38vG8lXTx5v2WvHkdMg-abSTS6lguTsVMxbYHZmQ,45306
 singlestoredb/converters.py,sha256=t1hRMZfccWJs_WyOw-W-Kh87fxsOkpOnKXAeh_Nr-zU,20681
 singlestoredb/exceptions.py,sha256=HuoA6sMRL5qiCiee-_5ddTGmFbYC9Euk8TYUsh5GvTw,3234
 singlestoredb/pytest.py,sha256=OyF3BO9mgxenifYhOihnzGk8WzCJ_zN5_mxe8XyFPOc,9074
@@ -28,9 +28,9 @@ singlestoredb/fusion/result.py,sha256=Bd3KbRpqWqQcWp_Chd4bzBy8Kfc8nXLS_Pn_GGbPO6
 singlestoredb/fusion/handlers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 singlestoredb/fusion/handlers/stage.py,sha256=4BSwqcmA4PI3oksTdYaTmQ6bY-AzmL0mZfGnP3U0ldM,13643
 singlestoredb/fusion/handlers/utils.py,sha256=oYbf13Y3orEkJfHMNnO7B_W1anEdK-0S9vVVkF2pPFk,5109
-singlestoredb/fusion/handlers/workspace.py,sha256=EGxu-dAWNfHsknMNSk1n9cri_zhlMJap4ypywPFiMZQ,25000
+singlestoredb/fusion/handlers/workspace.py,sha256=faVuqiE4PTVOAgbsr18MOc7H92nVzfwga0SUTPODvSc,26455
 singlestoredb/http/__init__.py,sha256=A_2ZUCCpvRYIA6YDpPy57wL5R1eZ5SfP6I1To5nfJ2s,912
-singlestoredb/http/connection.py,sha256=HUYzgiGYRUblHhgDi-ghfXykGkdB9iQ3i_XVvhtqH88,39349
+singlestoredb/http/connection.py,sha256=T2NrL7XV30eQRdrcbP_IY8c3ZOV6Th4KQiuleW4tHUE,39450
 singlestoredb/management/__init__.py,sha256=mhWXjLhp5-t8dhl0vl7SjayKrvJlDb5_hl1YWvDgiMA,237
 singlestoredb/management/billing_usage.py,sha256=9ighjIpcopgIyJOktBYQ6pahBZmWGHOPyyCW4gu9FGs,3735
 singlestoredb/management/cluster.py,sha256=i23Smr1PBrDZ8NO_VPd_-bEYkyHvVe9CCRGUjHn_1yQ,14362
@@ -42,7 +42,7 @@ singlestoredb/management/workspace.py,sha256=9oamNIaE5vLZNAlpl5SK-xu27qPqx2Ff3ZI
 singlestoredb/mysql/__init__.py,sha256=olUTAvkiERhDW41JXQMawkg-i0tvBEkoTkII1tt6lxU,4492
 singlestoredb/mysql/_auth.py,sha256=AugRitoUwgRIDFuJxuAH4MWIAmckY7Ji2pP6r_Ng9dY,8043
 singlestoredb/mysql/charset.py,sha256=-FlONDS_oAUF5B3mIgeHBPb_SCt4zHD33arUeBNctU0,10510
-singlestoredb/mysql/connection.py,sha256=Z3xJ-yFY4yc-rMGp2ty7V2NZ6Ixb74UfnlwLcypJ7d4,71446
+singlestoredb/mysql/connection.py,sha256=cUVILM5q2tVkGAf-GpPK2pvPto3AOB_9PifK8iXaiKw,72216
 singlestoredb/mysql/converters.py,sha256=CVe8SDmjbIAhy1xpQ2N5OKWw6t5eWpw-EU3QTlA0Hh0,7500
 singlestoredb/mysql/cursors.py,sha256=Eqe7jITRvOo4P_TxIarTumg_2PG1DcCfZ4Uo9IFdDa8,26794
 singlestoredb/mysql/err.py,sha256=-m5rqXi8yhq6b8SCEJ2h0E5Rudh_15dlAU_WbJ1YrM8,2388
@@ -82,7 +82,7 @@ singlestoredb/mysql/tests/thirdparty/test_MySQLdb/test_MySQLdb_dbapi20.py,sha256
 singlestoredb/mysql/tests/thirdparty/test_MySQLdb/test_MySQLdb_nonstandard.py,sha256=pl0bvuZo_nzAlYOINxRiR-Zi9khz0W2Pc7vP-K3sQYQ,2819
 singlestoredb/notebook/__init__.py,sha256=v0j1E3MFAtaC8wTrR-F7XY0nytUvQ4XpYhVXddv2xA0,533
 singlestoredb/notebook/_objects.py,sha256=MkB1eowEq5SQXFHY00xAKAyyeLqHu_uaZiA20BCJPaE,8043
-singlestoredb/notebook/_portal.py,sha256=08_8hFFuD9Ybq3K8ruHOgMhDqzdhjj7o0Sq368zH714,8486
+singlestoredb/notebook/_portal.py,sha256=DLerIEQmAUymtYcx8RBeuYJ4pJSy_xl1K6t1Oc-eTf8,9698
 singlestoredb/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 singlestoredb/tests/empty.sql,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 singlestoredb/tests/local_infile.csv,sha256=sBtqjvfkS9aoOVx8nMXYgYv4rDuT4OuYhqUhNRu0O68,42
@@ -114,9 +114,9 @@ singlestoredb/utils/events.py,sha256=9IB84T3pKQjs7aaoSSJCw7soNngnhoTDWIC52M51R9Y
 singlestoredb/utils/mogrify.py,sha256=-a56IF70U6CkfadeaZgfjRSVsAD3PuqRrzPpjZlgbwY,4050
 singlestoredb/utils/results.py,sha256=bJtaUaDiFq26IsPAKZ2FHGB7csMn94EAxLKrP4HaEEA,15277
 singlestoredb/utils/xdict.py,sha256=S9HKgrPrnu_6b7iOwa2KrW8CmU1Uqx0BWdEyogFzWbE,12896
-singlestoredb-1.4.3.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
-singlestoredb-1.4.3.dist-info/METADATA,sha256=sNKDftR6stTzMfX0NjKgcevlLjU9SQKhU6861nPiXQE,5570
-singlestoredb-1.4.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-singlestoredb-1.4.3.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
-singlestoredb-1.4.3.dist-info/top_level.txt,sha256=eet8bVPNRqiGeY0PrO5ERH2UpamwlrKHEQCffz4dOh8,14
-singlestoredb-1.4.3.dist-info/RECORD,,
+singlestoredb-1.5.0.dist-info/LICENSE,sha256=Mlq78idURT-9G026aMYswwwnnrLcgzTLuXeAs5hjDLM,11341
+singlestoredb-1.5.0.dist-info/METADATA,sha256=NNlSvXOAcd1pZGUOnuUM46RAZdw6LInc8KtKhDODwJw,5570
+singlestoredb-1.5.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+singlestoredb-1.5.0.dist-info/entry_points.txt,sha256=bSLaTWB5zGjpVYPAaI46MkkDup0su-eb3uAhCNYuRV0,48
+singlestoredb-1.5.0.dist-info/top_level.txt,sha256=eet8bVPNRqiGeY0PrO5ERH2UpamwlrKHEQCffz4dOh8,14
+singlestoredb-1.5.0.dist-info/RECORD,,