singlestoredb 1.9.0__tar.gz → 1.11.0__tar.gz

{singlestoredb-1.9.0/singlestoredb.egg-info → singlestoredb-1.11.0}/PKG-INFO

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

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = singlestoredb
-version = 1.9.0
+version = 1.11.0
 description = Interface to the SingleStoreDB database and workspace management APIs
 long_description = file: README.md
 long_description_content_type = text/markdown

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/singlestoredb/__init__.py

@@ -13,7 +13,7 @@ Examples
 
 """
 
-__version__ = '1.9.0'
+__version__ = '1.11.0'
 
 from typing import Any
 

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/singlestoredb/fusion/handler.py

@@ -641,13 +641,6 @@ class SQLHandler(NodeVisitor):
         DummySQLResult
 
         """
-        import warnings
-        warnings.warn(
-            'Fusion SQL is currently a preview feature. '
-            'Run `SHOW FUSION COMMANDS` to see all commands.',
-            RuntimeWarning,
-        )
-
         type(self).compile()
         self._handled = set()
         try:

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/singlestoredb/fusion/handlers/export.py

@@ -55,10 +55,10 @@ class CreateClusterIdentity(SQLHandler):
 
         CREATE CLUSTER IDENTITY
             CATALOG CONFIG '{
-                "type": "GLUE",
+                "catalog_type": "GLUE",
                 "table_format": "ICEBERG",
-                "id": "13983498723498",
-                "region": "us-east-1"
+                "catalog_id": "13983498723498",
+                "catalog_region": "us-east-1"
             }'
             LINK S3 CONFIG '{
                 "region": "us-east-1",
@@ -78,6 +78,8 @@ class CreateClusterIdentity(SQLHandler):
         storage_config = json.loads(params['storage'].get('link_config', '{}') or '{}')
         storage_creds = json.loads(params['storage'].get('link_creds', '{}') or '{}')
 
+        storage_config['provider'] = 'S3'
+
         wsg = get_workspace_group({})
 
         if wsg._manager is None:
@@ -145,12 +147,12 @@ class CreateExport(SQLHandler):
     catalog and link configurations. The source table to export is
     named "customer_data"::
 
-        START EXPORT FROM customer_data
+        START EXPORT FROM my_db.customer_data
             CATALOG CONFIG '{
-                "type": "GLUE",
+                "catalog_type": "GLUE",
                 "table_format": "ICEBERG",
-                "id": "13983498723498",
-                "region": "us-east-1"
+                "catalog_id": "13983498723498",
+                "catalog_region": "us-east-1"
             }'
             LINK S3 CONFIG '{
                 "region": "us-east-1",
@@ -177,6 +179,8 @@ class CreateExport(SQLHandler):
         storage_config = json.loads(params['storage'].get('link_config', '{}') or '{}')
         storage_creds = json.loads(params['storage'].get('link_creds', '{}') or '{}')
 
+        storage_config['provider'] = 'S3'
+
         wsg = get_workspace_group({})
 
         if from_database is None:

singlestoredb-1.11.0/singlestoredb/fusion/handlers/models.py

