singlestoredb 1.14.2__py3-none-any.whl → 1.15.1__py3-none-any.whl

singlestoredb/functions/typing/numpy.py

@@ -0,0 +1,20 @@
+import numpy as np
+import numpy.typing as npt
+
+NDArray = npt.NDArray
+
+StringArray = StrArray = npt.NDArray[np.str_]
+BytesArray = npt.NDArray[np.bytes_]
+Float32Array = FloatArray = npt.NDArray[np.float32]
+Float64Array = DoubleArray = npt.NDArray[np.float64]
+IntArray = npt.NDArray[np.int_]
+Int8Array = npt.NDArray[np.int8]
+Int16Array = npt.NDArray[np.int16]
+Int32Array = npt.NDArray[np.int32]
+Int64Array = npt.NDArray[np.int64]
+UInt8Array = npt.NDArray[np.uint8]
+UInt16Array = npt.NDArray[np.uint16]
+UInt32Array = npt.NDArray[np.uint32]
+UInt64Array = npt.NDArray[np.uint64]
+DateTimeArray = npt.NDArray[np.datetime64]
+TimeDeltaArray = npt.NDArray[np.timedelta64]

singlestoredb/functions/typing/pandas.py

@@ -0,0 +1,2 @@
+from pandas import DataFrame  # noqa: F401
+from pandas import Series  # noqa: F401

singlestoredb/functions/typing/polars.py

@@ -0,0 +1,2 @@
+from polars import DataFrame  # noqa: F401
+from polars import Series  # noqa: F401

singlestoredb/functions/typing/pyarrow.py

@@ -0,0 +1,2 @@
+from pyarrow import Array  # noqa: F401
+from pyarrow import Table  # noqa: F401

singlestoredb/fusion/handlers/files.py

@@ -89,7 +89,7 @@ class ShowPersonalFilesHandler(ShowFilesHandler):
       specified number.
     * Use the ``ORDER BY`` clause to sort the results by the specified
       key. By default, the results are sorted in the ascending order.
-    * The ``AT PATH`` clause specifies the path in the personal/shared
+    * The ``AT`` clause specifies the path in the personal/shared
       space to list the files from.
     * Use the ``RECURSIVE`` clause to list the files recursively.
     * To return more information about the files, use the ``EXTENDED``
@@ -99,7 +99,7 @@ class ShowPersonalFilesHandler(ShowFilesHandler):
     --------
     The following command lists the files at a specific path::
 
-        SHOW PERSONAL FILES AT PATH "/data/";
+        SHOW PERSONAL FILES AT "/data/";
 
     The following command lists the files recursively with
     additional information::
@@ -154,7 +154,7 @@ class ShowSharedFilesHandler(ShowFilesHandler):
       specified number.
     * Use the ``ORDER BY`` clause to sort the results by the specified
       key. By default, the results are sorted in the ascending order.
-    * The ``AT PATH`` clause specifies the path in the personal/shared
+    * The ``AT`` clause specifies the path in the personal/shared
       space to list the files from.
     * Use the ``RECURSIVE`` clause to list the files recursively.
     * To return more information about the files, use the ``EXTENDED``
@@ -164,7 +164,7 @@ class ShowSharedFilesHandler(ShowFilesHandler):
     --------
     The following command lists the files at a specific path::
 
-        SHOW SHARED FILES AT PATH "/data/";
+        SHOW SHARED FILES AT "/data/";
 
     The following command lists the files recursively with
     additional information::

singlestoredb/fusion/handlers/models.py

@@ -44,7 +44,7 @@ class ShowModelsHandler(ShowFilesHandler):
       specified number.
     * Use the ``ORDER BY`` clause to sort the results by the specified
       key. By default, the results are sorted in the ascending order.
-    * The ``AT PATH`` clause specifies the path in the models
+    * The ``AT`` clause specifies the path in the models
       space to list the files from.
     * To return more information about the files, use the ``EXTENDED``
       clause.

singlestoredb/fusion/handlers/stage.py

@@ -62,7 +62,7 @@ class ShowStageFilesHandler(SQLHandler):
       specified number.
     * Use the ``ORDER BY`` clause to sort the results by the specified
       key. By default, the results are sorted in the ascending order.
-    * The ``AT PATH`` clause specifies the path in the Stage to list
+    * The ``AT`` clause specifies the path in the Stage to list
       the files from.
     * The ``IN`` clause specifies the ID or the name of the
       deployment in which the Stage is attached.
@@ -74,7 +74,7 @@ class ShowStageFilesHandler(SQLHandler):
     --------
     The following command lists the files at a specific path::
 
-        SHOW STAGE FILES IN 'wsg1' AT PATH "/data/";
+        SHOW STAGE FILES IN 'wsg1' AT "/data/";
 
     The following command lists the files recursively with
     additional information::
@@ -393,7 +393,7 @@ class DropStageFolderHandler(SQLHandler):
     # Name of deployment
     deployment_name = '<deployment-name>'
 
-    # Should folers be deleted recursively?
+    # Should folders be deleted recursively?
     recursive = RECURSIVE
 
     Description
@@ -474,7 +474,7 @@ class CreateStageFolderHandler(SQLHandler):
       is created. The path must end with a trailing slash (/).
     * ``<deployment-id>``: The ID of the deployment in which
       the Stage is attached.
-    * ``<deployment-name>``: The name of the deployment in which
+    * ``<deployment-name>``: The name of the deployment in
       which the Stage is attached.
 
     Remarks

singlestoredb/magics/run_personal.py

@@ -1,6 +1,8 @@
 import os
 import tempfile
+from pathlib import Path
 from typing import Any
+from warnings import warn
 
 from IPython.core.interactiveshell import InteractiveShell
 from IPython.core.magic import line_magic
@@ -8,6 +10,8 @@ from IPython.core.magic import Magics
 from IPython.core.magic import magics_class
 from IPython.core.magic import needs_local_scope
 from IPython.core.magic import no_var_expand
+from IPython.utils.contexts import preserve_keys
+from IPython.utils.syspathcontext import prepended_to_syspath
 from jinja2 import Template
 
 
@@ -53,4 +57,81 @@ class RunPersonalMagic(Magics):
             # Execute the SQL command
             self.shell.run_line_magic('sql', sql_command)
             # Run the downloaded file
-            self.shell.run_line_magic('run', f'"{temp_file_path}"')
+            with preserve_keys(self.shell.user_ns, '__file__'):
+                self.shell.user_ns['__file__'] = temp_file_path
+                self.safe_execfile_ipy(temp_file_path, raise_exceptions=True)
+
+    def safe_execfile_ipy(
+        self,
+        fname: str,
+        shell_futures: bool = False,
+        raise_exceptions: bool = False,
+    ) -> None:
+        """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
+
+        Parameters
+        ----------
+        fname : str
+            The name of the file to execute.  The filename must have a
+            .ipy or .ipynb extension.
+        shell_futures : bool (False)
+            If True, the code will share future statements with the interactive
+            shell. It will both be affected by previous __future__ imports, and
+            any __future__ imports in the code will affect the shell. If False,
+            __future__ imports are not shared in either direction.
+        raise_exceptions : bool (False)
+            If True raise exceptions everywhere.  Meant for testing.
+        """
+        fpath = Path(fname).expanduser().resolve()
+
+        # Make sure we can open the file
+        try:
+            with fpath.open('rb'):
+                pass
+        except Exception:
+            warn('Could not open file <%s> for safe execution.' % fpath)
+            return
+
+        # Find things also in current directory.  This is needed to mimic the
+        # behavior of running a script from the system command line, where
+        # Python inserts the script's directory into sys.path
+        dname = str(fpath.parent)
+
+        def get_cells() -> Any:
+            """generator for sequence of code blocks to run"""
+            if fpath.suffix == '.ipynb':
+                from nbformat import read
+                nb = read(fpath, as_version=4)
+                if not nb.cells:
+                    return
+                for cell in nb.cells:
+                    if cell.cell_type == 'code':
+                        if not cell.source.strip():
+                            continue
+                        if getattr(cell, 'metadata', {}).get('language', '') == 'sql':
+                            output_redirect = getattr(
+                                cell, 'metadata', {},
+                            ).get('output_variable', '') or ''
+                            if output_redirect:
+                                output_redirect = f' {output_redirect} <<'
+                            yield f'%%sql{output_redirect}\n{cell.source}'
+                        else:
+                            yield cell.source
+            else:
+                yield fpath.read_text(encoding='utf-8')
+
+        with prepended_to_syspath(dname):
+            try:
+                for cell in get_cells():
+                    result = self.shell.run_cell(
+                        cell, silent=True, shell_futures=shell_futures,
+                    )
+                    if raise_exceptions:
+                        result.raise_error()
+                    elif not result.success:
+                        break
+            except Exception:
+                if raise_exceptions:
+                    raise
+                self.shell.showtraceback()
+                warn('Unknown failure executing file: <%s>' % fpath)

singlestoredb/magics/run_shared.py

@@ -1,6 +1,8 @@
 import os
 import tempfile