@@ -0,0 +1,250 @@
+#!/usr/bin/env python3
+import os
+from typing import Any
+from typing import Dict
+from typing import Optional
+
+from ..handler import SQLHandler
+from ..result import FusionSQLResult
+from .files import ShowFilesHandler
+from .utils import get_file_space
+
+
+class ShowModelsHandler(ShowFilesHandler):
+    """
+    SHOW MODELS
+        [ at_path ] [ <like> ]
+        [ <order-by> ]
+        [ <limit> ] [ recursive ] [ extended ];
+
+    # File path to list
+    at_path = AT '<path>'
+
+    # Should the listing be recursive?
+    recursive = RECURSIVE
+
+    # Should extended attributes be shown?
+    extended = EXTENDED
+
+    Description
+    -----------
+    Displays the list of models in models space.
+
+    Arguments
+    ---------
+    * ``<path>``: A path in the models space.
+    * ``<pattern>``: A pattern similar to SQL LIKE clause.
+      Uses ``%`` as the wildcard character.
+
+    Remarks
+    -------
+    * Use the ``LIKE`` clause to specify a pattern and return only the
+      files that match the specified pattern.
+    * The ``LIMIT`` clause limits the number of results to the
+      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
+      space to list the files from.
+    * To return more information about the files, use the ``EXTENDED``
+      clause.
+
+    Examples
+    --------
+    The following command lists the models::
+
+        SHOW MODELS;
+
+    The following command lists the models with additional information::
+
+        SHOW MODELS EXTENDED;
+
+    See Also
+    --------
+    * ``UPLOAD MODEL model_name FROM path``
+    * ``DOWNLOAD MODEL model_name``
+
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        return super().run(params)
+
+
+ShowModelsHandler.register(overwrite=True)
+
+
+class UploadModelHandler(SQLHandler):
+    """
+    UPLOAD MODEL model_name
+        FROM local_path [ overwrite ];
+
+    # Model Name
+    model_name = '<model-name>'
+
+    # Path to local file or directory
+    local_path = '<local-path>'
+
+    # Should an existing file be overwritten?
+    overwrite = OVERWRITE
+
+    Description
+    -----------
+    Uploads a file or folder to models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name.
+    * ``<local-path>``: The path to the file or folder to upload in the local
+      directory.
+
+    Remarks
+    -------
+    * If the ``OVERWRITE`` clause is specified, any existing file at the
+      specified path in the models space is overwritten.
+
+    Examples
+    --------
+    The following command uploads a file to models space and overwrite any
+    existing files at the specified path::
+
+        UPLOAD MODEL model_name
+            FROM 'llama3/' OVERWRITE;
+
+    See Also
+    --------
+    * ``DOWNLOAD MODEL model_name``
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        model_name = params['model_name']
+        local_path = params['local_path']
+
+        file_space = get_file_space(params)
+
+        if os.path.isdir(local_path):
+            file_space.upload_folder(
+                local_path=local_path,
+                path=os.path.join(model_name, ''),
+                overwrite=params['overwrite'],
+            )
+        else:
+            file_space.upload_file(
+                local_path=local_path,
+                path=os.path.join(model_name, local_path),
+                overwrite=params['overwrite'],
+            )
+
+        return None
+
+
+UploadModelHandler.register(overwrite=True)
+
+
+class DownloadModelHandler(SQLHandler):
+    """
+    DOWNLOAD MODEL model_name
+        [ local_path ]
+        [ overwrite ];
+
+    # Model Name
+    model_name = '<model-name>'
+
+    # Path to local directory
+    local_path = TO '<local-path>'
+
+    # Should an existing directory be overwritten?
+    overwrite = OVERWRITE
+
+    Description
+    -----------
+    Download a model from models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name to download in models space.
+    * ``<local-path>``: Specifies the path in the local directory
+      where the model is downloaded.
+
+    Remarks
+    -------
+    * If the ``OVERWRITE`` clause is specified, any existing file or folder at
+      the download location is overwritten.
+    * If ``<local-path>`` is not specified, the model is downloaded to the current location.
+
+    Examples
+    --------
+    The following command displays the contents of the file on the
+    standard output::
+
+        DOWNLOAD MODEL llama3;
+
+    The following command downloads a model to a specific location and
+    overwrites any existing models folder with the name ``local_llama3`` on the local storage::
+
+        DOWNLOAD MODEL llama3
+            TO 'local_llama3' OVERWRITE;
+
+    See Also
+    --------
+    * ``UPLOAD MODEL model_name FROM local_path``
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+
+        file_space = get_file_space(params)
+
+        model_name = params['model_name']
+        file_space.download_folder(
+            path=os.path.join(model_name, ''),
+            local_path=params['local_path'] or model_name,
+            overwrite=params['overwrite'],
+        )
+
+        return None
+
+
+DownloadModelHandler.register(overwrite=True)
+
+
+class DropModelsHandler(SQLHandler):
+    """
+    DROP MODEL model_name;
+
+    # Model Name
+    model_name = '<model-name>'
+
+    Description
+    -----------
+    Deletes a model from models space.
+
+    Arguments
+    ---------
+    * ``<model-name>``: Model name to delete in models space.
+
+    Example
+    --------
+    The following commands deletes a model from a model space::
+
+        DROP MODEL llama3;
+
+    """  # noqa: E501
+
+    def run(self, params: Dict[str, Any]) -> Optional[FusionSQLResult]:
+        params['file_location'] = 'MODELS'
+        path = os.path.join(params['model_name'], '')
+
+        file_space = get_file_space(params)
+        file_space.removedirs(path=path)
+
+        return None
+
+
+DropModelsHandler.register(overwrite=True)

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/singlestoredb/fusion/handlers/utils.py

@@ -11,6 +11,7 @@ from ...management import manage_workspaces
 from ...management.files import FilesManager
 from ...management.files import FileSpace
 from ...management.files import manage_files
+from ...management.files import MODELS_SPACE
 from ...management.files import PERSONAL_SPACE
 from ...management.files import SHARED_SPACE
 from ...management.workspace import StarterWorkspace
@@ -296,15 +297,14 @@ def get_file_space(params: Dict[str, Any]) -> FileSpace:
     file_location = params.get('file_location')
     if file_location:
         file_location_lower_case = file_location.lower()
-        if (
-            file_location_lower_case != PERSONAL_SPACE and
-            file_location_lower_case != SHARED_SPACE
-        ):
-            raise ValueError(f'invalid file location: {file_location}')
 
         if file_location_lower_case == PERSONAL_SPACE:
             return manager.personal_space
         elif file_location_lower_case == SHARED_SPACE:
             return manager.shared_space
+        elif file_location_lower_case == MODELS_SPACE:
+            return manager.models_space
+        else:
+            raise ValueError(f'invalid file location: {file_location}')
 
     raise KeyError('no file space was specified')

singlestoredb-1.11.0/singlestoredb/magics/__init__.py

@@ -0,0 +1,34 @@
+from IPython.core.interactiveshell import InteractiveShell
+
+from .run_personal import RunPersonalMagic
+from .run_shared import RunSharedMagic
+
+# In order to actually use these magics, we must register them with a
+# running IPython.
+
+
+def load_ipython_extension(ip: InteractiveShell) -> None:
+    """
+    Any module file that define a function named `load_ipython_extension`
+    can be loaded via `%load_ext module.path` or be configured to be
+    autoloaded by IPython at startup time.
+    """
+
+    # Load jupysql extension
+    # This is necessary for jupysql to initialize internal state
+    # required to render messages
+    assert ip.extension_manager is not None
+    result = ip.extension_manager.load_extension('sql')
+    if result == 'no load function':
+        raise RuntimeError('Could not load sql extension. Is jupysql installed?')
+
+    # Check if %run magic command is defined
+    if ip.find_line_magic('run') is None:
+        raise RuntimeError(
+            '%run magic command is not defined. '
+            'Is it available in your IPython environment?',
+        )
+
+    # Register run_personal and run_shared
+    ip.register_magics(RunPersonalMagic(ip))
+    ip.register_magics(RunSharedMagic(ip))

singlestoredb-1.11.0/singlestoredb/magics/run_personal.py

@@ -0,0 +1,56 @@
+import os
+import tempfile
+from typing import Any
+
+from IPython.core.interactiveshell import InteractiveShell
+from IPython.core.magic import line_magic
+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 jinja2 import Template
+
+
+@magics_class
+class RunPersonalMagic(Magics):
+    def __init__(self, shell: InteractiveShell):
+        Magics.__init__(self, shell=shell)
+
+    @no_var_expand
+    @needs_local_scope
+    @line_magic('run_personal')
+    def run_personal(self, line: str, local_ns: Any = None) -> Any:
+        """
+        Downloads a personal file using the %sql magic and then runs it using %run.
+
+        Examples::
+
+          # Line usage
+
+          %run_personal personal_file.ipynb
+
+          %run_personal {{ sample_notebook_name }}
+
+        """
+
+        template = Template(line.strip())
+        personal_file = template.render(local_ns)
+        if not personal_file:
+            raise ValueError('No personal file specified.')
+        if (personal_file.startswith("'") and personal_file.endswith("'")) or \
+           (personal_file.startswith('"') and personal_file.endswith('"')):
+            personal_file = personal_file[1:-1]
+            if not personal_file:
+                raise ValueError('No personal file specified.')
+
+        with tempfile.TemporaryDirectory() as temp_dir:
+            temp_file_path = os.path.join(temp_dir, personal_file)
+            sql_command = (
+                f"DOWNLOAD PERSONAL FILE '{personal_file}' "
+                f"TO '{temp_file_path}'"
+            )
+
+            # 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}"')

singlestoredb-1.11.0/singlestoredb/magics/run_shared.py

@@ -0,0 +1,53 @@
+import os
+import tempfile
+from typing import Any
+
+from IPython.core.interactiveshell import InteractiveShell
+from IPython.core.magic import line_magic
+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 jinja2 import Template
+
+
+@magics_class
+class RunSharedMagic(Magics):
+    def __init__(self, shell: InteractiveShell):
+        Magics.__init__(self, shell=shell)
+
+    @no_var_expand
+    @needs_local_scope
+    @line_magic('run_shared')
+    def run_shared(self, line: str, local_ns: Any = None) -> Any:
+        """
+        Downloads a shared file using the %sql magic and then runs it using %run.
+
+        Examples::
+
+          # Line usage
+
+          %run_shared shared_file.ipynb
+
+          %run_shared {{ sample_notebook_name }}
+
+        """
+
+        template = Template(line.strip())
+        shared_file = template.render(local_ns)
+        if not shared_file:
+            raise ValueError('No shared file specified.')
+        if (shared_file.startswith("'") and shared_file.endswith("'")) or \
+           (shared_file.startswith('"') and shared_file.endswith('"')):
+            shared_file = shared_file[1:-1]
+            if not shared_file:
+                raise ValueError('No personal file specified.')
+
+        with tempfile.TemporaryDirectory() as temp_dir:
+            temp_file_path = os.path.join(temp_dir, shared_file)
+            sql_command = f"DOWNLOAD SHARED FILE '{shared_file}' TO '{temp_file_path}'"
+
+            # 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}"')

{singlestoredb-1.9.0 → singlestoredb-1.11.0}/singlestoredb/management/cluster.py

@@ -333,7 +333,8 @@ class ClusterManager(Manager):
     default_version = 'v0beta'
 
     #: Base URL if none is specified.
-    default_base_url = config.get_option('management.base_url')
+    default_base_url = config.get_option('management.base_url') \
+        or 'https://api.singlestore.com'
 
     #: Object type
     obj_type = 'cluster'