+from pathlib import Path
 from typing import Any
+from warnings import warn
 
 from IPython.core.interactiveshell import InteractiveShell
 from IPython.core.magic import line_magic
@@ -8,6 +10,8 @@ from IPython.core.magic import Magics
 from IPython.core.magic import magics_class
 from IPython.core.magic import needs_local_scope
 from IPython.core.magic import no_var_expand
+from IPython.utils.contexts import preserve_keys
+from IPython.utils.syspathcontext import prepended_to_syspath
 from jinja2 import Template
 
 
@@ -50,4 +54,81 @@ class RunSharedMagic(Magics):
             # Execute the SQL command
             self.shell.run_line_magic('sql', sql_command)
             # Run the downloaded file
-            self.shell.run_line_magic('run', f'"{temp_file_path}"')
+            with preserve_keys(self.shell.user_ns, '__file__'):
+                self.shell.user_ns['__file__'] = temp_file_path
+                self.safe_execfile_ipy(temp_file_path, raise_exceptions=True)
+
+    def safe_execfile_ipy(
+        self,
+        fname: str,
+        shell_futures: bool = False,
+        raise_exceptions: bool = False,
+    ) -> None:
+        """Like safe_execfile, but for .ipy or .ipynb files with IPython syntax.
+
+        Parameters
+        ----------
+        fname : str
+            The name of the file to execute.  The filename must have a
+            .ipy or .ipynb extension.
+        shell_futures : bool (False)
+            If True, the code will share future statements with the interactive
+            shell. It will both be affected by previous __future__ imports, and
+            any __future__ imports in the code will affect the shell. If False,
+            __future__ imports are not shared in either direction.
+        raise_exceptions : bool (False)
+            If True raise exceptions everywhere.  Meant for testing.
+        """
+        fpath = Path(fname).expanduser().resolve()
+
+        # Make sure we can open the file
+        try:
+            with fpath.open('rb'):
+                pass
+        except Exception:
+            warn('Could not open file <%s> for safe execution.' % fpath)
+            return
+
+        # Find things also in current directory.  This is needed to mimic the
+        # behavior of running a script from the system command line, where
+        # Python inserts the script's directory into sys.path
+        dname = str(fpath.parent)
+
+        def get_cells() -> Any:
+            """generator for sequence of code blocks to run"""
+            if fpath.suffix == '.ipynb':
+                from nbformat import read
+                nb = read(fpath, as_version=4)
+                if not nb.cells:
+                    return
+                for cell in nb.cells:
+                    if cell.cell_type == 'code':
+                        if not cell.source.strip():
+                            continue
+                        if getattr(cell, 'metadata', {}).get('language', '') == 'sql':
+                            output_redirect = getattr(
+                                cell, 'metadata', {},
+                            ).get('output_variable', '') or ''
+                            if output_redirect:
+                                output_redirect = f' {output_redirect} <<'
+                            yield f'%%sql{output_redirect}\n{cell.source}'
+                        else:
+                            yield cell.source
+            else:
+                yield fpath.read_text(encoding='utf-8')
+
+        with prepended_to_syspath(dname):
+            try:
+                for cell in get_cells():
+                    result = self.shell.run_cell(
+                        cell, silent=True, shell_futures=shell_futures,
+                    )
+                    if raise_exceptions:
+                        result.raise_error()
+                    elif not result.success:
+                        break
+            except Exception:
+                if raise_exceptions:
+                    raise
+                self.shell.showtraceback()
+                warn('Unknown failure executing file: <%s>' % fpath)

singlestoredb/management/__init__.py

@@ -2,6 +2,7 @@
 from .cluster import manage_cluster
 from .files import manage_files
 from .manager import get_token
+from .region import manage_regions
 from .workspace import get_organization
 from .workspace import get_secret
 from .workspace import get_stage

singlestoredb/management/cluster.py

@@ -390,7 +390,7 @@ class ClusterManager(Manager):
         :class:`Cluster`
 
         """
-        if isinstance(region, Region):
+        if isinstance(region, Region) and region.id:
             region = region.id
         res = self._post(
             'clusters', json=dict(

singlestoredb/management/manager.py

@@ -148,7 +148,9 @@ class Manager(object):
 
         """
         if self._params:
-            kwargs['params'] = self._params
+            params = dict(self._params)
+            params.update(kwargs.get('params', {}))
+            kwargs['params'] = params
         set_organization(kwargs)
         return self._check(self._doit('get', path, *args, **kwargs), path, kwargs)
 
@@ -171,7 +173,9 @@ class Manager(object):
 
         """
         if self._params:
-            kwargs['params'] = self._params
+            params = dict(self._params)
+            params.update(kwargs.get('params', {}))
+            kwargs['params'] = params
         set_organization(kwargs)
         return self._check(self._doit('post', path, *args, **kwargs), path, kwargs)
 
@@ -194,7 +198,9 @@ class Manager(object):
 
         """
         if self._params:
-            kwargs['params'] = self._params
+            params = dict(self._params)
+            params.update(kwargs.get('params', {}))
+            kwargs['params'] = params
         set_organization(kwargs)
         return self._check(self._doit('put', path, *args, **kwargs), path, kwargs)
 
@@ -217,7 +223,9 @@ class Manager(object):
 
         """
         if self._params:
-            kwargs['params'] = self._params
+            params = dict(self._params)
+            params.update(kwargs.get('params', {}))
+            kwargs['params'] = params
         set_organization(kwargs)
         return self._check(self._doit('delete', path, *args, **kwargs), path, kwargs)
 
@@ -240,7 +248,9 @@ class Manager(object):
 
         """
         if self._params:
-            kwargs['params'] = self._params
+            params = dict(self._params)
+            params.update(kwargs.get('params', {}))
+            kwargs['params'] = params
         set_organization(kwargs)
         return self._check(self._doit('patch', path, *args, **kwargs), path, kwargs)
 

singlestoredb/management/region.py

@@ -4,6 +4,7 @@ from typing import Dict
 from typing import Optional
 
 from .manager import Manager
+from .utils import NamedList
 from .utils import vars_to_str
 
 
@@ -20,7 +21,10 @@ class Region(object):
 
     """
 
-    def __init__(self, id: str, name: str, provider: str):
+    def __init__(
+        self, name: str, provider: str, id: Optional[str] = None,
+        region_name: Optional[str] = None,
+    ) -> None:
         """Use :attr:`WorkspaceManager.regions` instead."""
         #: Unique ID of the region
         self.id = id
@@ -31,6 +35,9 @@ class Region(object):
         #: Name of the cloud provider
         self.provider = provider
 
+        #: Name of the provider region
+        self.region_name = region_name
+
         self._manager: Optional[Manager] = None
 
     def __str__(self) -> str:
@@ -58,10 +65,105 @@ class Region(object):
         :class:`Region`
 
         """
+        id = obj.get('regionID', None)
+        region_name = obj.get('regionName', None)
+
         out = cls(
-            id=obj['regionID'],
+            id=id,
             name=obj['region'],
             provider=obj['provider'],
+            region_name=region_name,
         )
         out._manager = manager
         return out
+
+
+class RegionManager(Manager):
+    """
+    SingleStoreDB region manager.
+
+    This class should be instantiated using :func:`singlestoredb.manage_regions`.
+
+    Parameters
+    ----------
+    access_token : str, optional
+        The API key or other access token for the workspace management API
+    version : str, optional
+        Version of the API to use
+    base_url : str, optional
+        Base URL of the workspace management API
+
+    See Also
+    --------
+    :func:`singlestoredb.manage_regions`
+    """
+
+    #: Object type
+    obj_type = 'region'
+
+    def list_regions(self) -> NamedList[Region]:
+        """
+        List all available regions.
+
+        Returns
+        -------
+        NamedList[Region]
+            List of available regions
+
+        Raises
+        ------
+        ManagementError
+            If there is an error getting the regions
+        """
+        res = self._get('regions')
+        return NamedList(
+            [Region.from_dict(item, self) for item in res.json()],
+        )
+
+    def list_shared_tier_regions(self) -> NamedList[Region]:
+        """
+        List regions that support shared tier workspaces.
+
+        Returns
+        -------
+        NamedList[Region]
+            List of regions that support shared tier workspaces
+
+        Raises
+        ------
+        ManagementError
+            If there is an error getting the regions
+        """
+        res = self._get('regions/sharedtier')
+        return NamedList(
+            [Region.from_dict(item, self) for item in res.json()],
+        )
+
+
+def manage_regions(
+    access_token: Optional[str] = None,
+    version: Optional[str] = None,
+    base_url: Optional[str] = None,
+) -> RegionManager:
+    """
+    Retrieve a SingleStoreDB region manager.
+
+    Parameters
+    ----------
+    access_token : str, optional
+        The API key or other access token for the workspace management API
+    version : str, optional
+        Version of the API to use
+    base_url : str, optional
+        Base URL of the workspace management API
+
+    Returns
+    -------
+    :class:`RegionManager`
+
+    """
+    return RegionManager(
+        access_token=access_token,
+        version=version,
+        base_url=base_url,
+    )