From 2e5ca0156c4ca379ced197bca6db62e2daefb33a Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Wed, 16 Oct 2024 14:35:38 -0500 Subject: [PATCH] Prepare for release v1.7.2 --- docs/.buildinfo | 2 +- docs/_sources/whatsnew.rst.txt | 3 + docs/_static/documentation_options.js | 2 +- docs/api.html | 6 +- .../generated/singlestoredb.auth.get_jwt.html | 20 ++--- docs/generated/singlestoredb.connect.html | 70 +++++++++--------- ...redb.connection.Connection.autocommit.html | 8 +- ...lestoredb.connection.Connection.close.html | 8 +- ...estoredb.connection.Connection.commit.html | 8 +- ...estoredb.connection.Connection.cursor.html | 6 +- ...onnection.Connection.disable_data_api.html | 8 +- ...connection.Connection.enable_data_api.html | 12 +-- .../singlestoredb.connection.Connection.html | 10 +-- ...db.connection.Connection.is_connected.html | 10 +-- ...toredb.connection.Connection.rollback.html | 8 +- ...glestoredb.connection.Cursor.callproc.html | 10 +-- ...singlestoredb.connection.Cursor.close.html | 8 +- ...nglestoredb.connection.Cursor.execute.html | 14 ++-- ...storedb.connection.Cursor.executemany.html | 10 +-- ...glestoredb.connection.Cursor.fetchall.html | 8 +- ...lestoredb.connection.Cursor.fetchmany.html | 10 +-- ...glestoredb.connection.Cursor.fetchone.html | 10 +-- .../singlestoredb.connection.Cursor.html | 6 +- ...toredb.connection.Cursor.is_connected.html | 8 +- .../singlestoredb.connection.Cursor.next.html | 12 +-- ...nglestoredb.connection.Cursor.nextset.html | 8 +- ...inglestoredb.connection.Cursor.scroll.html | 12 +-- ...oredb.connection.Cursor.setinputsizes.html | 8 +- ...oredb.connection.Cursor.setoutputsize.html | 8 +- ...db.connection.ShowAccessor.aggregates.html | 6 +- ...oredb.connection.ShowAccessor.columns.html | 8 +- ...nection.ShowAccessor.create_aggregate.html | 8 +- ...nnection.ShowAccessor.create_function.html | 8 +- ...nnection.ShowAccessor.create_pipeline.html | 8 +- ....connection.ShowAccessor.create_table.html | 8 +- ...b.connection.ShowAccessor.create_view.html | 8 +- ...nnection.ShowAccessor.database_status.html | 6 +- ...edb.connection.ShowAccessor.databases.html | 8 +- ...toredb.connection.ShowAccessor.errors.html | 6 +- ...edb.connection.ShowAccessor.functions.html | 6 +- ...connection.ShowAccessor.global_status.html | 6 +- ...oredb.connection.ShowAccessor.indexes.html | 8 +- ...db.connection.ShowAccessor.partitions.html | 8 +- ...edb.connection.ShowAccessor.pipelines.html | 6 +- ...estoredb.connection.ShowAccessor.plan.html | 8 +- ...edb.connection.ShowAccessor.plancache.html | 6 +- ...db.connection.ShowAccessor.procedures.html | 6 +- ...b.connection.ShowAccessor.processlist.html | 6 +- ....connection.ShowAccessor.reproduction.html | 8 +- ...oredb.connection.ShowAccessor.schemas.html | 6 +- ...onnection.ShowAccessor.session_status.html | 6 +- ...toredb.connection.ShowAccessor.status.html | 8 +- ....connection.ShowAccessor.table_status.html | 6 +- ...toredb.connection.ShowAccessor.tables.html | 8 +- ...redb.connection.ShowAccessor.warnings.html | 6 +- .../singlestoredb.connection.ShowResult.html | 10 +-- .../singlestoredb.create_engine.html | 10 +-- .../singlestoredb.describe_option.html | 8 +- docs/generated/singlestoredb.get_option.html | 10 +-- .../singlestoredb.manage_workspaces.html | 16 ++-- ...inglestoredb.management.region.Region.html | 10 +-- ...agement.workspace.Stage.download_file.html | 16 ++-- ...ement.workspace.Stage.download_folder.html | 14 ++-- ...edb.management.workspace.Stage.exists.html | 12 +-- ...glestoredb.management.workspace.Stage.html | 6 +- ...oredb.management.workspace.Stage.info.html | 10 +-- ...edb.management.workspace.Stage.is_dir.html | 12 +-- ...db.management.workspace.Stage.is_file.html | 12 +-- ...db.management.workspace.Stage.listdir.html | 12 +-- ...redb.management.workspace.Stage.mkdir.html | 12 +-- ...oredb.management.workspace.Stage.open.html | 14 ++-- ...edb.management.workspace.Stage.remove.html | 10 +-- ...management.workspace.Stage.removedirs.html | 10 +-- ...edb.management.workspace.Stage.rename.html | 8 +- ...redb.management.workspace.Stage.rmdir.html | 10 +-- ...anagement.workspace.Stage.upload_file.html | 14 ++-- ...agement.workspace.Stage.upload_folder.html | 20 ++--- ...agement.workspace.StageObject.abspath.html | 8 +- ...gement.workspace.StageObject.basename.html | 8 +- ...agement.workspace.StageObject.dirname.html | 8 +- ...gement.workspace.StageObject.download.html | 16 ++-- ...nagement.workspace.StageObject.exists.html | 8 +- ...gement.workspace.StageObject.getctime.html | 8 +- ...gement.workspace.StageObject.getmtime.html | 8 +- ...redb.management.workspace.StageObject.html | 10 +-- ...nagement.workspace.StageObject.is_dir.html | 8 +- ...agement.workspace.StageObject.is_file.html | 8 +- ...management.workspace.StageObject.open.html | 12 +-- ...nagement.workspace.StageObject.remove.html | 8 +- ...ment.workspace.StageObject.removedirs.html | 8 +- ...nagement.workspace.StageObject.rename.html | 12 +-- ...anagement.workspace.StageObject.rmdir.html | 8 +- ...anagement.workspace.Workspace.connect.html | 8 +- ...toredb.management.workspace.Workspace.html | 10 +-- ...anagement.workspace.Workspace.refresh.html | 6 +- ...agement.workspace.Workspace.terminate.html | 16 ++-- ...management.workspace.Workspace.update.html | 16 ++-- ...space.WorkspaceGroup.create_workspace.html | 24 +++--- ...b.management.workspace.WorkspaceGroup.html | 10 +-- ...ment.workspace.WorkspaceGroup.refresh.html | 6 +- ...gement.workspace.WorkspaceGroup.stage.html | 6 +- ...nt.workspace.WorkspaceGroup.terminate.html | 16 ++-- ...ement.workspace.WorkspaceGroup.update.html | 20 ++--- ...t.workspace.WorkspaceGroup.workspaces.html | 6 +- ...ace.WorkspaceManager.create_workspace.html | 26 +++---- ...rkspaceManager.create_workspace_group.html | 28 +++---- ...kspace.WorkspaceManager.get_workspace.html | 10 +-- ....WorkspaceManager.get_workspace_group.html | 10 +-- ...management.workspace.WorkspaceManager.html | 16 ++-- ...rkspace.WorkspaceManager.organization.html | 6 +- ...nt.workspace.WorkspaceManager.regions.html | 6 +- ...ace.WorkspaceManager.workspace_groups.html | 6 +- .../singlestoredb.notebook.organization.html | 6 +- .../singlestoredb.notebook.secrets.html | 6 +- .../singlestoredb.notebook.stage.html | 6 +- .../singlestoredb.notebook.workspace.html | 6 +- ...inglestoredb.notebook.workspace_group.html | 6 +- docs/generated/singlestoredb.set_option.html | 12 +-- docs/genindex.html | 6 +- docs/getting-started.html | 6 +- docs/index.html | 7 +- docs/install.html | 6 +- docs/license.html | 6 +- docs/objects.inv | Bin 2842 -> 2842 bytes docs/py-modindex.html | 6 +- docs/search.html | 6 +- docs/searchindex.js | 2 +- docs/src/whatsnew.rst | 4 + docs/whatsnew.html | 13 +++- setup.cfg | 2 +- singlestoredb/__init__.py | 2 +- 131 files changed, 632 insertions(+), 617 deletions(-) diff --git a/docs/.buildinfo b/docs/.buildinfo index 3b4b1158..eb3fcf77 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 5e9492c7800f374b8a5af720c0c5c9b6 +config: 302d9041c45882b3e6ed7f0e134bb942 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/whatsnew.rst.txt b/docs/_sources/whatsnew.rst.txt index dc7bfe3a..480f6eb2 100644 --- a/docs/_sources/whatsnew.rst.txt +++ b/docs/_sources/whatsnew.rst.txt @@ -5,6 +5,9 @@ This document outlines features and improvements from each release. .. note:: All releases before v1.0.0 are considered pre-release and are for non-production testing and evaluation, and may include changes to the API. +v1.7.2 - October 16, 2024 +------------------------- +* Fixes for apps v1.7.1 - September 20, 2024 --------------------------- * Fixes for apps diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index e1700708..14b8c00a 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '1.7.1', + VERSION: '1.7.2', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/api.html b/docs/api.html index 35b8aa19..a9fac0f9 100644 --- a/docs/api.html +++ b/docs/api.html @@ -3,14 +3,14 @@ - API Reference — SingleStoreDB 1.7.1 documentation + API Reference — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.7.1 + 1.7.2
diff --git a/docs/generated/singlestoredb.auth.get_jwt.html b/docs/generated/singlestoredb.auth.get_jwt.html index 63e60e75..194ea989 100644 --- a/docs/generated/singlestoredb.auth.get_jwt.html +++ b/docs/generated/singlestoredb.auth.get_jwt.html @@ -3,14 +3,14 @@ - singlestoredb.auth.get_jwt — SingleStoreDB 1.7.1 documentation + singlestoredb.auth.get_jwt — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.7.1 + 1.7.2
@@ -85,17 +85,17 @@

singlestoredb.auth.get_jwt

-singlestoredb.auth.get_jwt(email: str, url: str = 'https://portal.singlestore.com/engine-sso', clusters: str | List[str] | None = None, databases: str | List[str] | None = None, timeout: int = 60, browser: str | List[str] | None = None) JSONWebToken
+singlestoredb.auth.get_jwt(email: str, url: str = 'https://portal.singlestore.com/engine-sso', clusters: str | List[str] | None = None, databases: str | List[str] | None = None, timeout: int = 60, browser: str | List[str] | None = None) JSONWebToken

Retrieve a JWT token from the SingleStoreDB single-sign-on URL.

Parameters:
    -
  • email (str) – EMail of the database user

  • -
  • url (str, optional) – The URL of the single-sign-on token generator

  • -
  • clusters (str or list[str], optional) – The name of the cluster being connected to

  • -
  • databases (str or list[str], optional) – The name of the database being connected to

  • -
  • timeout (int, optional) – Number of seconds to wait before timing out the authentication request

  • -
  • browser (str or list[str], optional) – Browser to use instead of the default. This value can be any of the +

  • email (str) – EMail of the database user

  • +
  • url (str, optional) – The URL of the single-sign-on token generator

  • +
  • clusters (str or list[str], optional) – The name of the cluster being connected to

  • +
  • databases (str or list[str], optional) – The name of the database being connected to

  • +
  • timeout (int, optional) – Number of seconds to wait before timing out the authentication request

  • +
  • browser (str or list[str], optional) – Browser to use instead of the default. This value can be any of the names specified in Python’s webbrowser module. This includes ‘google-chrome’, ‘chrome’, ‘chromium’, ‘chromium-browser’, ‘firefox’, etc. Note that at the time of this writing, Safari was not diff --git a/docs/generated/singlestoredb.connect.html b/docs/generated/singlestoredb.connect.html index d13a82dc..4a9e8770 100644 --- a/docs/generated/singlestoredb.connect.html +++ b/docs/generated/singlestoredb.connect.html @@ -3,14 +3,14 @@ - singlestoredb.connect — SingleStoreDB 1.7.1 documentation + singlestoredb.connect — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB

    - 1.7.1 + 1.7.2
    @@ -88,12 +88,12 @@

    singlestoredb.connect

    -singlestoredb.connect(host: str | None = None, user: str | None = None, password: str | None = None, port: int | None = None, database: str | None = None, driver: str | None = None, pure_python: bool | None = None, local_infile: bool | None = None, charset: str | None = None, ssl_key: str | None = None, ssl_cert: str | None = None, ssl_ca: str | None = None, ssl_disabled: bool | None = None, ssl_cipher: str | None = None, ssl_verify_cert: bool | None = None, ssl_verify_identity: bool | None = None, conv: Dict[int, Callable[[...], Any]] | None = None, credential_type: str | None = None, autocommit: bool | None = None, results_type: str | None = None, buffered: bool | None = None, results_format: str | None = None, program_name: str | None = None, conn_attrs: Dict[str, str] | None = None, multi_statements: bool | None = None, client_found_rows: bool | None = None, connect_timeout: int | None = None, nan_as_null: bool | None = None, inf_as_null: bool | None = None, encoding_errors: str | None = None, track_env: bool | None = None, enable_extended_data_types: bool | None = None, vector_data_format: str | None = None) Connection
    +singlestoredb.connect(host: str | None = None, user: str | None = None, password: str | None = None, port: int | None = None, database: str | None = None, driver: str | None = None, pure_python: bool | None = None, local_infile: bool | None = None, charset: str | None = None, ssl_key: str | None = None, ssl_cert: str | None = None, ssl_ca: str | None = None, ssl_disabled: bool | None = None, ssl_cipher: str | None = None, ssl_verify_cert: bool | None = None, ssl_verify_identity: bool | None = None, conv: Dict[int, Callable[[...], Any]] | None = None, credential_type: str | None = None, autocommit: bool | None = None, results_type: str | None = None, buffered: bool | None = None, results_format: str | None = None, program_name: str | None = None, conn_attrs: Dict[str, str] | None = None, multi_statements: bool | None = None, client_found_rows: bool | None = None, connect_timeout: int | None = None, nan_as_null: bool | None = None, inf_as_null: bool | None = None, encoding_errors: str | None = None, track_env: bool | None = None, enable_extended_data_types: bool | None = None, vector_data_format: str | None = None) Connection

    Return a SingleStoreDB connection.

    Parameters:
      -
    • host (str, optional) – Hostname, IP address, or URL that describes the connection. +

    • host (str, optional) – Hostname, IP address, or URL that describes the connection. The scheme or protocol defines which database connector to use. By default, the mysql scheme is used. To connect to the HTTP API, the scheme can be set to http or https. The username, @@ -102,45 +102,45 @@

      singlestoredb.connectscheme://user:password@host:port/db_name. The scheme can typically be left off (unless you are using the HTTP API): user:password@host:port/db_name.

    • -
    • user (str, optional) – Database user name

    • -
    • password (str, optional) – Database user password

    • -
    • port (int, optional) – Database port. This defaults to 3306 for non-HTTP connections, 80 +

    • user (str, optional) – Database user name

    • +
    • password (str, optional) – Database user password

    • +
    • port (int, optional) – Database port. This defaults to 3306 for non-HTTP connections, 80 for HTTP connections, and 443 for HTTPS connections.

    • -
    • database (str, optional) – Database name

    • -
    • pure_python (bool, optional) – Use the connector in pure Python mode

    • -
    • local_infile (bool, optional) – Allow local file uploads

    • -
    • charset (str, optional) – Character set for string values

    • -
    • ssl_key (str, optional) – File containing SSL key

    • -
    • ssl_cert (str, optional) – File containing SSL certificate

    • -
    • ssl_ca (str, optional) – File containing SSL certificate authority

    • -
    • ssl_cipher (str, optional) – Sets the SSL cipher list

    • -
    • ssl_disabled (bool, optional) – Disable SSL usage

    • -
    • ssl_verify_cert (bool, optional) – Verify the server’s certificate. This is automatically enabled if +

    • database (str, optional) – Database name

    • +
    • pure_python (bool, optional) – Use the connector in pure Python mode

    • +
    • local_infile (bool, optional) – Allow local file uploads

    • +
    • charset (str, optional) – Character set for string values

    • +
    • ssl_key (str, optional) – File containing SSL key

    • +
    • ssl_cert (str, optional) – File containing SSL certificate

    • +
    • ssl_ca (str, optional) – File containing SSL certificate authority

    • +
    • ssl_cipher (str, optional) – Sets the SSL cipher list

    • +
    • ssl_disabled (bool, optional) – Disable SSL usage

    • +
    • ssl_verify_cert (bool, optional) – Verify the server’s certificate. This is automatically enabled if ssl_ca is also specified.

    • -
    • ssl_verify_identity (bool, optional) – Verify the server’s identity

    • -
    • conv (dict[int, Callable], optional) – Dictionary of data conversion functions

    • -
    • credential_type (str, optional) – Type of authentication to use: auth.PASSWORD, auth.JWT, or auth.BROWSER_SSO

    • -
    • autocommit (bool, optional) – Enable autocommits

    • -
    • results_type (str, optional) – The form of the query results: tuples, namedtuples, dicts, +

    • ssl_verify_identity (bool, optional) – Verify the server’s identity

    • +
    • conv (dict[int, Callable], optional) – Dictionary of data conversion functions

    • +
    • credential_type (str, optional) – Type of authentication to use: auth.PASSWORD, auth.JWT, or auth.BROWSER_SSO

    • +
    • autocommit (bool, optional) – Enable autocommits

    • +
    • results_type (str, optional) – The form of the query results: tuples, namedtuples, dicts, numpy, polars, pandas, arrow

    • -
    • buffered (bool, optional) – Should the entire query result be buffered in memory? This is the default +

    • buffered (bool, optional) – Should the entire query result be buffered in memory? This is the default behavior which allows full cursor control of the result, but does consume more memory.

    • -
    • results_format (str, optional) – Deprecated. This option has been renamed to results_type.

    • -
    • program_name (str, optional) – Name of the program

    • -
    • conn_attrs (dict, optional) – Additional connection attributes for telemetry. Example: +

    • results_format (str, optional) – Deprecated. This option has been renamed to results_type.

    • +
    • program_name (str, optional) – Name of the program

    • +
    • conn_attrs (dict, optional) – Additional connection attributes for telemetry. Example: {‘program_version’: “1.0.2”, “_connector_name”: “dbt connector”}

    • -
    • multi_statements (bool, optional) – Should multiple statements be allowed within a single query?

    • -
    • connect_timeout (int, optional) – The timeout for connecting to the database in seconds. +

    • multi_statements (bool, optional) – Should multiple statements be allowed within a single query?

    • +
    • connect_timeout (int, optional) – The timeout for connecting to the database in seconds. (default: 10, min: 1, max: 31536000)

    • -
    • nan_as_null (bool, optional) – Should NaN values be treated as NULLs when used in parameter +

    • nan_as_null (bool, optional) – Should NaN values be treated as NULLs when used in parameter substitutions including uploaded data?

    • -
    • inf_as_null (bool, optional) – Should Inf values be treated as NULLs when used in parameter +

    • inf_as_null (bool, optional) – Should Inf values be treated as NULLs when used in parameter substitutions including uploaded data?

    • -
    • encoding_errors (str, optional) – The error handler name for value decoding errors

    • -
    • track_env (bool, optional) – 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

    • +
    • encoding_errors (str, optional) – The error handler name for value decoding errors

    • +
    • track_env (bool, optional) – 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

    diff --git a/docs/generated/singlestoredb.connection.Connection.autocommit.html b/docs/generated/singlestoredb.connection.Connection.autocommit.html index 3cb6e821..50c33b1f 100644 --- a/docs/generated/singlestoredb.connection.Connection.autocommit.html +++ b/docs/generated/singlestoredb.connection.Connection.autocommit.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.autocommit — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.autocommit — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection.autocommit

    -Connection.autocommit(value: bool = True) None
    +Connection.autocommit(value: bool = True) None

    Set autocommit mode.

    diff --git a/docs/generated/singlestoredb.connection.Connection.close.html b/docs/generated/singlestoredb.connection.Connection.close.html index 32cbc1a6..77c2fbdf 100644 --- a/docs/generated/singlestoredb.connection.Connection.close.html +++ b/docs/generated/singlestoredb.connection.Connection.close.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.close — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.close — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection.close

    -abstract Connection.close() None
    +abstract Connection.close() None

    Close the database connection.

    diff --git a/docs/generated/singlestoredb.connection.Connection.commit.html b/docs/generated/singlestoredb.connection.Connection.commit.html index 321eca30..5e580f9d 100644 --- a/docs/generated/singlestoredb.connection.Connection.commit.html +++ b/docs/generated/singlestoredb.connection.Connection.commit.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.commit — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.commit — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection.commit

    -abstract Connection.commit() None
    +abstract Connection.commit() None

    Commit the pending transaction.

    diff --git a/docs/generated/singlestoredb.connection.Connection.cursor.html b/docs/generated/singlestoredb.connection.Connection.cursor.html index f5fa6f09..c6dd1559 100644 --- a/docs/generated/singlestoredb.connection.Connection.cursor.html +++ b/docs/generated/singlestoredb.connection.Connection.cursor.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.cursor — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.cursor — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html index 3593dada..fc6f70b6 100644 --- a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.disable_data_api — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.disable_data_api — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection.disable_data_api

    -Connection.disable_data_api() None
    +Connection.disable_data_api() None

    Disable the data API.

    See also

    diff --git a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html index becd0a30..456b4cdc 100644 --- a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.enable_data_api — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.enable_data_api — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,13 +123,13 @@

    singlestoredb.connection.Connection.enable_data_api

    -Connection.enable_data_api(port: int | None = None) int
    +Connection.enable_data_api(port: int | None = None) int

    Enable the data API in the server.

    Use of this method requires privileges that allow setting global variables and starting the HTTP proxy.

    Parameters:
    -

    port (int, optional) – The port number that the HTTP server should run on. If this +

    port (int, optional) – The port number that the HTTP server should run on. If this value is not specified, the current value of the http_proxy_port is used.

    @@ -143,7 +143,7 @@

    singlestoredb.connection.Connection.enable_data_api

    port number of the HTTP server

    Return type:
    -

    int

    +

    int

    diff --git a/docs/generated/singlestoredb.connection.Connection.html b/docs/generated/singlestoredb.connection.Connection.html index 05a7c030..f7180d98 100644 --- a/docs/generated/singlestoredb.connection.Connection.html +++ b/docs/generated/singlestoredb.connection.Connection.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection

    -class singlestoredb.connection.Connection(**kwargs: Any)
    +class singlestoredb.connection.Connection(**kwargs: Any)

    SingleStoreDB connection.

    Instances of this object are typically created through the singlestoredb.connect() function rather than creating them directly. @@ -134,7 +134,7 @@

    singlestoredb.connection.Connection
    -__init__(**kwargs: Any)
    +__init__(**kwargs: Any)

    Call singlestoredb.connect() instead.

    Methods

    diff --git a/docs/generated/singlestoredb.connection.Connection.is_connected.html b/docs/generated/singlestoredb.connection.Connection.is_connected.html index 19a3b567..e564a90a 100644 --- a/docs/generated/singlestoredb.connection.Connection.is_connected.html +++ b/docs/generated/singlestoredb.connection.Connection.is_connected.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.is_connected — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.is_connected — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,11 +123,11 @@

    singlestoredb.connection.Connection.is_connected

    -abstract Connection.is_connected() bool
    +abstract Connection.is_connected() bool

    Determine if the database is still connected.

    Return type:
    -

    bool

    +

    bool

    diff --git a/docs/generated/singlestoredb.connection.Connection.rollback.html b/docs/generated/singlestoredb.connection.Connection.rollback.html index c3f0df7b..6a6a1f04 100644 --- a/docs/generated/singlestoredb.connection.Connection.rollback.html +++ b/docs/generated/singlestoredb.connection.Connection.rollback.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Connection.rollback — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Connection.rollback — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.Connection.rollback

    -abstract Connection.rollback() None
    +abstract Connection.rollback() None

    Rollback the pending transaction.

    diff --git a/docs/generated/singlestoredb.connection.Cursor.callproc.html b/docs/generated/singlestoredb.connection.Cursor.callproc.html index 34f46b82..cce0bcb5 100644 --- a/docs/generated/singlestoredb.connection.Cursor.callproc.html +++ b/docs/generated/singlestoredb.connection.Cursor.callproc.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.callproc — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.callproc — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.callproc

    -abstract Cursor.callproc(name: str, params: Sequence[Any] | None = None) None
    +abstract Cursor.callproc(name: str, params: Sequence[Any] | None = None) None

    Call a stored procedure.

    The result sets generated by a store procedure can be retrieved like the results of any other query using fetchone(), @@ -116,7 +116,7 @@

    singlestoredb.connection.Cursor.callproc
    Parameters:
      -
    • name (str) – Name of the stored procedure

    • +
    • name (str) – Name of the stored procedure

    • params (iterable, optional) – Parameters to the stored procedure

    diff --git a/docs/generated/singlestoredb.connection.Cursor.close.html b/docs/generated/singlestoredb.connection.Cursor.close.html index 121b47cb..ccd6512d 100644 --- a/docs/generated/singlestoredb.connection.Cursor.close.html +++ b/docs/generated/singlestoredb.connection.Cursor.close.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.close — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.close — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.close

    -abstract Cursor.close() None
    +abstract Cursor.close() None

    Close the cursor.

    diff --git a/docs/generated/singlestoredb.connection.Cursor.execute.html b/docs/generated/singlestoredb.connection.Cursor.execute.html index 1094586f..46b73f57 100644 --- a/docs/generated/singlestoredb.connection.Cursor.execute.html +++ b/docs/generated/singlestoredb.connection.Cursor.execute.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.execute — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.execute — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.execute

    -abstract Cursor.execute(query: str, args: Sequence[Any] | Dict[str, Any] | Any | None = None, infile_stream: RawIOBase | TextIOBase | Iterator[bytes | str] | Queue[bytes | str] | None = None) int
    +abstract Cursor.execute(query: str, args: Sequence[Any] | Dict[str, Any] | Any | None = None, infile_stream: RawIOBase | TextIOBase | Iterator[bytes | str] | Queue[bytes | str] | None = None) int

    Execute a SQL statement.

    Queries can use the format-style parameters (%s) when using a list of paramters or pyformat-style parameters (%(key)s) @@ -109,9 +109,9 @@

    singlestoredb.connection.Cursor.execute
    Parameters:
      -
    • query (str) – The SQL statement to execute

    • -
    • args (Sequence or dict, optional) – Parameters to substitute into the SQL code

    • -
    • infile_stream (io.RawIOBase or io.TextIOBase or Iterator[bytes|str], optional) – Data stream for LOCAL INFILE statement

    • +
    • query (str) – The SQL statement to execute

    • +
    • args (Sequence or dict, optional) – Parameters to substitute into the SQL code

    • +
    • infile_stream (io.RawIOBase or io.TextIOBase or Iterator[bytes|str], optional) – Data stream for LOCAL INFILE statement

    diff --git a/docs/generated/singlestoredb.connection.Cursor.executemany.html b/docs/generated/singlestoredb.connection.Cursor.executemany.html index d84d3a95..4840f391 100644 --- a/docs/generated/singlestoredb.connection.Cursor.executemany.html +++ b/docs/generated/singlestoredb.connection.Cursor.executemany.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.executemany — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.executemany — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.executemany

    -Cursor.executemany(query: str, args: Sequence[Sequence[Any] | Dict[str, Any] | Any] | None = None) int
    +Cursor.executemany(query: str, args: Sequence[Sequence[Any] | Dict[str, Any] | Any] | None = None) int

    Execute SQL code against multiple sets of parameters.

    Queries can use the format-style parameters (%s) when using lists of paramters or pyformat-style parameters (%(key)s) @@ -109,7 +109,7 @@

    singlestoredb.connection.Cursor.executemany
    Parameters:
      -
    • query (str) – The SQL statement to execute

    • +
    • query (str) – The SQL statement to execute

    • args (iterable of iterables or dicts, optional) – Sets of parameters to substitute into the SQL code

    diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchall.html b/docs/generated/singlestoredb.connection.Cursor.fetchall.html index ef45f3b5..174976af 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchall.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchall.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.fetchall — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.fetchall — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.fetchall

    -abstract Cursor.fetchall() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]]
    +abstract Cursor.fetchall() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]]

    Fetch all rows in the result set.

    Examples

    >>> for row in cur.fetchall():
    diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
    index 0db5c596..ac81e3c5 100644
    --- a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
    +++ b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
    @@ -3,14 +3,14 @@
     
       
       
    -  singlestoredb.connection.Cursor.fetchmany — SingleStoreDB 1.7.1 documentation
    +  singlestoredb.connection.Cursor.fetchmany — SingleStoreDB 1.7.2 documentation
           
           
           
       
    -        
    +        
             
             
         
    @@ -28,7 +28,7 @@
                 SingleStoreDB
               
                   
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.fetchmany

    -abstract Cursor.fetchmany(size: int | None = None) Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]]
    +abstract Cursor.fetchmany(size: int | None = None) Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]]

    Fetch size rows from the result.

    If size is not specified, the arraysize attribute is used.

    Examples

    @@ -118,7 +118,7 @@

    singlestoredb.connection.Cursor.fetchmany

    Values of the returned rows if there are rows remaining

    Return type:
    -

    list of tuples

    +

    list of tuples

    diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchone.html b/docs/generated/singlestoredb.connection.Cursor.fetchone.html index 10b14537..a2a9656c 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchone.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchone.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.fetchone — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.fetchone — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.fetchone

    -abstract Cursor.fetchone() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]] | None
    +abstract Cursor.fetchone() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]] | None

    Fetch a single row from the result set.

    Examples

    >>> while True:
    @@ -116,7 +116,7 @@ 

    singlestoredb.connection.Cursor.fetchone

    Values of the returned row if there are rows remaining

    Return type:
    -

    tuple

    +

    tuple

    diff --git a/docs/generated/singlestoredb.connection.Cursor.html b/docs/generated/singlestoredb.connection.Cursor.html index 328d1ba0..09690274 100644 --- a/docs/generated/singlestoredb.connection.Cursor.html +++ b/docs/generated/singlestoredb.connection.Cursor.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.Cursor.is_connected.html b/docs/generated/singlestoredb.connection.Cursor.is_connected.html index 3a0dbfbb..4a0407b7 100644 --- a/docs/generated/singlestoredb.connection.Cursor.is_connected.html +++ b/docs/generated/singlestoredb.connection.Cursor.is_connected.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.is_connected — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.is_connected — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.is_connected

    -abstract Cursor.is_connected() bool
    +abstract Cursor.is_connected() bool

    Is the cursor still connected?

    diff --git a/docs/generated/singlestoredb.connection.Cursor.next.html b/docs/generated/singlestoredb.connection.Cursor.next.html index 2b80788f..9d166afa 100644 --- a/docs/generated/singlestoredb.connection.Cursor.next.html +++ b/docs/generated/singlestoredb.connection.Cursor.next.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.next — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.next — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,14 +101,14 @@

    singlestoredb.connection.Cursor.next

    -Cursor.next() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]] | None
    +Cursor.next() Tuple[Any, ...] | Dict[str, Any] | np.ndarray | pd.DataFrame | pl.DataFrame | pa.Table | List[Tuple[Any, ...]] | List[Dict[str, Any]] | None

    Return the next row from the result set for use in iterators.

    Raises:
    -

    StopIteration – If no more results exist

    +

    StopIteration – If no more results exist

    Return type:
    -

    tuple of values

    +

    tuple of values

    diff --git a/docs/generated/singlestoredb.connection.Cursor.nextset.html b/docs/generated/singlestoredb.connection.Cursor.nextset.html index 82e8a116..c317b1ac 100644 --- a/docs/generated/singlestoredb.connection.Cursor.nextset.html +++ b/docs/generated/singlestoredb.connection.Cursor.nextset.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.nextset — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.nextset — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.nextset

    -abstract Cursor.nextset() bool | None
    +abstract Cursor.nextset() bool | None

    Skip to the next available result set.

    This is used when calling a procedure that returns multiple results sets.

    diff --git a/docs/generated/singlestoredb.connection.Cursor.scroll.html b/docs/generated/singlestoredb.connection.Cursor.scroll.html index b43b1c13..cdb0766a 100644 --- a/docs/generated/singlestoredb.connection.Cursor.scroll.html +++ b/docs/generated/singlestoredb.connection.Cursor.scroll.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.scroll — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.scroll — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,13 +101,13 @@

    singlestoredb.connection.Cursor.scroll

    -abstract Cursor.scroll(value: int, mode: str = 'relative') None
    +abstract Cursor.scroll(value: int, mode: str = 'relative') None

    Scroll the cursor to the position in the result set.

    Parameters:
      -
    • value (int) – Value of the positional move

    • -
    • mode (str) – Where to move the cursor from: ‘relative’ or ‘absolute’

    • +
    • value (int) – Value of the positional move

    • +
    • mode (str) – Where to move the cursor from: ‘relative’ or ‘absolute’

    diff --git a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html index e26fefcd..0ffef9a9 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html +++ b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.setinputsizes — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.setinputsizes — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.setinputsizes

    -abstract Cursor.setinputsizes(sizes: Sequence[int]) None
    +abstract Cursor.setinputsizes(sizes: Sequence[int]) None

    Predefine memory areas for parameters.

    diff --git a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html index fce1788c..97c60c12 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html +++ b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html @@ -3,14 +3,14 @@ - singlestoredb.connection.Cursor.setoutputsize — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.Cursor.setoutputsize — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -101,7 +101,7 @@

    singlestoredb.connection.Cursor.setoutputsize

    -abstract Cursor.setoutputsize(size: int, column: str | None = None) None
    +abstract Cursor.setoutputsize(size: int, column: str | None = None) None

    Set a column buffer size for fetches of large columns.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html index 4f489976..5f9b0db6 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.aggregates — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.aggregates — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html index 91e93387..cec2a3ac 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.columns — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.columns — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.columns

    -Connection.show.columns(table: str, full: bool = False) ShowResult
    +Connection.show.columns(table: str, full: bool = False) ShowResult

    Show the column information for the given table.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html index 01e20ac5..95b11736 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.create_aggregate — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.create_aggregate — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.create_aggregate

    -Connection.show.create_aggregate(name: str) ShowResult
    +Connection.show.create_aggregate(name: str) ShowResult

    Show the function creation code for the given aggregate function.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html index 4548b03e..cd570213 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.create_function — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.create_function — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.create_function

    -Connection.show.create_function(name: str) ShowResult
    +Connection.show.create_function(name: str) ShowResult

    Show the function creation code for the given function.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html index 67e3ba7d..f3581a4a 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.create_pipeline — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.create_pipeline — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.create_pipeline

    -Connection.show.create_pipeline(name: str, extended: bool = False) ShowResult
    +Connection.show.create_pipeline(name: str, extended: bool = False) ShowResult

    Show the pipeline creation code for the given pipeline.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html index 6e9cdc94..32a6af95 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.create_table — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.create_table — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.create_table

    -Connection.show.create_table(name: str) ShowResult
    +Connection.show.create_table(name: str) ShowResult

    Show the table creation code for the given table.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html index 45744d85..6ed2fdf7 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.create_view — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.create_view — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.create_view

    -Connection.show.create_view(name: str) ShowResult
    +Connection.show.create_view(name: str) ShowResult

    Show the view creation code for the given view.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html index f2d4d800..c3b43a20 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.database_status — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.database_status — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html index e27a934a..e979ac13 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.databases — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.databases — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.databases

    -Connection.show.databases(extended: bool = False) ShowResult
    +Connection.show.databases(extended: bool = False) ShowResult

    Show all databases in the server.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html index 685beb54..a2282573 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.errors — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.errors — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html index c2ab0c97..1016d131 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.functions — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.functions — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html index 1344c178..c71af7d3 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.global_status — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.global_status — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html index cd5381e1..d6738228 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.indexes — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.indexes — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.indexes

    -Connection.show.indexes(table: str) ShowResult
    +Connection.show.indexes(table: str) ShowResult

    Show all indexes in the given table.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html index 031d7dac..400a3d53 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.partitions — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.partitions — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.partitions

    -Connection.show.partitions(extended: bool = False) ShowResult
    +Connection.show.partitions(extended: bool = False) ShowResult

    Show partitions in the current database.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html index 86ac9c7e..ddda25a4 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.pipelines — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.pipelines — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html index 048503be..eaec9be2 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.plan — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.plan — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.plan

    -Connection.show.plan(plan_id: int, json: bool = False) ShowResult
    +Connection.show.plan(plan_id: int, json: bool = False) ShowResult

    Show the plan for the given plan ID.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html index 18439d4d..e692d62b 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.plancache — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.plancache — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html index 206d51bd..919fc76b 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.procedures — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.procedures — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html index d82d4904..c59a07a8 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.processlist — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.processlist — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html index 849b653f..c5651c1b 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.reproduction — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.reproduction — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.reproduction

    -Connection.show.reproduction(outfile: str | None = None) ShowResult
    +Connection.show.reproduction(outfile: str | None = None) ShowResult

    Show troubleshooting data for query optimizer and code generation.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html index 1accbdd4..0a717ac9 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.schemas — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.schemas — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html index a44fca08..12ab3de0 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.session_status — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.session_status — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.status.html b/docs/generated/singlestoredb.connection.ShowAccessor.status.html index f408eda3..672bcbed 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.status.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.status — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.status — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.status

    -Connection.show.status(extended: bool = False) ShowResult
    +Connection.show.status(extended: bool = False) ShowResult

    Show server status information.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html index f67f2d92..f7b8099e 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.table_status — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.table_status — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html index b3a95300..ca3baca1 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.tables — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.tables — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowAccessor.tables

    -Connection.show.tables(extended: bool = False) ShowResult
    +Connection.show.tables(extended: bool = False) ShowResult

    Show tables in the current database.

    diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html index bbcda8d3..f84d2459 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowAccessor.warnings — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowAccessor.warnings — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.connection.ShowResult.html b/docs/generated/singlestoredb.connection.ShowResult.html index 1d118fed..adbcc6e3 100644 --- a/docs/generated/singlestoredb.connection.ShowResult.html +++ b/docs/generated/singlestoredb.connection.ShowResult.html @@ -3,14 +3,14 @@ - singlestoredb.connection.ShowResult — SingleStoreDB 1.7.1 documentation + singlestoredb.connection.ShowResult — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -123,7 +123,7 @@

    singlestoredb.connection.ShowResult

    -class singlestoredb.connection.ShowResult(*args: Any, **kwargs: Any)
    +class singlestoredb.connection.ShowResult(*args: Any, **kwargs: Any)

    Simple result object.

    This object is primarily used for displaying results to a terminal or web browser, but it can also be treated like a @@ -150,7 +150,7 @@

    singlestoredb.connection.ShowResult
    -__init__(*args: Any, **kwargs: Any) None
    +__init__(*args: Any, **kwargs: Any) None

    Methods

    diff --git a/docs/generated/singlestoredb.create_engine.html b/docs/generated/singlestoredb.create_engine.html index 81155620..fbb52e81 100644 --- a/docs/generated/singlestoredb.create_engine.html +++ b/docs/generated/singlestoredb.create_engine.html @@ -3,14 +3,14 @@ - singlestoredb.create_engine — SingleStoreDB 1.7.1 documentation + singlestoredb.create_engine — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -88,7 +88,7 @@

    singlestoredb.create_engine

    -singlestoredb.create_engine(*args: Any, **kwargs: Any) Any
    +singlestoredb.create_engine(*args: Any, **kwargs: Any) Any

    Create an SQLAlchemy engine for SingleStoreDB.

    Parameters:
    @@ -101,7 +101,7 @@

    singlestoredb.create_engine

    See also

    -

    None

    +

    None

    Return type:
    diff --git a/docs/generated/singlestoredb.describe_option.html b/docs/generated/singlestoredb.describe_option.html index cf4bd7cc..d04bbaeb 100644 --- a/docs/generated/singlestoredb.describe_option.html +++ b/docs/generated/singlestoredb.describe_option.html @@ -3,14 +3,14 @@ - singlestoredb.describe_option — SingleStoreDB 1.7.1 documentation + singlestoredb.describe_option — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -87,7 +87,7 @@

    singlestoredb.describe_option

    -singlestoredb.describe_option(*keys: str, **kwargs: Any) str | None
    +singlestoredb.describe_option(*keys: str, **kwargs: Any) str | None

    Print the description of one or more options.

    To print the descriptions of all options, execute this function with no parameters.

    diff --git a/docs/generated/singlestoredb.get_option.html b/docs/generated/singlestoredb.get_option.html index 3b9fd385..d693608a 100644 --- a/docs/generated/singlestoredb.get_option.html +++ b/docs/generated/singlestoredb.get_option.html @@ -3,14 +3,14 @@ - singlestoredb.get_option — SingleStoreDB 1.7.1 documentation + singlestoredb.get_option — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -87,11 +87,11 @@

    singlestoredb.get_option

    -singlestoredb.get_option(key: str) Any
    +singlestoredb.get_option(key: str) Any

    Get the value of an option.

    Parameters:
    -

    key (str) – The name of the option

    +

    key (str) – The name of the option

    Returns:

    The value of the option

    diff --git a/docs/generated/singlestoredb.manage_workspaces.html b/docs/generated/singlestoredb.manage_workspaces.html index ea7cf24d..45410f50 100644 --- a/docs/generated/singlestoredb.manage_workspaces.html +++ b/docs/generated/singlestoredb.manage_workspaces.html @@ -3,14 +3,14 @@ - singlestoredb.manage_workspaces — SingleStoreDB 1.7.1 documentation + singlestoredb.manage_workspaces — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -91,15 +91,15 @@

    singlestoredb.manage_workspaces

    -singlestoredb.manage_workspaces(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None) WorkspaceManager
    +singlestoredb.manage_workspaces(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None) WorkspaceManager

    Retrieve a SingleStoreDB workspace 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

    • -
    • organization_id (str, optional) – ID of organization, if using a JWT for authentication

    • +
    • 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

    • +
    • organization_id (str, optional) – ID of organization, if using a JWT for authentication

    Return type:
    diff --git a/docs/generated/singlestoredb.management.region.Region.html b/docs/generated/singlestoredb.management.region.Region.html index f7328a51..37e60f25 100644 --- a/docs/generated/singlestoredb.management.region.Region.html +++ b/docs/generated/singlestoredb.management.region.Region.html @@ -3,14 +3,14 @@ - singlestoredb.management.region.Region — SingleStoreDB 1.7.1 documentation + singlestoredb.management.region.Region — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -91,7 +91,7 @@

    singlestoredb.management.region.Region

    -class singlestoredb.management.region.Region(id: str, name: str, provider: str)
    +class singlestoredb.management.region.Region(id: str, name: str, provider: str)

    Cluster region information.

    This object is not directly instantiated. It is used in results of WorkspaceManager API calls.

    @@ -101,7 +101,7 @@

    singlestoredb.management.region.Region
    -__init__(id: str, name: str, provider: str)
    +__init__(id: str, name: str, provider: str)

    Use WorkspaceManager.regions instead.

    Methods

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html index b78a8b9d..007b188a 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.download_file — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.download_file — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,15 +106,15 @@

    singlestoredb.management.workspace.Stage.download_file

    -Stage.download_file(stage_path: str | PathLike[str], local_path: str | PathLike[str] | None = None, *, overwrite: bool = False, encoding: str | None = None) bytes | str | None
    +Stage.download_file(stage_path: str | PathLike[str], local_path: str | PathLike[str] | None = None, *, overwrite: bool = False, encoding: str | None = None) bytes | str | None

    Download the content of a stage path.

    Parameters:
      -
    • stage_path (Path or str) – Path to the stage file

    • -
    • local_path (Path or str) – Path to local file target location

    • -
    • overwrite (bool, optional) – Should an existing file be overwritten if it exists?

    • -
    • encoding (str, optional) – Encoding used to convert the resulting data

    • +
    • stage_path (Path or str) – Path to the stage file

    • +
    • local_path (Path or str) – Path to local file target location

    • +
    • overwrite (bool, optional) – Should an existing file be overwritten if it exists?

    • +
    • encoding (str, optional) – Encoding used to convert the resulting data

    Returns:
    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html index 051275c6..bd415042 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.download_folder — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.download_folder — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,14 +106,14 @@

    singlestoredb.management.workspace.Stage.download_folder

    -Stage.download_folder(stage_path: str | PathLike[str], local_path: str | PathLike[str] = '.', *, overwrite: bool = False) None
    +Stage.download_folder(stage_path: str | PathLike[str], local_path: str | PathLike[str] = '.', *, overwrite: bool = False) None

    Download a Stage folder to a local directory.

    Parameters:
      -
    • stage_path (Path or str) – Path to the stage file

    • -
    • local_path (Path or str) – Path to local directory target location

    • -
    • overwrite (bool, optional) – Should an existing directory / files be overwritten if they exist?

    • +
    • stage_path (Path or str) – Path to the stage file

    • +
    • local_path (Path or str) – Path to local directory target location

    • +
    • overwrite (bool, optional) – Should an existing directory / files be overwritten if they exist?

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.exists.html b/docs/generated/singlestoredb.management.workspace.Stage.exists.html index 33ad3716..9aa1cd7b 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.exists.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.exists.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.exists — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.exists — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,14 +106,14 @@

    singlestoredb.management.workspace.Stage.exists

    -Stage.exists(stage_path: str | PathLike[str]) bool
    +Stage.exists(stage_path: str | PathLike[str]) bool

    Does the given stage path exist?

    Parameters:
    -

    stage_path (Path or str) – Path to stage object

    +

    stage_path (Path or str) – Path to stage object

    Return type:
    -

    bool

    +

    bool

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.html b/docs/generated/singlestoredb.management.workspace.Stage.html index df9196ee..0e4ca3b7 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.info.html b/docs/generated/singlestoredb.management.workspace.Stage.info.html index bbe010ad..10f3cf5f 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.info.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.info.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.info — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.info — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,11 +106,11 @@

    singlestoredb.management.workspace.Stage.info

    -Stage.info(stage_path: str | PathLike[str]) StageObject
    +Stage.info(stage_path: str | PathLike[str]) StageObject

    Return information about a stage location.

    Parameters:
    -

    stage_path (Path or str) – Path to the stage location

    +

    stage_path (Path or str) – Path to the stage location

    Return type:

    StageObject

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html index 3355110d..a493e2da 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.is_dir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.is_dir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,14 +106,14 @@

    singlestoredb.management.workspace.Stage.is_dir

    -Stage.is_dir(stage_path: str | PathLike[str]) bool
    +Stage.is_dir(stage_path: str | PathLike[str]) bool

    Is the given stage path a directory?

    Parameters:
    -

    stage_path (Path or str) – Path to stage object

    +

    stage_path (Path or str) – Path to stage object

    Return type:
    -

    bool

    +

    bool

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html index 5224afcf..88f6ef53 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.is_file — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.is_file — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,14 +106,14 @@

    singlestoredb.management.workspace.Stage.is_file

    -Stage.is_file(stage_path: str | PathLike[str]) bool
    +Stage.is_file(stage_path: str | PathLike[str]) bool

    Is the given stage path a file?

    Parameters:
    -

    stage_path (Path or str) – Path to stage object

    +

    stage_path (Path or str) – Path to stage object

    Return type:
    -

    bool

    +

    bool

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html index fe9311fa..40f61647 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.listdir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.listdir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,14 +106,14 @@

    singlestoredb.management.workspace.Stage.listdir

    -Stage.listdir(stage_path: str | PathLike[str] = '/', *, recursive: bool = False) List[str]
    +Stage.listdir(stage_path: str | PathLike[str] = '/', *, recursive: bool = False) List[str]

    List the files / folders at the given path.

    Parameters:
    -

    stage_path (Path or str, optional) – Path to the stage location

    +

    stage_path (Path or str, optional) – Path to the stage location

    Return type:
    -

    List[str]

    +

    List[str]

    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html index 6c5141b2..41f2c1ac 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.mkdir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.mkdir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,13 +106,13 @@

    singlestoredb.management.workspace.Stage.mkdir

    -Stage.mkdir(stage_path: str | PathLike[str], overwrite: bool = False) StageObject
    +Stage.mkdir(stage_path: str | PathLike[str], overwrite: bool = False) StageObject

    Make a directory in the stage.

    Parameters:
      -
    • stage_path (Path or str) – Path of the folder to create

    • -
    • overwrite (bool, optional) – Should the stage path be overwritten if it exists already?

    • +
    • stage_path (Path or str) – Path of the folder to create

    • +
    • overwrite (bool, optional) – Should the stage path be overwritten if it exists already?

    Return type:
    diff --git a/docs/generated/singlestoredb.management.workspace.Stage.open.html b/docs/generated/singlestoredb.management.workspace.Stage.open.html index a1a306f5..4aeaa8b3 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.open.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.open.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.open — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.open — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -106,13 +106,13 @@

    singlestoredb.management.workspace.Stage.open

    -Stage.open(stage_path: str | PathLike[str], mode: str = 'r', encoding: str | None = None) StringIO | BytesIO
    +Stage.open(stage_path: str | PathLike[str], mode: str = 'r', encoding: str | None = None) StringIO | BytesIO

    Open a Stage path for reading or writing.

    Parameters:
      -
    • stage_path (Path or str) – The stage path to read / write

    • -
    • mode (str, optional) –

      +
    • stage_path (Path or str) – The stage path to read / write

    • +
    • mode (str, optional) –

      The read / write mode. The following modes are supported:
      • ’r’ open for reading (default)

      • ’w’ open for writing, truncating the file first

      • @@ -126,7 +126,7 @@

        singlestoredb.management.workspace.Stage.openstr, optional) – The string encoding to use for text

        +
      • encoding (str, optional) – The string encoding to use for text

      Returns:
      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.remove.html b/docs/generated/singlestoredb.management.workspace.Stage.remove.html index e7280e54..dc0cf274 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.remove.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.remove.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.remove — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.remove — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,11 +106,11 @@

      singlestoredb.management.workspace.Stage.remove

      -Stage.remove(stage_path: str | PathLike[str]) None
      +Stage.remove(stage_path: str | PathLike[str]) None

      Delete a stage location.

      Parameters:
      -

      stage_path (Path or str) – Path to the stage location

      +

      stage_path (Path or str) – Path to the stage location

      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html index d3851067..a12370e6 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.removedirs — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.removedirs — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,11 +106,11 @@

      singlestoredb.management.workspace.Stage.removedirs

      -Stage.removedirs(stage_path: str | PathLike[str]) None
      +Stage.removedirs(stage_path: str | PathLike[str]) None

      Delete a stage folder recursively.

      Parameters:
      -

      stage_path (Path or str) – Path to the stage location

      +

      stage_path (Path or str) – Path to the stage location

      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rename.html b/docs/generated/singlestoredb.management.workspace.Stage.rename.html index 84471371..e40a3120 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rename.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rename.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.rename — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.rename — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,7 +106,7 @@

      singlestoredb.management.workspace.Stage.rename

      -Stage.rename(old_path: str | PathLike[str], new_path: str | PathLike[str], *, overwrite: bool = False) StageObject
      +Stage.rename(old_path: str | PathLike[str], new_path: str | PathLike[str], *, overwrite: bool = False) StageObject

      Move the stage file to a new location.

      Paraemeters

      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html index 79859f8c..3de420c2 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.rmdir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.rmdir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,11 +106,11 @@

      singlestoredb.management.workspace.Stage.rmdir

      -Stage.rmdir(stage_path: str | PathLike[str]) None
      +Stage.rmdir(stage_path: str | PathLike[str]) None

      Delete a stage folder.

      Parameters:
      -

      stage_path (Path or str) – Path to the stage location

      +

      stage_path (Path or str) – Path to the stage location

      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html index bf899f67..94e85d82 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.upload_file — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.upload_file — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,14 +106,14 @@

      singlestoredb.management.workspace.Stage.upload_file

      -Stage.upload_file(local_path: str | PathLike[str] | TextIO | BinaryIO, stage_path: str | PathLike[str], *, overwrite: bool = False) StageObject
      +Stage.upload_file(local_path: str | PathLike[str] | TextIO | BinaryIO, stage_path: str | PathLike[str], *, overwrite: bool = False) StageObject

      Upload a local file.

      Parameters:
        -
      • local_path (Path or str or file-like) – Path to the local file or an open file object

      • -
      • stage_path (Path or str) – Path to the stage file

      • -
      • overwrite (bool, optional) – Should the stage_path be overwritten if it exists already?

      • +
      • local_path (Path or str or file-like) – Path to the local file or an open file object

      • +
      • stage_path (Path or str) – Path to the stage file

      • +
      • overwrite (bool, optional) – Should the stage_path be overwritten if it exists already?

      diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html index 34319cd6..9d321942 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Stage.upload_folder — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Stage.upload_folder — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -106,19 +106,19 @@

      singlestoredb.management.workspace.Stage.upload_folder

      -Stage.upload_folder(local_path: str | PathLike[str], stage_path: str | PathLike[str], *, overwrite: bool = False, recursive: bool = True, include_root: bool = False, ignore: str | PathLike[str] | List[str | PathLike[str]] | None = None) StageObject
      +Stage.upload_folder(local_path: str | PathLike[str], stage_path: str | PathLike[str], *, overwrite: bool = False, recursive: bool = True, include_root: bool = False, ignore: str | PathLike[str] | List[str | PathLike[str]] | None = None) StageObject

      Upload a folder recursively.

      Only the contents of the folder are uploaded. To include the folder name itself in the target path use include_root=True.

      Parameters:
        -
      • local_path (Path or str) – Local directory to upload

      • -
      • stage_path (Path or str) – Path of stage folder to upload to

      • -
      • overwrite (bool, optional) – If a file already exists, should it be overwritten?

      • -
      • recursive (bool, optional) – Should nested folders be uploaded?

      • -
      • include_root (bool, optional) – Should the local root folder itself be uploaded as the top folder?

      • -
      • ignore (Path or str or List[Path] or List[str], optional) – Glob patterns of files to ignore, for example, ‘**/.pyc` will +

      • local_path (Path or str) – Local directory to upload

      • +
      • stage_path (Path or str) – Path of stage folder to upload to

      • +
      • overwrite (bool, optional) – If a file already exists, should it be overwritten?

      • +
      • recursive (bool, optional) – Should nested folders be uploaded?

      • +
      • include_root (bool, optional) – Should the local root folder itself be uploaded as the top folder?

      • +
      • ignore (Path or str or List[Path] or List[str], optional) – Glob patterns of files to ignore, for example, ‘**/.pyc` will ignore all ‘.pyc’ files in the directory tree

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html index 9557c72f..00f9289d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.abspath — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.abspath — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.abspath

      -StageObject.abspath() str
      +StageObject.abspath() str

      Return the full path of the object.

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html index 567af26e..671a081d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.basename — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.basename — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.basename

      -StageObject.basename() str
      +StageObject.basename() str

      Return the basename of the object.

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html index 6f672782..94377fc6 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.dirname — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.dirname — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.dirname

      -StageObject.dirname() str
      +StageObject.dirname() str

      Return the directory name of the object.

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.download.html b/docs/generated/singlestoredb.management.workspace.StageObject.download.html index c372b8f6..ff53bf3b 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.download.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.download.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.download — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.download — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,18 +105,18 @@

      singlestoredb.management.workspace.StageObject.download

      -StageObject.download(local_path: str | PathLike[str] | None = None, *, overwrite: bool = False, encoding: str | None = None) bytes | str | None
      +StageObject.download(local_path: str | PathLike[str] | None = None, *, overwrite: bool = False, encoding: str | None = None) bytes | str | None

      Download the content of a stage path.

      Parameters:
        -
      • local_path (Path or str) – Path to local file target location

      • -
      • overwrite (bool, optional) – Should an existing file be overwritten if it exists?

      • -
      • encoding (str, optional) – Encoding used to convert the resulting data

      • +
      • local_path (Path or str) – Path to local file target location

      • +
      • overwrite (bool, optional) – Should an existing file be overwritten if it exists?

      • +
      • encoding (str, optional) – Encoding used to convert the resulting data

      Return type:
      -

      bytes or str or None

      +

      bytes or str or None

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html index 5b50282a..0d0cf816 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.exists — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.exists — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.exists

      -StageObject.exists() bool
      +StageObject.exists() bool

      Does the file / folder exist?

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html index 9b8cd4cb..d634a03f 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.getctime — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.getctime — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.getctime

      -StageObject.getctime() float
      +StageObject.getctime() float

      Return the creation datetime as a UNIX timestamp.

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html index 5e0f02b3..3ebdfc20 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.getmtime — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.getmtime — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,7 +105,7 @@

      singlestoredb.management.workspace.StageObject.getmtime

      -StageObject.getmtime() float
      +StageObject.getmtime() float

      Return the last modified datetime as a UNIX timestamp.

      diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.html b/docs/generated/singlestoredb.management.workspace.StageObject.html index 9b316097..da8b244d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -105,13 +105,13 @@

      singlestoredb.management.workspace.StageObject

      -class singlestoredb.management.workspace.StageObject(name: str, path: str, size: int, type: str, format: str, mimetype: str, created: datetime | None, last_modified: datetime | None, writable: bool, content: List[str] | None = None)
      +class singlestoredb.management.workspace.StageObject(name: str, path: str, size: int, type: str, format: str, mimetype: str, created: datetime | None, last_modified: datetime | None, writable: bool, content: List[str] | None = None)

      Stage file / folder object.

      This object is not instantiated directly. It is used in the results of various operations in WorkspaceGroup.stage methods.

      -__init__(name: str, path: str, size: int, type: str, format: str, mimetype: str, created: datetime | None, last_modified: datetime | None, writable: bool, content: List[str] | None = None)
      +__init__(name: str, path: str, size: int, type: str, format: str, mimetype: str, created: datetime | None, last_modified: datetime | None, writable: bool, content: List[str] | None = None)

      Methods

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html index f9ba260e..c3df3e16 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.is_dir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.is_dir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,7 +105,7 @@

    singlestoredb.management.workspace.StageObject.is_dir

    -StageObject.is_dir() bool
    +StageObject.is_dir() bool

    Is the stage object a directory?

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html index 715ebf54..aaef68fb 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.is_file — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.is_file — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,7 +105,7 @@

    singlestoredb.management.workspace.StageObject.is_file

    -StageObject.is_file() bool
    +StageObject.is_file() bool

    Is the stage object a file?

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.open.html b/docs/generated/singlestoredb.management.workspace.StageObject.open.html index 1f6262b0..e9c11003 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.open.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.open.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.open — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.open — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,12 +105,12 @@

    singlestoredb.management.workspace.StageObject.open

    -StageObject.open(mode: str = 'r', encoding: str | None = None) StringIO | BytesIO
    +StageObject.open(mode: str = 'r', encoding: str | None = None) StringIO | BytesIO

    Open a Stage path for reading or writing.

    Parameters:
      -
    • mode (str, optional) –

      +
    • mode (str, optional) –

      The read / write mode. The following modes are supported:
      • ’r’ open for reading (default)

      • ’w’ open for writing, truncating the file first

      • @@ -124,7 +124,7 @@

        singlestoredb.management.workspace.StageObject.open

    • -
    • encoding (str, optional) – The string encoding to use for text

    • +
    • encoding (str, optional) – The string encoding to use for text

    Returns:
    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html index c494970d..e125391b 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.remove — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.remove — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,7 +105,7 @@

    singlestoredb.management.workspace.StageObject.remove

    -StageObject.remove() None
    +StageObject.remove() None

    Delete the stage file.

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html index 42512189..4fdab681 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.removedirs — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.removedirs — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,7 +105,7 @@

    singlestoredb.management.workspace.StageObject.removedirs

    -StageObject.removedirs() None
    +StageObject.removedirs() None

    Delete the stage directory recursively.

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html index f6fdac55..606739ff 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.rename — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.rename — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,13 +105,13 @@

    singlestoredb.management.workspace.StageObject.rename

    -StageObject.rename(new_path: str | PathLike[str], *, overwrite: bool = False) None
    +StageObject.rename(new_path: str | PathLike[str], *, overwrite: bool = False) None

    Move the stage file to a new location.

    Parameters:
      -
    • new_path (Path or str) – The new location of the file

    • -
    • overwrite (bool, optional) – Should path be overwritten if it already exists?

    • +
    • new_path (Path or str) – The new location of the file

    • +
    • overwrite (bool, optional) – Should path be overwritten if it already exists?

    diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html index 747a1db5..2c2ba7c2 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.StageObject.rmdir — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.StageObject.rmdir — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -105,7 +105,7 @@

    singlestoredb.management.workspace.StageObject.rmdir

    -StageObject.rmdir() None
    +StageObject.rmdir() None

    Delete the empty stage directory.

    diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html index cb0d3bf2..4ddba0c2 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Workspace.connect — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Workspace.connect — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -95,7 +95,7 @@

    singlestoredb.management.workspace.Workspace.connect

    -Workspace.connect(**kwargs: Any) Connection
    +Workspace.connect(**kwargs: Any) Connection

    Create a connection to the database server for this workspace.

    Parameters:
    diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.html b/docs/generated/singlestoredb.management.workspace.Workspace.html index 82800797..215eaf72 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Workspace — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Workspace — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -95,7 +95,7 @@

    singlestoredb.management.workspace.Workspace

    -class singlestoredb.management.workspace.Workspace(name: str, workspace_id: str, workspace_group: str | WorkspaceGroup, size: str, state: str, created_at: str | datetime, terminated_at: datetime | str | None = None, endpoint: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, resume_attachments: List[Dict[str, Any]] | None = None, scaling_progress: int | None = None, last_resumed_at: datetime | str | None = None)
    +class singlestoredb.management.workspace.Workspace(name: str, workspace_id: str, workspace_group: str | WorkspaceGroup, size: str, state: str, created_at: str | datetime, terminated_at: datetime | str | None = None, endpoint: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, resume_attachments: List[Dict[str, Any]] | None = None, scaling_progress: int | None = None, last_resumed_at: datetime | str | None = None)

    SingleStoreDB workspace definition.

    This object is not instantiated directly. It is used in the results of API calls on the WorkspaceManager. Workspaces are created using @@ -108,7 +108,7 @@

    singlestoredb.management.workspace.Workspace
    -__init__(name: str, workspace_id: str, workspace_group: str | WorkspaceGroup, size: str, state: str, created_at: str | datetime, terminated_at: datetime | str | None = None, endpoint: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, resume_attachments: List[Dict[str, Any]] | None = None, scaling_progress: int | None = None, last_resumed_at: datetime | str | None = None)
    +__init__(name: str, workspace_id: str, workspace_group: str | WorkspaceGroup, size: str, state: str, created_at: str | datetime, terminated_at: datetime | str | None = None, endpoint: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, resume_attachments: List[Dict[str, Any]] | None = None, scaling_progress: int | None = None, last_resumed_at: datetime | str | None = None)

    Methods

    diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html index 2845aca4..c339456c 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Workspace.refresh — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Workspace.refresh — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html index a27731d8..b895b9e5 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Workspace.terminate — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Workspace.terminate — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -95,15 +95,15 @@

    singlestoredb.management.workspace.Workspace.terminate

    -Workspace.terminate(wait_on_terminated: bool = False, wait_interval: int = 10, wait_timeout: int = 600, force: bool = False) None
    +Workspace.terminate(wait_on_terminated: bool = False, wait_interval: int = 10, wait_timeout: int = 600, force: bool = False) None

    Terminate the workspace.

    Parameters:
      -
    • wait_on_terminated (bool, optional) – Wait for the workspace to go into ‘Terminated’ mode before returning

    • -
    • wait_interval (int, optional) – Number of seconds between each server check

    • -
    • wait_timeout (int, optional) – Total number of seconds to check server before giving up

    • -
    • force (bool, optional) – Should the workspace group be terminated even if it has workspaces?

    • +
    • wait_on_terminated (bool, optional) – Wait for the workspace to go into ‘Terminated’ mode before returning

    • +
    • wait_interval (int, optional) – Number of seconds between each server check

    • +
    • wait_timeout (int, optional) – Total number of seconds to check server before giving up

    • +
    • force (bool, optional) – Should the workspace group be terminated even if it has workspaces?

    Raises:
    diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.update.html b/docs/generated/singlestoredb.management.workspace.Workspace.update.html index d986b190..a12e6f95 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.update.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.update.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.Workspace.update — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.Workspace.update — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -95,18 +95,18 @@

    singlestoredb.management.workspace.Workspace.update

    -Workspace.update(auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, size: str | None = None) None
    +Workspace.update(auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, deployment_type: str | None = None, size: str | None = None) None

    Update the workspace definition.

    Parameters:
      -
    • auto_suspend (Dict[str, Any], optional) – Auto-suspend mode for the workspace: IDLE, SCHEDULED, DISABLED

    • -
    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated +

    • auto_suspend (Dict[str, Any], optional) – Auto-suspend mode for the workspace: IDLE, SCHEDULED, DISABLED

    • +
    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.

    • -
    • deployment_type (str, optional) – The deployment type that will be applied to all the workspaces +

    • deployment_type (str, optional) – The deployment type that will be applied to all the workspaces within the group

    • -
    • size (str, optional) – Size of the workspace (in workspace size notation), such as “S-1”.

    • +
    • size (str, optional) – Size of the workspace (in workspace size notation), such as “S-1”.

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html index 6975ecce..b239cebe 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.create_workspace — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.create_workspace — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -97,23 +97,23 @@

    singlestoredb.management.workspace.WorkspaceGroup.create_workspace

    -WorkspaceGroup.create_workspace(name: str, size: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, enable_kai: bool | None = None, wait_on_active: bool = False, wait_interval: int = 10, wait_timeout: int = 600) Workspace
    +WorkspaceGroup.create_workspace(name: str, size: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, enable_kai: bool | None = None, wait_on_active: bool = False, wait_interval: int = 10, wait_timeout: int = 600) Workspace

    Create a new workspace.

    Parameters:
      -
    • name (str) – Name of the workspace

    • -
    • size (str, optional) – Workspace size in workspace size notation (S-00, S-1, etc.)

    • -
    • auto_suspend (Dict[str, Any], optional) – Auto suspend settings for the workspace. If this field is not +

    • name (str) – Name of the workspace

    • +
    • size (str, optional) – Workspace size in workspace size notation (S-00, S-1, etc.)

    • +
    • auto_suspend (Dict[str, Any], optional) – Auto suspend settings for the workspace. If this field is not provided, no settings will be enabled.

    • -
    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated +

    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.

    • -
    • enable_kai (bool, optional) – Whether to create a SingleStore Kai-enabled workspace

    • -
    • wait_on_active (bool, optional) – Wait for the workspace to be active before returning

    • -
    • wait_timeout (int, optional) – Maximum number of seconds to wait before raising an exception +

    • enable_kai (bool, optional) – Whether to create a SingleStore Kai-enabled workspace

    • +
    • wait_on_active (bool, optional) – Wait for the workspace to be active before returning

    • +
    • wait_timeout (int, optional) – Maximum number of seconds to wait before raising an exception if wait=True

    • -
    • wait_interval (int, optional) – Number of seconds between each polling interval

    • +
    • wait_interval (int, optional) – Number of seconds between each polling interval

    Return type:
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html index ba554f35..d81add8f 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -97,7 +97,7 @@

    singlestoredb.management.workspace.WorkspaceGroup

    -class singlestoredb.management.workspace.WorkspaceGroup(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)
    +class singlestoredb.management.workspace.WorkspaceGroup(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)

    SingleStoreDB workspace group definition.

    This object is not instantiated directly. It is used in the results of API calls on the WorkspaceManager. Workspace groups are created using @@ -110,7 +110,7 @@

    singlestoredb.management.workspace.WorkspaceGroup
    -__init__(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)
    +__init__(name: str, id: str, created_at: str | datetime, region: Region | None, firewall_ranges: List[str], terminated_at: datetime | str | None, allow_all_traffic: bool | None)

    Methods

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html index 52e7257a..ab0c7519 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.refresh — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.refresh — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html index 9f73c7a1..b3fd6fdd 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.stage — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.stage — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html index 77d28046..321115c8 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.terminate — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.terminate — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -97,15 +97,15 @@

    singlestoredb.management.workspace.WorkspaceGroup.terminate

    -WorkspaceGroup.terminate(force: bool = False, wait_on_terminated: bool = False, wait_interval: int = 10, wait_timeout: int = 600) None
    +WorkspaceGroup.terminate(force: bool = False, wait_on_terminated: bool = False, wait_interval: int = 10, wait_timeout: int = 600) None

    Terminate the workspace group.

    Parameters:
      -
    • force (bool, optional) – Terminate a workspace group even if it has active workspaces

    • -
    • wait_on_terminated (bool, optional) – Wait for the workspace group to go into ‘Terminated’ mode before returning

    • -
    • wait_interval (int, optional) – Number of seconds between each server check

    • -
    • wait_timeout (int, optional) – Total number of seconds to check server before giving up

    • +
    • force (bool, optional) – Terminate a workspace group even if it has active workspaces

    • +
    • wait_on_terminated (bool, optional) – Wait for the workspace group to go into ‘Terminated’ mode before returning

    • +
    • wait_interval (int, optional) – Number of seconds between each server check

    • +
    • wait_timeout (int, optional) – Total number of seconds to check server before giving up

    Raises:
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html index 05b58d35..401745a4 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.update — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.update — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -97,24 +97,24 @@

    singlestoredb.management.workspace.WorkspaceGroup.update

    -WorkspaceGroup.update(name: str | None = None, firewall_ranges: List[str] | None = None, admin_password: str | None = None, expires_at: str | None = None, allow_all_traffic: bool | None = None, update_window: Dict[str, int] | None = None) None
    +WorkspaceGroup.update(name: str | None = None, firewall_ranges: List[str] | None = None, admin_password: str | None = None, expires_at: str | None = None, allow_all_traffic: bool | None = None, update_window: Dict[str, int] | None = None) None

    Update the workspace group definition.

    Parameters:
      -
    • name (str, optional) – Name of the workspace group

    • -
    • firewall_ranges (list[str], optional) – List of allowed CIDR ranges. An empty list indicates that all +

    • name (str, optional) – Name of the workspace group

    • +
    • firewall_ranges (list[str], optional) – List of allowed CIDR ranges. An empty list indicates that all inbound requests are allowed.

    • -
    • admin_password (str, optional) – Admin password for the workspace group. If no password is supplied, +

    • admin_password (str, optional) – Admin password for the workspace group. If no password is supplied, a password will be generated and retured in the response.

    • -
    • expires_at (str, optional) – The timestamp of when the workspace group will expire. +

    • expires_at (str, optional) – The timestamp of when the workspace group will expire. If the expiration time is not specified, the workspace group will have no expiration time. At expiration, the workspace group is terminated and all the data is lost. Expiration time can be specified as a timestamp or duration. Example: “2021-01-02T15:04:05Z07:00”, “2021-01-02”, “3h30m”

    • -
    • allow_all_traffic (bool, optional) – Allow all traffic to the workspace group

    • -
    • update_window (Dict[str, int], optional) – Specify the day and hour of an update window: dict(day=0-6, hour=0-23)

    • +
    • allow_all_traffic (bool, optional) – Allow all traffic to the workspace group

    • +
    • update_window (Dict[str, int], optional) – Specify the day and hour of an update window: dict(day=0-6, hour=0-23)

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html index 4123021c..e571a586 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceGroup.workspaces — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceGroup.workspaces — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html index 0dcdb104..5c3fbca3 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.create_workspace — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.create_workspace — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -98,24 +98,24 @@

    singlestoredb.management.workspace.WorkspaceManager.create_workspace

    -WorkspaceManager.create_workspace(name: str, workspace_group: str | WorkspaceGroup, size: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, enable_kai: bool | None = None, wait_on_active: bool = False, wait_interval: int = 10, wait_timeout: int = 600) Workspace
    +WorkspaceManager.create_workspace(name: str, workspace_group: str | WorkspaceGroup, size: str | None = None, auto_suspend: Dict[str, Any] | None = None, cache_config: int | None = None, enable_kai: bool | None = None, wait_on_active: bool = False, wait_interval: int = 10, wait_timeout: int = 600) Workspace

    Create a new workspace.

    Parameters:
      -
    • name (str) – Name of the workspace

    • -
    • workspace_group (str or WorkspaceGroup) – The workspace ID of the workspace

    • -
    • size (str, optional) – Workspace size in workspace size notation (S-00, S-1, etc.)

    • -
    • auto_suspend (Dict[str, Any], optional) – Auto suspend settings for the workspace. If this field is not +

    • name (str) – Name of the workspace

    • +
    • workspace_group (str or WorkspaceGroup) – The workspace ID of the workspace

    • +
    • size (str, optional) – Workspace size in workspace size notation (S-00, S-1, etc.)

    • +
    • auto_suspend (Dict[str, Any], optional) – Auto suspend settings for the workspace. If this field is not provided, no settings will be enabled.

    • -
    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated +

    • cache_config (int, optional) – Specifies the multiplier for the persistent cache associated with the workspace. If specified, it enables the cache configuration multiplier. It can have one of the following values: 1, 2, or 4.

    • -
    • enable_kai (bool, optional) – Whether to create a SingleStore Kai-enabled workspace

    • -
    • wait_on_active (bool, optional) – Wait for the workspace to be active before returning

    • -
    • wait_timeout (int, optional) – Maximum number of seconds to wait before raising an exception +

    • enable_kai (bool, optional) – Whether to create a SingleStore Kai-enabled workspace

    • +
    • wait_on_active (bool, optional) – Wait for the workspace to be active before returning

    • +
    • wait_timeout (int, optional) – Maximum number of seconds to wait before raising an exception if wait=True

    • -
    • wait_interval (int, optional) – Number of seconds between each polling interval

    • +
    • wait_interval (int, optional) – Number of seconds between each polling interval

    Return type:
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html index 264efa9b..7984dc6e 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.create_workspace_group — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.create_workspace_group — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -98,37 +98,37 @@

    singlestoredb.management.workspace.WorkspaceManager.create_workspace_group

    -WorkspaceManager.create_workspace_group(name: str, region: str | Region, firewall_ranges: List[str], admin_password: str | None = None, backup_bucket_kms_key_id: str | None = None, data_bucket_kms_key_id: str | None = None, expires_at: str | None = None, smart_dr: bool | None = None, allow_all_traffic: bool | None = None, update_window: Dict[str, int] | None = None) WorkspaceGroup
    +WorkspaceManager.create_workspace_group(name: str, region: str | Region, firewall_ranges: List[str], admin_password: str | None = None, backup_bucket_kms_key_id: str | None = None, data_bucket_kms_key_id: str | None = None, expires_at: str | None = None, smart_dr: bool | None = None, allow_all_traffic: bool | None = None, update_window: Dict[str, int] | None = None) WorkspaceGroup

    Create a new workspace group.

    Parameters:
      -
    • name (str) – Name of the workspace group

    • -
    • region (str or Region) – ID of the region where the workspace group should be created

    • -
    • firewall_ranges (list[str]) – List of allowed CIDR ranges. An empty list indicates that all +

    • name (str) – Name of the workspace group

    • +
    • region (str or Region) – ID of the region where the workspace group should be created

    • +
    • firewall_ranges (list[str]) – List of allowed CIDR ranges. An empty list indicates that all inbound requests are allowed.

    • -
    • admin_password (str, optional) – Admin password for the workspace group. If no password is supplied, +

    • admin_password (str, optional) – Admin password for the workspace group. If no password is supplied, a password will be generated and retured in the response.

    • -
    • backup_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the backup bucket. +

    • backup_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the backup bucket. If specified, enables Customer-Managed Encryption Keys (CMEK) encryption for the backup bucket of the workspace group. This feature is only supported in workspace groups deployed in AWS.

    • -
    • data_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the data bucket. +

    • data_bucket_kms_key_id (str, optional) – Specifies the KMS key ID associated with the data bucket. If specified, enables Customer-Managed Encryption Keys (CMEK) encryption for the data bucket and Amazon Elastic Block Store (EBS) volumes of the workspace group. This feature is only supported in workspace groups deployed in AWS.

    • -
    • expires_at (str, optional) – The timestamp of when the workspace group will expire. +

    • expires_at (str, optional) – The timestamp of when the workspace group will expire. If the expiration time is not specified, the workspace group will have no expiration time. At expiration, the workspace group is terminated and all the data is lost. Expiration time can be specified as a timestamp or duration. Example: “2021-01-02T15:04:05Z07:00”, “2021-01-02”, “3h30m”

    • -
    • smart_dr (bool, optional) – Enables Smart Disaster Recovery (SmartDR) for the workspace group. +

    • smart_dr (bool, optional) – Enables Smart Disaster Recovery (SmartDR) for the workspace group. SmartDR is a disaster recovery solution that ensures seamless and continuous replication of data from the primary region to a secondary region

    • -
    • allow_all_traffic (bool, optional) – Allow all traffic to the workspace group

    • -
    • update_window (Dict[str, int], optional) – Specify the day and hour of an update window: dict(day=0-6, hour=0-23)

    • +
    • allow_all_traffic (bool, optional) – Allow all traffic to the workspace group

    • +
    • update_window (Dict[str, int], optional) – Specify the day and hour of an update window: dict(day=0-6, hour=0-23)

    Return type:
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html index 1183b367..ef150332 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.get_workspace — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.get_workspace — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -98,11 +98,11 @@

    singlestoredb.management.workspace.WorkspaceManager.get_workspace

    -WorkspaceManager.get_workspace(id: str) Workspace
    +WorkspaceManager.get_workspace(id: str) Workspace

    Retrieve a workspace definition.

    Parameters:
    -

    id (str) – ID of the workspace

    +

    id (str) – ID of the workspace

    Return type:

    Workspace

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html index 02b69783..bd801fea 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.get_workspace_group — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.get_workspace_group — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -98,11 +98,11 @@

    singlestoredb.management.workspace.WorkspaceManager.get_workspace_group

    -WorkspaceManager.get_workspace_group(id: str) WorkspaceGroup
    +WorkspaceManager.get_workspace_group(id: str) WorkspaceGroup

    Retrieve a workspace group definition.

    Parameters:
    -

    id (str) – ID of the workspace group

    +

    id (str) – ID of the workspace group

    Return type:

    WorkspaceGroup

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html index 3ca552a7..535a9b77 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -98,15 +98,15 @@

    singlestoredb.management.workspace.WorkspaceManager

    -class singlestoredb.management.workspace.WorkspaceManager(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)
    +class singlestoredb.management.workspace.WorkspaceManager(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)

    SingleStoreDB workspace manager.

    This class should be instantiated using singlestoredb.manage_workspaces().

    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

    • +
    • 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

    @@ -116,7 +116,7 @@

    singlestoredb.management.workspace.WorkspaceManager
    -__init__(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)
    +__init__(access_token: str | None = None, version: str | None = None, base_url: str | None = None, *, organization_id: str | None = None)

    Methods

    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html index 28c7675f..3ab72444 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.organization — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.organization — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html index cfb207c0..3fdf440b 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.regions — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.regions — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html index 8ff0569b..6b6ab863 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html @@ -3,14 +3,14 @@ - singlestoredb.management.workspace.WorkspaceManager.workspace_groups — SingleStoreDB 1.7.1 documentation + singlestoredb.management.workspace.WorkspaceManager.workspace_groups — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.notebook.organization.html b/docs/generated/singlestoredb.notebook.organization.html index 283df484..e164e9f1 100644 --- a/docs/generated/singlestoredb.notebook.organization.html +++ b/docs/generated/singlestoredb.notebook.organization.html @@ -3,14 +3,14 @@ - singlestoredb.notebook.organization — SingleStoreDB 1.7.1 documentation + singlestoredb.notebook.organization — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.notebook.secrets.html b/docs/generated/singlestoredb.notebook.secrets.html index 3ef011b4..ba528486 100644 --- a/docs/generated/singlestoredb.notebook.secrets.html +++ b/docs/generated/singlestoredb.notebook.secrets.html @@ -3,14 +3,14 @@ - singlestoredb.notebook.secrets — SingleStoreDB 1.7.1 documentation + singlestoredb.notebook.secrets — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.notebook.stage.html b/docs/generated/singlestoredb.notebook.stage.html index 695be5c8..a76a427a 100644 --- a/docs/generated/singlestoredb.notebook.stage.html +++ b/docs/generated/singlestoredb.notebook.stage.html @@ -3,14 +3,14 @@ - singlestoredb.notebook.stage — SingleStoreDB 1.7.1 documentation + singlestoredb.notebook.stage — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.notebook.workspace.html b/docs/generated/singlestoredb.notebook.workspace.html index f82947c8..1d9c7509 100644 --- a/docs/generated/singlestoredb.notebook.workspace.html +++ b/docs/generated/singlestoredb.notebook.workspace.html @@ -3,14 +3,14 @@ - singlestoredb.notebook.workspace — SingleStoreDB 1.7.1 documentation + singlestoredb.notebook.workspace — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.notebook.workspace_group.html b/docs/generated/singlestoredb.notebook.workspace_group.html index dbedcbb6..067b0217 100644 --- a/docs/generated/singlestoredb.notebook.workspace_group.html +++ b/docs/generated/singlestoredb.notebook.workspace_group.html @@ -3,14 +3,14 @@ - singlestoredb.notebook.workspace_group — SingleStoreDB 1.7.1 documentation + singlestoredb.notebook.workspace_group — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/generated/singlestoredb.set_option.html b/docs/generated/singlestoredb.set_option.html index c6fb208d..ee955faa 100644 --- a/docs/generated/singlestoredb.set_option.html +++ b/docs/generated/singlestoredb.set_option.html @@ -3,14 +3,14 @@ - singlestoredb.set_option — SingleStoreDB 1.7.1 documentation + singlestoredb.set_option — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -87,13 +87,13 @@

    singlestoredb.set_option

    -singlestoredb.set_option(*args: Any, **kwargs: Any) None
    +singlestoredb.set_option(*args: Any, **kwargs: Any) None

    Set the value of an option.

    Parameters:
      -
    • *args (str or Any) – The name and value of an option in consecutive arguments (not tuples)

    • -
    • **kwargs (dict) – Arbitrary keyword / value pairs

    • +
    • *args (str or Any) – The name and value of an option in consecutive arguments (not tuples)

    • +
    • **kwargs (dict) – Arbitrary keyword / value pairs

    diff --git a/docs/genindex.html b/docs/genindex.html index e49e6c65..d2749e0b 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -3,14 +3,14 @@ - Index — SingleStoreDB 1.7.1 documentation + Index — SingleStoreDB 1.7.2 documentation - + @@ -26,7 +26,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/getting-started.html b/docs/getting-started.html index b34c25a9..f18e3461 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -3,14 +3,14 @@ - Getting Started — SingleStoreDB 1.7.1 documentation + Getting Started — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    diff --git a/docs/index.html b/docs/index.html index cc595298..118a6b31 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,14 +3,14 @@ - SingleStoreDB Python SDK — SingleStoreDB 1.7.1 documentation + SingleStoreDB Python SDK — SingleStoreDB 1.7.2 documentation - + @@ -27,7 +27,7 @@ SingleStoreDB
    - 1.7.1 + 1.7.2
    @@ -77,6 +77,7 @@

    SingleStoreDB Python SDKInstallation
  • What’s New
      +
    • v1.7.2 - October 16, 2024
    • v1.7.1 - September 20, 2024
    • v1.7.0 - September 20, 2024
    • v1.6.3 - September 5, 2024
    • diff --git a/docs/install.html b/docs/install.html index dd4c35f7..fd6f1da8 100644 --- a/docs/install.html +++ b/docs/install.html @@ -3,14 +3,14 @@ - Installation — SingleStoreDB 1.7.1 documentation + Installation — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      diff --git a/docs/license.html b/docs/license.html index 1477a4db..c71c9ca0 100644 --- a/docs/license.html +++ b/docs/license.html @@ -3,14 +3,14 @@ - License — SingleStoreDB 1.7.1 documentation + License — SingleStoreDB 1.7.2 documentation - + @@ -27,7 +27,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      diff --git a/docs/objects.inv b/docs/objects.inv index e7f19760741c81743717ed1fcf2fde2c00042ec4..6b7b81570bf96bdff0651fa181586639da433b43 100644 GIT binary patch delta 12 TcmbOwHcM=RE2Ggyw<}x#8><99 delta 12 TcmbOwHcM=RE2H5?w<}x#8>R$3 diff --git a/docs/py-modindex.html b/docs/py-modindex.html index d2667cf2..f3701bee 100644 --- a/docs/py-modindex.html +++ b/docs/py-modindex.html @@ -3,14 +3,14 @@ - Python Module Index — SingleStoreDB 1.7.1 documentation + Python Module Index — SingleStoreDB 1.7.2 documentation - + @@ -29,7 +29,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      diff --git a/docs/search.html b/docs/search.html index cf964e2b..679eb5af 100644 --- a/docs/search.html +++ b/docs/search.html @@ -3,14 +3,14 @@ - Search — SingleStoreDB 1.7.1 documentation + Search — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      diff --git a/docs/searchindex.js b/docs/searchindex.js index 1c181c24..8f3dea56 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Configuration": [[0, "configuration"]], "Connect using DB-API Parameters": [[115, "connect-using-db-api-parameters"]], "Connect using a URL": [[115, "connect-using-a-url"]], "Connection": [[0, "connection"]], "Connections": [[0, "connections"]], "Contents:": [[116, null]], "Cursor": [[0, "cursor"]], "Dictionaries": [[115, "dictionaries"]], "Executing Queries": [[115, "executing-queries"]], "Fetching Results": [[115, "fetching-results"]], "Getting Started": [[115, null]], "Installation": [[117, null]], "License": [[118, null]], "Management API": [[0, "management-api"]], "Named Substitution": [[115, "named-substitution"]], "Named Tuples": [[115, "named-tuples"]], "Notebook Tools": [[0, "notebook-tools"]], "Paraemeters": [[70, "paraemeters"]], "Parameter Substitution": [[115, "parameter-substitution"]], "Positional Substitution": [[115, "positional-substitution"]], "Region": [[0, "region"]], "Result Type": [[115, "result-type"]], "ShowResult": [[0, "showresult"]], "SingleStoreDB Python SDK": [[116, null]], "Specifying Additional Connection Parameters": [[115, "specifying-additional-connection-parameters"]], "Stage": [[0, "stage"]], "StageObject": [[0, "stageobject"]], "Tuples (Default)": [[115, "tuples-default"]], "Utilities": [[0, "utilities"]], "What\u2019s New": [[119, null]], "Workspace": [[0, "workspace"]], "WorkspaceGroup": [[0, "workspacegroup"]], "WorkspaceManager": [[0, "workspacemanager"]], "singlestoredb.auth.get_jwt": [[1, null]], "singlestoredb.connect": [[2, null]], "singlestoredb.connection.Connection": [[3, null]], "singlestoredb.connection.Connection.autocommit": [[4, null]], "singlestoredb.connection.Connection.close": [[5, null]], "singlestoredb.connection.Connection.commit": [[6, null]], "singlestoredb.connection.Connection.cursor": [[7, null]], "singlestoredb.connection.Connection.disable_data_api": [[8, null]], "singlestoredb.connection.Connection.enable_data_api": [[9, null]], "singlestoredb.connection.Connection.is_connected": [[10, null]], "singlestoredb.connection.Connection.rollback": [[11, null]], "singlestoredb.connection.Cursor": [[12, null]], "singlestoredb.connection.Cursor.callproc": [[13, null]], "singlestoredb.connection.Cursor.close": [[14, null]], "singlestoredb.connection.Cursor.execute": [[15, null]], "singlestoredb.connection.Cursor.executemany": [[16, null]], "singlestoredb.connection.Cursor.fetchall": [[17, null]], "singlestoredb.connection.Cursor.fetchmany": [[18, null]], "singlestoredb.connection.Cursor.fetchone": [[19, null]], "singlestoredb.connection.Cursor.is_connected": [[20, null]], "singlestoredb.connection.Cursor.next": [[21, null]], "singlestoredb.connection.Cursor.nextset": [[22, null]], "singlestoredb.connection.Cursor.scroll": [[23, null]], "singlestoredb.connection.Cursor.setinputsizes": [[24, null]], "singlestoredb.connection.Cursor.setoutputsize": [[25, null]], "singlestoredb.connection.ShowAccessor.aggregates": [[26, null]], "singlestoredb.connection.ShowAccessor.columns": [[27, null]], "singlestoredb.connection.ShowAccessor.create_aggregate": [[28, null]], "singlestoredb.connection.ShowAccessor.create_function": [[29, null]], "singlestoredb.connection.ShowAccessor.create_pipeline": [[30, null]], "singlestoredb.connection.ShowAccessor.create_table": [[31, null]], "singlestoredb.connection.ShowAccessor.create_view": [[32, null]], "singlestoredb.connection.ShowAccessor.database_status": [[33, null]], "singlestoredb.connection.ShowAccessor.databases": [[34, null]], "singlestoredb.connection.ShowAccessor.errors": [[35, null]], "singlestoredb.connection.ShowAccessor.functions": [[36, null]], "singlestoredb.connection.ShowAccessor.global_status": [[37, null]], "singlestoredb.connection.ShowAccessor.indexes": [[38, null]], "singlestoredb.connection.ShowAccessor.partitions": [[39, null]], "singlestoredb.connection.ShowAccessor.pipelines": [[40, null]], "singlestoredb.connection.ShowAccessor.plan": [[41, null]], "singlestoredb.connection.ShowAccessor.plancache": [[42, null]], "singlestoredb.connection.ShowAccessor.procedures": [[43, null]], "singlestoredb.connection.ShowAccessor.processlist": [[44, null]], "singlestoredb.connection.ShowAccessor.reproduction": [[45, null]], "singlestoredb.connection.ShowAccessor.schemas": [[46, null]], "singlestoredb.connection.ShowAccessor.session_status": [[47, null]], "singlestoredb.connection.ShowAccessor.status": [[48, null]], "singlestoredb.connection.ShowAccessor.table_status": [[49, null]], "singlestoredb.connection.ShowAccessor.tables": [[50, null]], "singlestoredb.connection.ShowAccessor.warnings": [[51, null]], "singlestoredb.connection.ShowResult": [[52, null]], "singlestoredb.create_engine": [[53, null]], "singlestoredb.describe_option": [[54, null]], "singlestoredb.get_option": [[55, null]], "singlestoredb.manage_workspaces": [[56, null]], "singlestoredb.management.region.Region": [[57, null]], "singlestoredb.management.workspace.Stage": [[58, null]], "singlestoredb.management.workspace.Stage.download_file": [[59, null]], "singlestoredb.management.workspace.Stage.download_folder": [[60, null]], "singlestoredb.management.workspace.Stage.exists": [[61, null]], "singlestoredb.management.workspace.Stage.info": [[62, null]], "singlestoredb.management.workspace.Stage.is_dir": [[63, null]], "singlestoredb.management.workspace.Stage.is_file": [[64, null]], "singlestoredb.management.workspace.Stage.listdir": [[65, null]], "singlestoredb.management.workspace.Stage.mkdir": [[66, null]], "singlestoredb.management.workspace.Stage.open": [[67, null]], "singlestoredb.management.workspace.Stage.remove": [[68, null]], "singlestoredb.management.workspace.Stage.removedirs": [[69, null]], "singlestoredb.management.workspace.Stage.rename": [[70, null]], "singlestoredb.management.workspace.Stage.rmdir": [[71, null]], "singlestoredb.management.workspace.Stage.upload_file": [[72, null]], "singlestoredb.management.workspace.Stage.upload_folder": [[73, null]], "singlestoredb.management.workspace.StageObject": [[74, null]], "singlestoredb.management.workspace.StageObject.abspath": [[75, null]], "singlestoredb.management.workspace.StageObject.basename": [[76, null]], "singlestoredb.management.workspace.StageObject.dirname": [[77, null]], "singlestoredb.management.workspace.StageObject.download": [[78, null]], "singlestoredb.management.workspace.StageObject.exists": [[79, null]], "singlestoredb.management.workspace.StageObject.getctime": [[80, null]], "singlestoredb.management.workspace.StageObject.getmtime": [[81, null]], "singlestoredb.management.workspace.StageObject.is_dir": [[82, null]], "singlestoredb.management.workspace.StageObject.is_file": [[83, null]], "singlestoredb.management.workspace.StageObject.open": [[84, null]], "singlestoredb.management.workspace.StageObject.remove": [[85, null]], "singlestoredb.management.workspace.StageObject.removedirs": [[86, null]], "singlestoredb.management.workspace.StageObject.rename": [[87, null]], "singlestoredb.management.workspace.StageObject.rmdir": [[88, null]], "singlestoredb.management.workspace.Workspace": [[89, null]], "singlestoredb.management.workspace.Workspace.connect": [[90, null]], "singlestoredb.management.workspace.Workspace.refresh": [[91, null]], "singlestoredb.management.workspace.Workspace.terminate": [[92, null]], "singlestoredb.management.workspace.Workspace.update": [[93, null]], "singlestoredb.management.workspace.WorkspaceGroup": [[94, null]], "singlestoredb.management.workspace.WorkspaceGroup.create_workspace": [[95, null]], "singlestoredb.management.workspace.WorkspaceGroup.refresh": [[96, null]], "singlestoredb.management.workspace.WorkspaceGroup.stage": [[97, null]], "singlestoredb.management.workspace.WorkspaceGroup.terminate": [[98, null]], "singlestoredb.management.workspace.WorkspaceGroup.update": [[99, null]], "singlestoredb.management.workspace.WorkspaceGroup.workspaces": [[100, null]], "singlestoredb.management.workspace.WorkspaceManager": [[101, null]], "singlestoredb.management.workspace.WorkspaceManager.create_workspace": [[102, null]], "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group": [[103, null]], "singlestoredb.management.workspace.WorkspaceManager.get_workspace": [[104, null]], "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group": [[105, null]], "singlestoredb.management.workspace.WorkspaceManager.organization": [[106, null]], "singlestoredb.management.workspace.WorkspaceManager.regions": [[107, null]], "singlestoredb.management.workspace.WorkspaceManager.workspace_groups": [[108, null]], "singlestoredb.notebook.organization": [[109, null]], "singlestoredb.notebook.secrets": [[110, null]], "singlestoredb.notebook.stage": [[111, null]], "singlestoredb.notebook.workspace": [[112, null]], "singlestoredb.notebook.workspace_group": [[113, null]], "singlestoredb.set_option": [[114, null]], "v0.1.0 - May 6, 2022": [[119, "v0-1-0-may-6-2022"]], "v0.10.0 - December 12, 2023": [[119, "v0-10-0-december-12-2023"]], "v0.10.1 - December 13, 2023": [[119, "v0-10-1-december-13-2023"]], "v0.10.2 - December 14, 2023": [[119, "v0-10-2-december-14-2023"]], "v0.10.3 - January 17, 2024": [[119, "v0-10-3-january-17-2024"]], "v0.10.4 - January 18, 2024": [[119, "v0-10-4-january-18-2024"]], "v0.10.5 - January 23, 2024": [[119, "v0-10-5-january-23-2024"]], "v0.10.6 - January 26, 2024": [[119, "v0-10-6-january-26-2024"]], "v0.10.7 - January 31, 2024": [[119, "v0-10-7-january-31-2024"]], "v0.2.0 - August 5, 2022": [[119, "v0-2-0-august-5-2022"]], "v0.3.0 - September 9, 2022": [[119, "v0-3-0-september-9-2022"]], "v0.3.1 - September 9, 2022": [[119, "v0-3-1-september-9-2022"]], "v0.3.2 - September 14, 2022": [[119, "v0-3-2-september-14-2022"]], "v0.3.3 - September 21, 2022": [[119, "v0-3-3-september-21-2022"]], "v0.4.0 - October 19, 2022": [[119, "v0-4-0-october-19-2022"]], "v0.5.0 - December 8, 2022 (API CHANGES)": [[119, "v0-5-0-december-8-2022-api-changes"]], "v0.5.1 - December 9, 2022": [[119, "v0-5-1-december-9-2022"]], "v0.5.2 - December 14, 2022": [[119, "v0-5-2-december-14-2022"]], "v0.5.3 - January 9, 2023": [[119, "v0-5-3-january-9-2023"]], "v0.5.4 - March 15, 2023": [[119, "v0-5-4-march-15-2023"]], "v0.6.0 - May 17, 2023": [[119, "v0-6-0-may-17-2023"]], "v0.6.1 - May 18, 2023": [[119, "v0-6-1-may-18-2023"]], "v0.7.0 - June 9, 2023": [[119, "v0-7-0-june-9-2023"]], "v0.7.1 - June 15, 2023": [[119, "v0-7-1-june-15-2023"]], "v0.8.0 - July 12, 2023": [[119, "v0-8-0-july-12-2023"]], "v0.8.1 - July 12, 2023": [[119, "v0-8-1-july-12-2023"]], "v0.8.2 - August 10, 2023": [[119, "v0-8-2-august-10-2023"]], "v0.8.3 - August 23, 2023": [[119, "v0-8-3-august-23-2023"]], "v0.8.4 - August 28, 2023": [[119, "v0-8-4-august-28-2023"]], "v0.8.5 - August 29, 2023": [[119, "v0-8-5-august-29-2023"]], "v0.8.6 - August 29, 2023": [[119, "v0-8-6-august-29-2023"]], "v0.8.7 - September 19, 2023": [[119, "v0-8-7-september-19-2023"]], "v0.8.8 - September 26, 2023": [[119, "v0-8-8-september-26-2023"]], "v0.8.9 - October 4, 2023": [[119, "v0-8-9-october-4-2023"]], "v0.9.0 - October 16, 2023": [[119, "v0-9-0-october-16-2023"]], "v0.9.1 - October 17, 2023": [[119, "v0-9-1-october-17-2023"]], "v0.9.2 - October 24, 2023": [[119, "v0-9-2-october-24-2023"]], "v0.9.3 - October 25, 2023": [[119, "v0-9-3-october-25-2023"]], "v0.9.4 - October 31, 2023": [[119, "v0-9-4-october-31-2023"]], "v0.9.5 - October 31, 2023": [[119, "v0-9-5-october-31-2023"]], "v0.9.6 - November 2, 2023": [[119, "v0-9-6-november-2-2023"]], "v1.0.0 - February, 12 2024": [[119, "v1-0-0-february-12-2024"]], "v1.0.1 - February, 16 2024": [[119, "v1-0-1-february-16-2024"]], "v1.0.2 - March, 8 2024": [[119, "v1-0-2-march-8-2024"]], "v1.0.3 - April, 2 2024": [[119, "v1-0-3-april-2-2024"]], "v1.0.4 - April, 3 2024": [[119, "v1-0-4-april-3-2024"]], "v1.1.0 - April, 18 2024": [[119, "v1-1-0-april-18-2024"]], "v1.2.0 - April 25, 2024": [[119, "v1-2-0-april-25-2024"]], "v1.3.0 - May 10, 2024": [[119, "v1-3-0-may-10-2024"]], "v1.3.1 - May 23, 2024": [[119, "v1-3-1-may-23-2024"]], "v1.4.0 - June 13, 2024": [[119, "v1-4-0-june-13-2024"]], "v1.4.1 - July 2, 2024": [[119, "v1-4-1-july-2-2024"]], "v1.4.2 - July 9, 2024": [[119, "v1-4-2-july-9-2024"]], "v1.4.3 - July 10, 2024": [[119, "v1-4-3-july-10-2024"]], "v1.5.0 - July 12, 2024": [[119, "v1-5-0-july-12-2024"]], "v1.6.0 - July 29, 2024": [[119, "v1-6-0-july-29-2024"]], "v1.6.1 - July 31, 2024": [[119, "v1-6-1-july-31-2024"]], "v1.6.2 - August 6, 2024": [[119, "v1-6-2-august-6-2024"]], "v1.6.3 - September 5, 2024": [[119, "v1-6-3-september-5-2024"]], "v1.7.0 - September 20, 2024": [[119, "v1-7-0-september-20-2024"]], "v1.7.1 - September 20, 2024": [[119, "v1-7-1-september-20-2024"]]}, "docnames": ["api", "generated/singlestoredb.auth.get_jwt", "generated/singlestoredb.connect", "generated/singlestoredb.connection.Connection", "generated/singlestoredb.connection.Connection.autocommit", "generated/singlestoredb.connection.Connection.close", "generated/singlestoredb.connection.Connection.commit", "generated/singlestoredb.connection.Connection.cursor", "generated/singlestoredb.connection.Connection.disable_data_api", "generated/singlestoredb.connection.Connection.enable_data_api", "generated/singlestoredb.connection.Connection.is_connected", "generated/singlestoredb.connection.Connection.rollback", "generated/singlestoredb.connection.Cursor", "generated/singlestoredb.connection.Cursor.callproc", "generated/singlestoredb.connection.Cursor.close", "generated/singlestoredb.connection.Cursor.execute", "generated/singlestoredb.connection.Cursor.executemany", "generated/singlestoredb.connection.Cursor.fetchall", "generated/singlestoredb.connection.Cursor.fetchmany", "generated/singlestoredb.connection.Cursor.fetchone", "generated/singlestoredb.connection.Cursor.is_connected", "generated/singlestoredb.connection.Cursor.next", "generated/singlestoredb.connection.Cursor.nextset", "generated/singlestoredb.connection.Cursor.scroll", "generated/singlestoredb.connection.Cursor.setinputsizes", "generated/singlestoredb.connection.Cursor.setoutputsize", "generated/singlestoredb.connection.ShowAccessor.aggregates", "generated/singlestoredb.connection.ShowAccessor.columns", "generated/singlestoredb.connection.ShowAccessor.create_aggregate", "generated/singlestoredb.connection.ShowAccessor.create_function", "generated/singlestoredb.connection.ShowAccessor.create_pipeline", "generated/singlestoredb.connection.ShowAccessor.create_table", "generated/singlestoredb.connection.ShowAccessor.create_view", "generated/singlestoredb.connection.ShowAccessor.database_status", "generated/singlestoredb.connection.ShowAccessor.databases", "generated/singlestoredb.connection.ShowAccessor.errors", "generated/singlestoredb.connection.ShowAccessor.functions", "generated/singlestoredb.connection.ShowAccessor.global_status", "generated/singlestoredb.connection.ShowAccessor.indexes", "generated/singlestoredb.connection.ShowAccessor.partitions", "generated/singlestoredb.connection.ShowAccessor.pipelines", "generated/singlestoredb.connection.ShowAccessor.plan", "generated/singlestoredb.connection.ShowAccessor.plancache", "generated/singlestoredb.connection.ShowAccessor.procedures", "generated/singlestoredb.connection.ShowAccessor.processlist", "generated/singlestoredb.connection.ShowAccessor.reproduction", "generated/singlestoredb.connection.ShowAccessor.schemas", "generated/singlestoredb.connection.ShowAccessor.session_status", "generated/singlestoredb.connection.ShowAccessor.status", "generated/singlestoredb.connection.ShowAccessor.table_status", "generated/singlestoredb.connection.ShowAccessor.tables", "generated/singlestoredb.connection.ShowAccessor.warnings", "generated/singlestoredb.connection.ShowResult", "generated/singlestoredb.create_engine", "generated/singlestoredb.describe_option", "generated/singlestoredb.get_option", "generated/singlestoredb.manage_workspaces", "generated/singlestoredb.management.region.Region", "generated/singlestoredb.management.workspace.Stage", "generated/singlestoredb.management.workspace.Stage.download_file", "generated/singlestoredb.management.workspace.Stage.download_folder", "generated/singlestoredb.management.workspace.Stage.exists", "generated/singlestoredb.management.workspace.Stage.info", "generated/singlestoredb.management.workspace.Stage.is_dir", "generated/singlestoredb.management.workspace.Stage.is_file", "generated/singlestoredb.management.workspace.Stage.listdir", "generated/singlestoredb.management.workspace.Stage.mkdir", "generated/singlestoredb.management.workspace.Stage.open", "generated/singlestoredb.management.workspace.Stage.remove", "generated/singlestoredb.management.workspace.Stage.removedirs", "generated/singlestoredb.management.workspace.Stage.rename", "generated/singlestoredb.management.workspace.Stage.rmdir", "generated/singlestoredb.management.workspace.Stage.upload_file", "generated/singlestoredb.management.workspace.Stage.upload_folder", "generated/singlestoredb.management.workspace.StageObject", "generated/singlestoredb.management.workspace.StageObject.abspath", "generated/singlestoredb.management.workspace.StageObject.basename", "generated/singlestoredb.management.workspace.StageObject.dirname", "generated/singlestoredb.management.workspace.StageObject.download", "generated/singlestoredb.management.workspace.StageObject.exists", "generated/singlestoredb.management.workspace.StageObject.getctime", "generated/singlestoredb.management.workspace.StageObject.getmtime", "generated/singlestoredb.management.workspace.StageObject.is_dir", "generated/singlestoredb.management.workspace.StageObject.is_file", "generated/singlestoredb.management.workspace.StageObject.open", "generated/singlestoredb.management.workspace.StageObject.remove", "generated/singlestoredb.management.workspace.StageObject.removedirs", "generated/singlestoredb.management.workspace.StageObject.rename", "generated/singlestoredb.management.workspace.StageObject.rmdir", "generated/singlestoredb.management.workspace.Workspace", "generated/singlestoredb.management.workspace.Workspace.connect", "generated/singlestoredb.management.workspace.Workspace.refresh", "generated/singlestoredb.management.workspace.Workspace.terminate", "generated/singlestoredb.management.workspace.Workspace.update", "generated/singlestoredb.management.workspace.WorkspaceGroup", "generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace", "generated/singlestoredb.management.workspace.WorkspaceGroup.refresh", "generated/singlestoredb.management.workspace.WorkspaceGroup.stage", "generated/singlestoredb.management.workspace.WorkspaceGroup.terminate", "generated/singlestoredb.management.workspace.WorkspaceGroup.update", "generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces", "generated/singlestoredb.management.workspace.WorkspaceManager", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", "generated/singlestoredb.management.workspace.WorkspaceManager.organization", "generated/singlestoredb.management.workspace.WorkspaceManager.regions", "generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups", "generated/singlestoredb.notebook.organization", "generated/singlestoredb.notebook.secrets", "generated/singlestoredb.notebook.stage", "generated/singlestoredb.notebook.workspace", "generated/singlestoredb.notebook.workspace_group", "generated/singlestoredb.set_option", "getting-started", "index", "install", "license", "whatsnew"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "generated/singlestoredb.auth.get_jwt.rst", "generated/singlestoredb.connect.rst", "generated/singlestoredb.connection.Connection.rst", "generated/singlestoredb.connection.Connection.autocommit.rst", "generated/singlestoredb.connection.Connection.close.rst", "generated/singlestoredb.connection.Connection.commit.rst", "generated/singlestoredb.connection.Connection.cursor.rst", "generated/singlestoredb.connection.Connection.disable_data_api.rst", "generated/singlestoredb.connection.Connection.enable_data_api.rst", "generated/singlestoredb.connection.Connection.is_connected.rst", "generated/singlestoredb.connection.Connection.rollback.rst", "generated/singlestoredb.connection.Cursor.rst", "generated/singlestoredb.connection.Cursor.callproc.rst", "generated/singlestoredb.connection.Cursor.close.rst", "generated/singlestoredb.connection.Cursor.execute.rst", "generated/singlestoredb.connection.Cursor.executemany.rst", "generated/singlestoredb.connection.Cursor.fetchall.rst", "generated/singlestoredb.connection.Cursor.fetchmany.rst", "generated/singlestoredb.connection.Cursor.fetchone.rst", "generated/singlestoredb.connection.Cursor.is_connected.rst", "generated/singlestoredb.connection.Cursor.next.rst", "generated/singlestoredb.connection.Cursor.nextset.rst", "generated/singlestoredb.connection.Cursor.scroll.rst", "generated/singlestoredb.connection.Cursor.setinputsizes.rst", "generated/singlestoredb.connection.Cursor.setoutputsize.rst", "generated/singlestoredb.connection.ShowAccessor.aggregates.rst", "generated/singlestoredb.connection.ShowAccessor.columns.rst", "generated/singlestoredb.connection.ShowAccessor.create_aggregate.rst", "generated/singlestoredb.connection.ShowAccessor.create_function.rst", "generated/singlestoredb.connection.ShowAccessor.create_pipeline.rst", "generated/singlestoredb.connection.ShowAccessor.create_table.rst", "generated/singlestoredb.connection.ShowAccessor.create_view.rst", "generated/singlestoredb.connection.ShowAccessor.database_status.rst", "generated/singlestoredb.connection.ShowAccessor.databases.rst", "generated/singlestoredb.connection.ShowAccessor.errors.rst", "generated/singlestoredb.connection.ShowAccessor.functions.rst", "generated/singlestoredb.connection.ShowAccessor.global_status.rst", "generated/singlestoredb.connection.ShowAccessor.indexes.rst", "generated/singlestoredb.connection.ShowAccessor.partitions.rst", "generated/singlestoredb.connection.ShowAccessor.pipelines.rst", "generated/singlestoredb.connection.ShowAccessor.plan.rst", "generated/singlestoredb.connection.ShowAccessor.plancache.rst", "generated/singlestoredb.connection.ShowAccessor.procedures.rst", "generated/singlestoredb.connection.ShowAccessor.processlist.rst", "generated/singlestoredb.connection.ShowAccessor.reproduction.rst", "generated/singlestoredb.connection.ShowAccessor.schemas.rst", "generated/singlestoredb.connection.ShowAccessor.session_status.rst", "generated/singlestoredb.connection.ShowAccessor.status.rst", "generated/singlestoredb.connection.ShowAccessor.table_status.rst", "generated/singlestoredb.connection.ShowAccessor.tables.rst", "generated/singlestoredb.connection.ShowAccessor.warnings.rst", "generated/singlestoredb.connection.ShowResult.rst", "generated/singlestoredb.create_engine.rst", "generated/singlestoredb.describe_option.rst", "generated/singlestoredb.get_option.rst", "generated/singlestoredb.manage_workspaces.rst", "generated/singlestoredb.management.region.Region.rst", "generated/singlestoredb.management.workspace.Stage.rst", "generated/singlestoredb.management.workspace.Stage.download_file.rst", "generated/singlestoredb.management.workspace.Stage.download_folder.rst", "generated/singlestoredb.management.workspace.Stage.exists.rst", "generated/singlestoredb.management.workspace.Stage.info.rst", "generated/singlestoredb.management.workspace.Stage.is_dir.rst", "generated/singlestoredb.management.workspace.Stage.is_file.rst", "generated/singlestoredb.management.workspace.Stage.listdir.rst", "generated/singlestoredb.management.workspace.Stage.mkdir.rst", "generated/singlestoredb.management.workspace.Stage.open.rst", "generated/singlestoredb.management.workspace.Stage.remove.rst", "generated/singlestoredb.management.workspace.Stage.removedirs.rst", "generated/singlestoredb.management.workspace.Stage.rename.rst", "generated/singlestoredb.management.workspace.Stage.rmdir.rst", "generated/singlestoredb.management.workspace.Stage.upload_file.rst", "generated/singlestoredb.management.workspace.Stage.upload_folder.rst", "generated/singlestoredb.management.workspace.StageObject.rst", "generated/singlestoredb.management.workspace.StageObject.abspath.rst", "generated/singlestoredb.management.workspace.StageObject.basename.rst", "generated/singlestoredb.management.workspace.StageObject.dirname.rst", "generated/singlestoredb.management.workspace.StageObject.download.rst", "generated/singlestoredb.management.workspace.StageObject.exists.rst", "generated/singlestoredb.management.workspace.StageObject.getctime.rst", "generated/singlestoredb.management.workspace.StageObject.getmtime.rst", "generated/singlestoredb.management.workspace.StageObject.is_dir.rst", "generated/singlestoredb.management.workspace.StageObject.is_file.rst", "generated/singlestoredb.management.workspace.StageObject.open.rst", "generated/singlestoredb.management.workspace.StageObject.remove.rst", "generated/singlestoredb.management.workspace.StageObject.removedirs.rst", "generated/singlestoredb.management.workspace.StageObject.rename.rst", "generated/singlestoredb.management.workspace.StageObject.rmdir.rst", "generated/singlestoredb.management.workspace.Workspace.rst", "generated/singlestoredb.management.workspace.Workspace.connect.rst", "generated/singlestoredb.management.workspace.Workspace.refresh.rst", "generated/singlestoredb.management.workspace.Workspace.terminate.rst", "generated/singlestoredb.management.workspace.Workspace.update.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.stage.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.update.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.organization.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.regions.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.rst", "generated/singlestoredb.notebook.organization.rst", "generated/singlestoredb.notebook.secrets.rst", "generated/singlestoredb.notebook.stage.rst", "generated/singlestoredb.notebook.workspace.rst", "generated/singlestoredb.notebook.workspace_group.rst", "generated/singlestoredb.set_option.rst", "getting-started.rst", "index.rst", "install.rst", "license.rst", "whatsnew.rst"], "indexentries": {"__init__() (singlestoredb.connection.connection method)": [[3, "singlestoredb.connection.Connection.__init__", false]], "__init__() (singlestoredb.connection.cursor method)": [[12, "singlestoredb.connection.Cursor.__init__", false]], "__init__() (singlestoredb.connection.showresult method)": [[52, "singlestoredb.connection.ShowResult.__init__", false]], "__init__() (singlestoredb.management.region.region method)": [[57, "singlestoredb.management.region.Region.__init__", false]], "__init__() (singlestoredb.management.workspace.stage method)": [[58, "singlestoredb.management.workspace.Stage.__init__", false]], "__init__() (singlestoredb.management.workspace.stageobject method)": [[74, "singlestoredb.management.workspace.StageObject.__init__", false]], "__init__() (singlestoredb.management.workspace.workspace method)": [[89, "singlestoredb.management.workspace.Workspace.__init__", false]], "__init__() (singlestoredb.management.workspace.workspacegroup method)": [[94, "singlestoredb.management.workspace.WorkspaceGroup.__init__", false]], "__init__() (singlestoredb.management.workspace.workspacemanager method)": [[101, "singlestoredb.management.workspace.WorkspaceManager.__init__", false]], "abspath() (singlestoredb.management.workspace.stageobject method)": [[75, "singlestoredb.management.workspace.StageObject.abspath", false]], "aggregates() (singlestoredb.connection.showaccessor method)": [[26, "singlestoredb.connection.ShowAccessor.aggregates", false]], "autocommit() (singlestoredb.connection.connection method)": [[4, "singlestoredb.connection.Connection.autocommit", false]], "basename() (singlestoredb.management.workspace.stageobject method)": [[76, "singlestoredb.management.workspace.StageObject.basename", false]], "callproc() (singlestoredb.connection.cursor method)": [[13, "singlestoredb.connection.Cursor.callproc", false]], "close() (singlestoredb.connection.connection method)": [[5, "singlestoredb.connection.Connection.close", false]], "close() (singlestoredb.connection.cursor method)": [[14, "singlestoredb.connection.Cursor.close", false]], "columns() (singlestoredb.connection.showaccessor method)": [[27, "singlestoredb.connection.ShowAccessor.columns", false]], "commit() (singlestoredb.connection.connection method)": [[6, "singlestoredb.connection.Connection.commit", false]], "connect() (in module singlestoredb)": [[2, "singlestoredb.connect", false]], "connect() (singlestoredb.management.workspace.workspace method)": [[90, "singlestoredb.management.workspace.Workspace.connect", false]], "connection (class in singlestoredb.connection)": [[3, "singlestoredb.connection.Connection", false]], "create_aggregate() (singlestoredb.connection.showaccessor method)": [[28, "singlestoredb.connection.ShowAccessor.create_aggregate", false]], "create_engine() (in module singlestoredb)": [[53, "singlestoredb.create_engine", false]], "create_function() (singlestoredb.connection.showaccessor method)": [[29, "singlestoredb.connection.ShowAccessor.create_function", false]], "create_pipeline() (singlestoredb.connection.showaccessor method)": [[30, "singlestoredb.connection.ShowAccessor.create_pipeline", false]], "create_table() (singlestoredb.connection.showaccessor method)": [[31, "singlestoredb.connection.ShowAccessor.create_table", false]], "create_view() (singlestoredb.connection.showaccessor method)": [[32, "singlestoredb.connection.ShowAccessor.create_view", false]], "create_workspace() (singlestoredb.management.workspace.workspacegroup method)": [[95, "singlestoredb.management.workspace.WorkspaceGroup.create_workspace", false]], "create_workspace() (singlestoredb.management.workspace.workspacemanager method)": [[102, "singlestoredb.management.workspace.WorkspaceManager.create_workspace", false]], "create_workspace_group() (singlestoredb.management.workspace.workspacemanager method)": [[103, "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", false]], "cursor (class in singlestoredb.connection)": [[12, "singlestoredb.connection.Cursor", false]], "cursor() (singlestoredb.connection.connection method)": [[7, "singlestoredb.connection.Connection.cursor", false]], "database_status() (singlestoredb.connection.showaccessor method)": [[33, "singlestoredb.connection.ShowAccessor.database_status", false]], "databases() (singlestoredb.connection.showaccessor method)": [[34, "singlestoredb.connection.ShowAccessor.databases", false]], "describe_option() (in module singlestoredb)": [[54, "singlestoredb.describe_option", false]], "dirname() (singlestoredb.management.workspace.stageobject method)": [[77, "singlestoredb.management.workspace.StageObject.dirname", false]], "disable_data_api() (singlestoredb.connection.connection method)": [[8, "singlestoredb.connection.Connection.disable_data_api", false]], "download() (singlestoredb.management.workspace.stageobject method)": [[78, "singlestoredb.management.workspace.StageObject.download", false]], "download_file() (singlestoredb.management.workspace.stage method)": [[59, "singlestoredb.management.workspace.Stage.download_file", false]], "download_folder() (singlestoredb.management.workspace.stage method)": [[60, "singlestoredb.management.workspace.Stage.download_folder", false]], "enable_data_api() (singlestoredb.connection.connection method)": [[9, "singlestoredb.connection.Connection.enable_data_api", false]], "errors() (singlestoredb.connection.showaccessor method)": [[35, "singlestoredb.connection.ShowAccessor.errors", false]], "execute() (singlestoredb.connection.cursor method)": [[15, "singlestoredb.connection.Cursor.execute", false]], "executemany() (singlestoredb.connection.cursor method)": [[16, "singlestoredb.connection.Cursor.executemany", false]], "exists() (singlestoredb.management.workspace.stage method)": [[61, "singlestoredb.management.workspace.Stage.exists", false]], "exists() (singlestoredb.management.workspace.stageobject method)": [[79, "singlestoredb.management.workspace.StageObject.exists", false]], "fetchall() (singlestoredb.connection.cursor method)": [[17, "singlestoredb.connection.Cursor.fetchall", false]], "fetchmany() (singlestoredb.connection.cursor method)": [[18, "singlestoredb.connection.Cursor.fetchmany", false]], "fetchone() (singlestoredb.connection.cursor method)": [[19, "singlestoredb.connection.Cursor.fetchone", false]], "functions() (singlestoredb.connection.showaccessor method)": [[36, "singlestoredb.connection.ShowAccessor.functions", false]], "get_jwt() (in module singlestoredb.auth)": [[1, "singlestoredb.auth.get_jwt", false]], "get_option() (in module singlestoredb)": [[55, "singlestoredb.get_option", false]], "get_workspace() (singlestoredb.management.workspace.workspacemanager method)": [[104, "singlestoredb.management.workspace.WorkspaceManager.get_workspace", false]], "get_workspace_group() (singlestoredb.management.workspace.workspacemanager method)": [[105, "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", false]], "getctime() (singlestoredb.management.workspace.stageobject method)": [[80, "singlestoredb.management.workspace.StageObject.getctime", false]], "getmtime() (singlestoredb.management.workspace.stageobject method)": [[81, "singlestoredb.management.workspace.StageObject.getmtime", false]], "global_status() (singlestoredb.connection.showaccessor method)": [[37, "singlestoredb.connection.ShowAccessor.global_status", false]], "indexes() (singlestoredb.connection.showaccessor method)": [[38, "singlestoredb.connection.ShowAccessor.indexes", false]], "info() (singlestoredb.management.workspace.stage method)": [[62, "singlestoredb.management.workspace.Stage.info", false]], "is_connected() (singlestoredb.connection.connection method)": [[10, "singlestoredb.connection.Connection.is_connected", false]], "is_connected() (singlestoredb.connection.cursor method)": [[20, "singlestoredb.connection.Cursor.is_connected", false]], "is_dir() (singlestoredb.management.workspace.stage method)": [[63, "singlestoredb.management.workspace.Stage.is_dir", false]], "is_dir() (singlestoredb.management.workspace.stageobject method)": [[82, "singlestoredb.management.workspace.StageObject.is_dir", false]], "is_file() (singlestoredb.management.workspace.stage method)": [[64, "singlestoredb.management.workspace.Stage.is_file", false]], "is_file() (singlestoredb.management.workspace.stageobject method)": [[83, "singlestoredb.management.workspace.StageObject.is_file", false]], "listdir() (singlestoredb.management.workspace.stage method)": [[65, "singlestoredb.management.workspace.Stage.listdir", false]], "manage_workspaces() (in module singlestoredb)": [[56, "singlestoredb.manage_workspaces", false]], "mkdir() (singlestoredb.management.workspace.stage method)": [[66, "singlestoredb.management.workspace.Stage.mkdir", false]], "module": [[0, "module-singlestoredb", false]], "next() (singlestoredb.connection.cursor method)": [[21, "singlestoredb.connection.Cursor.next", false]], "nextset() (singlestoredb.connection.cursor method)": [[22, "singlestoredb.connection.Cursor.nextset", false]], "open() (singlestoredb.management.workspace.stage method)": [[67, "singlestoredb.management.workspace.Stage.open", false]], "open() (singlestoredb.management.workspace.stageobject method)": [[84, "singlestoredb.management.workspace.StageObject.open", false]], "organization (in module singlestoredb.notebook)": [[109, "singlestoredb.notebook.organization", false]], "organization (singlestoredb.management.workspace.workspacemanager property)": [[106, "singlestoredb.management.workspace.WorkspaceManager.organization", false]], "partitions() (singlestoredb.connection.showaccessor method)": [[39, "singlestoredb.connection.ShowAccessor.partitions", false]], "pipelines() (singlestoredb.connection.showaccessor method)": [[40, "singlestoredb.connection.ShowAccessor.pipelines", false]], "plan() (singlestoredb.connection.showaccessor method)": [[41, "singlestoredb.connection.ShowAccessor.plan", false]], "plancache() (singlestoredb.connection.showaccessor method)": [[42, "singlestoredb.connection.ShowAccessor.plancache", false]], "procedures() (singlestoredb.connection.showaccessor method)": [[43, "singlestoredb.connection.ShowAccessor.procedures", false]], "processlist() (singlestoredb.connection.showaccessor method)": [[44, "singlestoredb.connection.ShowAccessor.processlist", false]], "refresh() (singlestoredb.management.workspace.workspace method)": [[91, "singlestoredb.management.workspace.Workspace.refresh", false]], "refresh() (singlestoredb.management.workspace.workspacegroup method)": [[96, "singlestoredb.management.workspace.WorkspaceGroup.refresh", false]], "region (class in singlestoredb.management.region)": [[57, "singlestoredb.management.region.Region", false]], "regions() (singlestoredb.management.workspace.workspacemanager method)": [[107, "singlestoredb.management.workspace.WorkspaceManager.regions", false]], "remove() (singlestoredb.management.workspace.stage method)": [[68, "singlestoredb.management.workspace.Stage.remove", false]], "remove() (singlestoredb.management.workspace.stageobject method)": [[85, "singlestoredb.management.workspace.StageObject.remove", false]], "removedirs() (singlestoredb.management.workspace.stage method)": [[69, "singlestoredb.management.workspace.Stage.removedirs", false]], "removedirs() (singlestoredb.management.workspace.stageobject method)": [[86, "singlestoredb.management.workspace.StageObject.removedirs", false]], "rename() (singlestoredb.management.workspace.stage method)": [[70, "singlestoredb.management.workspace.Stage.rename", false]], "rename() (singlestoredb.management.workspace.stageobject method)": [[87, "singlestoredb.management.workspace.StageObject.rename", false]], "reproduction() (singlestoredb.connection.showaccessor method)": [[45, "singlestoredb.connection.ShowAccessor.reproduction", false]], "rmdir() (singlestoredb.management.workspace.stage method)": [[71, "singlestoredb.management.workspace.Stage.rmdir", false]], "rmdir() (singlestoredb.management.workspace.stageobject method)": [[88, "singlestoredb.management.workspace.StageObject.rmdir", false]], "rollback() (singlestoredb.connection.connection method)": [[11, "singlestoredb.connection.Connection.rollback", false]], "schemas() (singlestoredb.connection.showaccessor method)": [[46, "singlestoredb.connection.ShowAccessor.schemas", false]], "scroll() (singlestoredb.connection.cursor method)": [[23, "singlestoredb.connection.Cursor.scroll", false]], "secrets (in module singlestoredb.notebook)": [[110, "singlestoredb.notebook.secrets", false]], "session_status() (singlestoredb.connection.showaccessor method)": [[47, "singlestoredb.connection.ShowAccessor.session_status", false]], "set_option() (in module singlestoredb)": [[114, "singlestoredb.set_option", false]], "setinputsizes() (singlestoredb.connection.cursor method)": [[24, "singlestoredb.connection.Cursor.setinputsizes", false]], "setoutputsize() (singlestoredb.connection.cursor method)": [[25, "singlestoredb.connection.Cursor.setoutputsize", false]], "showresult (class in singlestoredb.connection)": [[52, "singlestoredb.connection.ShowResult", false]], "singlestoredb": [[0, "module-singlestoredb", false]], "stage (class in singlestoredb.management.workspace)": [[58, "singlestoredb.management.workspace.Stage", false]], "stage (in module singlestoredb.notebook)": [[111, "singlestoredb.notebook.stage", false]], "stage (singlestoredb.management.workspace.workspacegroup property)": [[97, "singlestoredb.management.workspace.WorkspaceGroup.stage", false]], "stageobject (class in singlestoredb.management.workspace)": [[74, "singlestoredb.management.workspace.StageObject", false]], "status() (singlestoredb.connection.showaccessor method)": [[48, "singlestoredb.connection.ShowAccessor.status", false]], "table_status() (singlestoredb.connection.showaccessor method)": [[49, "singlestoredb.connection.ShowAccessor.table_status", false]], "tables() (singlestoredb.connection.showaccessor method)": [[50, "singlestoredb.connection.ShowAccessor.tables", false]], "terminate() (singlestoredb.management.workspace.workspace method)": [[92, "singlestoredb.management.workspace.Workspace.terminate", false]], "terminate() (singlestoredb.management.workspace.workspacegroup method)": [[98, "singlestoredb.management.workspace.WorkspaceGroup.terminate", false]], "update() (singlestoredb.management.workspace.workspace method)": [[93, "singlestoredb.management.workspace.Workspace.update", false]], "update() (singlestoredb.management.workspace.workspacegroup method)": [[99, "singlestoredb.management.workspace.WorkspaceGroup.update", false]], "upload_file() (singlestoredb.management.workspace.stage method)": [[72, "singlestoredb.management.workspace.Stage.upload_file", false]], "upload_folder() (singlestoredb.management.workspace.stage method)": [[73, "singlestoredb.management.workspace.Stage.upload_folder", false]], "warnings() (singlestoredb.connection.showaccessor method)": [[51, "singlestoredb.connection.ShowAccessor.warnings", false]], "workspace (class in singlestoredb.management.workspace)": [[89, "singlestoredb.management.workspace.Workspace", false]], "workspace (in module singlestoredb.notebook)": [[112, "singlestoredb.notebook.workspace", false]], "workspace_group (in module singlestoredb.notebook)": [[113, "singlestoredb.notebook.workspace_group", false]], "workspace_groups (singlestoredb.management.workspace.workspacemanager property)": [[108, "singlestoredb.management.workspace.WorkspaceManager.workspace_groups", false]], "workspacegroup (class in singlestoredb.management.workspace)": [[94, "singlestoredb.management.workspace.WorkspaceGroup", false]], "workspacemanager (class in singlestoredb.management.workspace)": [[101, "singlestoredb.management.workspace.WorkspaceManager", false]], "workspaces (singlestoredb.management.workspace.workspacegroup property)": [[100, "singlestoredb.management.workspace.WorkspaceGroup.workspaces", false]]}, "objects": {"": [[0, 0, 0, "-", "singlestoredb"]], "singlestoredb": [[2, 1, 1, "", "connect"], [53, 1, 1, "", "create_engine"], [54, 1, 1, "", "describe_option"], [55, 1, 1, "", "get_option"], [56, 1, 1, "", "manage_workspaces"], [114, 1, 1, "", "set_option"]], "singlestoredb.auth": [[1, 1, 1, "", "get_jwt"]], "singlestoredb.connection": [[3, 2, 1, "", "Connection"], [12, 2, 1, "", "Cursor"], [52, 2, 1, "", "ShowResult"]], "singlestoredb.connection.Connection": [[3, 3, 1, "", "__init__"], [4, 3, 1, "", "autocommit"], [5, 3, 1, "", "close"], [6, 3, 1, "", "commit"], [7, 3, 1, "", "cursor"], [8, 3, 1, "", "disable_data_api"], [9, 3, 1, "", "enable_data_api"], [10, 3, 1, "", "is_connected"], [11, 3, 1, "", "rollback"]], "singlestoredb.connection.Cursor": [[12, 3, 1, "", "__init__"], [13, 3, 1, "", "callproc"], [14, 3, 1, "", "close"], [15, 3, 1, "", "execute"], [16, 3, 1, "", "executemany"], [17, 3, 1, "", "fetchall"], [18, 3, 1, "", "fetchmany"], [19, 3, 1, "", "fetchone"], [20, 3, 1, "", "is_connected"], [21, 3, 1, "", "next"], [22, 3, 1, "", "nextset"], [23, 3, 1, "", "scroll"], [24, 3, 1, "", "setinputsizes"], [25, 3, 1, "", "setoutputsize"]], "singlestoredb.connection.ShowAccessor": [[26, 3, 1, "", "aggregates"], [27, 3, 1, "", "columns"], [28, 3, 1, "", "create_aggregate"], [29, 3, 1, "", "create_function"], [30, 3, 1, "", "create_pipeline"], [31, 3, 1, "", "create_table"], [32, 3, 1, "", "create_view"], [33, 3, 1, "", "database_status"], [34, 3, 1, "", "databases"], [35, 3, 1, "", "errors"], [36, 3, 1, "", "functions"], [37, 3, 1, "", "global_status"], [38, 3, 1, "", "indexes"], [39, 3, 1, "", "partitions"], [40, 3, 1, "", "pipelines"], [41, 3, 1, "", "plan"], [42, 3, 1, "", "plancache"], [43, 3, 1, "", "procedures"], [44, 3, 1, "", "processlist"], [45, 3, 1, "", "reproduction"], [46, 3, 1, "", "schemas"], [47, 3, 1, "", "session_status"], [48, 3, 1, "", "status"], [49, 3, 1, "", "table_status"], [50, 3, 1, "", "tables"], [51, 3, 1, "", "warnings"]], "singlestoredb.connection.ShowResult": [[52, 3, 1, "", "__init__"]], "singlestoredb.management.region": [[57, 2, 1, "", "Region"]], "singlestoredb.management.region.Region": [[57, 3, 1, "", "__init__"]], "singlestoredb.management.workspace": [[58, 2, 1, "", "Stage"], [74, 2, 1, "", "StageObject"], [89, 2, 1, "", "Workspace"], [94, 2, 1, "", "WorkspaceGroup"], [101, 2, 1, "", "WorkspaceManager"]], "singlestoredb.management.workspace.Stage": [[58, 3, 1, "", "__init__"], [59, 3, 1, "", "download_file"], [60, 3, 1, "", "download_folder"], [61, 3, 1, "", "exists"], [62, 3, 1, "", "info"], [63, 3, 1, "", "is_dir"], [64, 3, 1, "", "is_file"], [65, 3, 1, "", "listdir"], [66, 3, 1, "", "mkdir"], [67, 3, 1, "", "open"], [68, 3, 1, "", "remove"], [69, 3, 1, "", "removedirs"], [70, 3, 1, "", "rename"], [71, 3, 1, "", "rmdir"], [72, 3, 1, "", "upload_file"], [73, 3, 1, "", "upload_folder"]], "singlestoredb.management.workspace.StageObject": [[74, 3, 1, "", "__init__"], [75, 3, 1, "", "abspath"], [76, 3, 1, "", "basename"], [77, 3, 1, "", "dirname"], [78, 3, 1, "", "download"], [79, 3, 1, "", "exists"], [80, 3, 1, "", "getctime"], [81, 3, 1, "", "getmtime"], [82, 3, 1, "", "is_dir"], [83, 3, 1, "", "is_file"], [84, 3, 1, "", "open"], [85, 3, 1, "", "remove"], [86, 3, 1, "", "removedirs"], [87, 3, 1, "", "rename"], [88, 3, 1, "", "rmdir"]], "singlestoredb.management.workspace.Workspace": [[89, 3, 1, "", "__init__"], [90, 3, 1, "", "connect"], [91, 3, 1, "", "refresh"], [92, 3, 1, "", "terminate"], [93, 3, 1, "", "update"]], "singlestoredb.management.workspace.WorkspaceGroup": [[94, 3, 1, "", "__init__"], [95, 3, 1, "", "create_workspace"], [96, 3, 1, "", "refresh"], [97, 4, 1, "", "stage"], [98, 3, 1, "", "terminate"], [99, 3, 1, "", "update"], [100, 4, 1, "", "workspaces"]], "singlestoredb.management.workspace.WorkspaceManager": [[101, 3, 1, "", "__init__"], [102, 3, 1, "", "create_workspace"], [103, 3, 1, "", "create_workspace_group"], [104, 3, 1, "", "get_workspace"], [105, 3, 1, "", "get_workspace_group"], [106, 4, 1, "", "organization"], [107, 3, 1, "", "regions"], [108, 4, 1, "", "workspace_groups"]], "singlestoredb.notebook": [[109, 5, 1, "", "organization"], [110, 5, 1, "", "secrets"], [111, 5, 1, "", "stage"], [112, 5, 1, "", "workspace"], [113, 5, 1, "", "workspace_group"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property", "5": "py:data"}, "terms": {"": [0, 1, 2, 15, 16, 93, 95, 102, 115, 116, 118], "0": [2, 99, 103, 115, 116, 118], "00": [95, 99, 102, 103], "01": [99, 103], "02": [99, 103], "02t15": [99, 103], "04": [99, 103], "05z07": [99, 103], "1": [0, 2, 93, 95, 102, 115, 116, 118], "10": [2, 52, 92, 95, 98, 102, 115, 116], "100": [15, 16, 18], "11": [115, 119], "12": [115, 116], "13": [115, 116], "14": 116, "15": 116, "16": 116, "17": 116, "18": 116, "19": 116, "2": [0, 2, 93, 95, 102, 115, 116, 118], "20": 116, "200": 16, "2004": 118, "2021": [99, 103, 118], "2022": 116, "2023": 116, "2024": 116, "21": 116, "23": [99, 103, 116], "24": 116, "25": 116, "26": 116, "28": 116, "29": 116, "3": [0, 115, 116], "300": 16, "31": 116, "31536000": 2, "32": 119, "3306": 2, "3h30m": [99, 103], "4": [0, 93, 95, 102, 115, 116], "427b": 109, "443": 2, "5": [0, 115, 116], "50": 118, "6": [99, 103, 115, 116], "60": 1, "600": [92, 95, 98, 102, 115], "682e": 109, "7": [115, 116], "8": [115, 116], "80": 2, "8080": 2, "9": [115, 116, 118], "A": [115, 118], "AND": 118, "AS": 118, "As": 115, "At": [99, 103], "By": [2, 115], "FOR": 118, "For": 118, "If": [1, 9, 13, 17, 18, 21, 22, 73, 92, 93, 95, 98, 99, 102, 103, 115, 118], "In": [0, 115, 118], "It": [0, 57, 58, 74, 89, 93, 94, 95, 102, 109, 111, 112, 113, 116], "Not": 118, "OF": 118, "ON": 115, "OR": 118, "The": [0, 1, 2, 9, 12, 13, 15, 16, 22, 53, 55, 56, 67, 84, 87, 93, 99, 101, 102, 103, 114, 115, 116, 117, 118], "These": 0, "To": [0, 2, 54, 73, 118], "WITH": 119, "__init__": [3, 12, 52, 57, 58, 74, 89, 94, 101], "_connector_nam": 2, "_object": [110, 111], "a6cc": 109, "aarch64": 119, "abil": 119, "abl": 115, "about": [0, 44, 62], "abov": [0, 118], "absolut": 23, "abstract": [5, 6, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 22, 23, 24, 25], "accept": 118, "access": [0, 13, 52, 56, 89, 94, 101, 110, 112, 113], "access_token": [56, 101], "accessor": 119, "account": 0, "act": [0, 118], "activ": [95, 98, 102], "ad": [67, 84, 119], "add": [118, 119], "add_endpoint_to_firewall_rang": 119, "addendum": 118, "addit": [0, 2, 116, 118], "additon": 115, "address": [2, 115], "admin": [99, 103], "admin_password": [99, 103], "advis": 118, "affect": [15, 16], "against": [16, 118], "aggreg": 28, "agre": 118, "agreement": 118, "ai": 119, "all": [0, 17, 26, 34, 36, 38, 40, 42, 43, 54, 73, 93, 99, 103, 115, 118, 119], "alleg": 118, "allow": [0, 2, 9, 99, 103], "allow_all_traff": [94, 99, 103], "alon": 118, "along": 118, "alongsid": 118, "alreadi": [66, 70, 72, 73, 87], "also": [0, 2, 52, 115, 116, 118], "amazon": 103, "amount": 115, "an": [0, 2, 22, 53, 55, 59, 60, 72, 78, 95, 99, 102, 103, 114, 115, 118, 119], "ani": [0, 1, 2, 3, 13, 15, 16, 17, 18, 19, 21, 52, 53, 54, 55, 89, 90, 93, 95, 102, 114, 118], "annot": 118, "anoth": 22, "apach": 118, "api": [2, 8, 9, 56, 57, 89, 94, 101, 109, 112, 113, 116], "app": 119, "appear": 118, "appendix": 118, "appli": [93, 118], "applic": [118, 119], "appropri": 118, "april": 116, "ar": [0, 2, 3, 17, 18, 19, 52, 53, 67, 73, 84, 89, 90, 94, 99, 103, 112, 113, 115, 118, 119], "arbitrari": 114, "archiv": 118, "area": 24, "arg": [15, 16, 52, 53, 114], "arg1": 13, "arg2": 13, "argument": [90, 114], "aris": 118, "arrai": 119, "arrays": 18, "arrow": [2, 119], "assert": 118, "associ": [93, 95, 102, 103, 118], "assum": 118, "async": 119, "attach": 118, "attribut": [0, 2, 3, 12, 18, 52, 57, 74, 89, 94, 101, 110, 118], "august": 116, "auth": [2, 116, 119], "authent": [1, 2, 56, 119], "author": [2, 118], "authorship": 118, "auto": [93, 95, 102, 115], "auto_attach": 115, "auto_increment_incr": 115, "auto_increment_offset": 115, "auto_profile_typ": 115, "auto_repl": 115, "auto_suspend": [89, 93, 95, 102], "autocommit": [2, 115, 119], "automat": [0, 2, 115, 119], "autostats_flush_interval_sec": 115, "avail": [0, 22, 100, 107, 108, 118], "aw": 103, "b": [67, 84], "back": 115, "backup": 103, "backup_bucket_kms_key_id": 103, "bar": 115, "base": [56, 101, 118, 119], "base_url": [56, 101], "basi": 118, "batch": 115, "been": [2, 115, 118], "befor": [1, 92, 95, 98, 102, 119], "behalf": 118, "behavior": 2, "being": [1, 115], "below": [0, 2, 115, 118], "benefici": 118, "better": 115, "between": [92, 95, 98, 102], "binari": [2, 67, 84, 119], "binaryio": 72, "bind": 118, "bit": 119, "blob": 119, "block": 103, "boilerpl": 118, "bool": [0, 2, 4, 10, 20, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 61, 63, 64, 65, 66, 70, 72, 73, 74, 78, 79, 82, 83, 87, 92, 94, 95, 98, 99, 102, 103], "boolean": 119, "bracket": 118, "break": [18, 19], "browser": [0, 1, 52], "browser_sso": 2, "bson": 2, "bucket": 103, "buffer": [2, 25], "builtin": 119, "byte": [15, 59, 78], "bytesio": [67, 84], "c": 119, "cach": [93, 95, 102, 119], "cache_config": [89, 93, 95, 102], "calcul": 119, "call": [0, 3, 12, 13, 22, 53, 57, 89, 94, 109, 112, 113, 115, 119], "callabl": 2, "can": [0, 1, 2, 13, 15, 16, 52, 53, 67, 84, 93, 95, 99, 102, 103, 115, 117], "cannot": 118, "carri": 118, "caus": 118, "certif": 2, "chang": [115, 116, 118], "charact": [2, 118], "charg": 118, "charset": 2, "check": [92, 98], "choic": 115, "choos": 118, "chrome": 1, "chromium": 1, "cidr": [99, 103], "cipher": [2, 119], "claim": 118, "class": [3, 12, 52, 57, 58, 74, 89, 94, 101, 118], "client": [115, 117], "client_found_row": [2, 119], "cloud": [0, 109, 116, 119], "cluster": [1, 57, 119], "cmek": 103, "code": [0, 2, 15, 16, 28, 29, 30, 31, 32, 45, 53, 118, 119], "column": [0, 25, 52, 115], "com": [1, 2], "combin": 118, "command": [12, 119], "comment": 118, "commerci": 118, "common": 118, "commun": 118, "compat": [1, 22, 119], "compil": [42, 118], "compli": 118, "complianc": 118, "compliant": [0, 116, 119], "comput": [115, 118], "condit": 118, "configur": [93, 95, 102, 116, 118, 119], "conn": [2, 52, 115], "conn_attr": 2, "connect": [1, 116, 119], "connect_timeout": [2, 119], "connector": [2, 116], "consecut": 114, "consequenti": 118, "consid": 119, "consist": 118, "conspicu": 118, "constitut": 118, "constru": 118, "constructor": 52, "consum": 2, "contain": [2, 118], "content": [59, 73, 74, 78, 118], "context": 2, "continu": 103, "contract": 118, "contribut": 118, "contributor": 118, "contributori": 118, "control": [2, 118], "conv": 2, "convers": [2, 118, 119], "convert": [59, 78, 119], "copi": 118, "copyright": 118, "correspond": 0, "counterclaim": 118, "creat": [0, 3, 7, 53, 66, 67, 74, 84, 89, 90, 94, 95, 102, 103, 112, 113], "create_engin": [0, 116, 119], "create_workspac": [0, 89, 112, 119], "create_workspace_group": [94, 113], "created_at": [89, 94], "creation": [28, 29, 30, 31, 32, 80], "credenti": [2, 115], "credential_typ": 2, "cross": 118, "cur": [2, 13, 15, 16, 17, 18, 19, 115], "current": [0, 9, 26, 33, 36, 37, 39, 40, 43, 44, 49, 50, 91, 96, 106], "cursor": [2, 115, 116], "custom": 103, "customari": 118, "dai": [99, 103], "damag": 118, "dashboard": 119, "data": [2, 8, 9, 15, 45, 52, 59, 67, 78, 84, 99, 103, 115, 119], "data_bucket_kms_key_id": 103, "databas": [0, 1, 2, 5, 10, 12, 26, 33, 36, 39, 40, 43, 49, 50, 90, 115, 116, 119], "datafram": [17, 18, 19, 21], "date": 118, "datetim": [74, 80, 81, 89, 94], "db": [0, 116, 119], "db_name": 2, "dbt": 2, "debug": 119, "decemb": 116, "decod": 2, "default": [0, 1, 2, 67, 84, 119], "defend": 118, "defer": 119, "defin": [0, 2, 115, 118], "definit": [3, 89, 93, 94, 99, 104, 105, 112, 113, 118], "delet": [68, 69, 71, 85, 86, 88], "deliber": 118, "depend": 115, "deploi": 103, "deploy": 93, "deployment_typ": [89, 93], "deprec": 2, "deriv": 118, "describ": [2, 115, 118, 119], "describe_opt": [0, 116], "descript": [54, 118], "design": 118, "destroi": 0, "detail": 44, "determin": [10, 118], "dict": [2, 15, 16, 17, 18, 19, 21, 89, 93, 95, 99, 102, 103, 114, 115], "dictionari": [0, 2, 15, 16, 52, 119], "differ": 118, "direct": 118, "directli": [3, 12, 57, 58, 74, 89, 94, 109, 111, 112, 113], "directori": [60, 63, 66, 73, 77, 82, 86, 88], "disabl": [2, 8, 93], "disable_data_api": 9, "disast": 103, "disclaim": 118, "discuss": [0, 118], "displai": [0, 52, 118], "distribut": 118, "do": 118, "doc": 119, "document": [0, 115, 118, 119], "doe": [2, 61, 79, 118, 119], "don": 118, "done": 115, "download": [0, 59, 60], "driver": [2, 119], "dummi": 119, "durat": [99, 103], "e": 22, "each": [1, 92, 95, 98, 102, 115, 118, 119], "eas": 115, "easier": 118, "eb": 103, "editori": 118, "either": [0, 52, 89, 94, 112, 113, 115, 118], "elabor": 118, "elast": 103, "electron": 118, "element": [0, 115], "email": 1, "empti": [22, 88, 99, 103], "enabl": [2, 9, 93, 95, 102, 103], "enable_data_api": 8, "enable_extended_data_typ": 2, "enable_kai": [95, 102], "enclos": 118, "encod": [59, 67, 78, 84, 119], "encoding_error": [2, 119], "encrypt": 103, "end": 118, "endpoint": 89, "engin": [0, 1, 53, 119], "enhanc": 119, "enough": 115, "ensur": 103, "entir": [2, 115], "entiti": 118, "entri": 0, "environ": [0, 2, 53, 119], "equal": 115, "error": [2, 119], "escap": [115, 119], "establish": 115, "etc": [1, 95, 102, 115], "evalu": 119, "even": [92, 98, 118], "event": [118, 119], "exampl": [2, 13, 15, 16, 17, 18, 19, 52, 73, 99, 103, 115, 118], "except": [90, 95, 102, 118], "exclud": 118, "exclus": 118, "execut": [0, 2, 16, 42, 54, 116, 118], "exercis": 118, "exist": [21, 59, 60, 66, 70, 72, 73, 78, 87, 89, 94, 112, 113, 119], "expect": [22, 115], "experiment": 119, "expir": [99, 103, 119], "expires_at": [99, 103], "explicitli": 118, "express": 118, "extend": [2, 30, 34, 39, 48, 50], "extens": 119, "extern": 119, "f01b669ed0b6": 109, "fa9edd92": 109, "failur": 118, "fairli": 115, "fals": [0, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 65, 66, 70, 72, 73, 78, 87, 92, 95, 98, 102], "featur": [103, 119], "februari": 116, "fee": 118, "fetch": [17, 18, 19, 25, 116], "fetchal": [13, 115], "fetchmani": [13, 115], "fetchon": [13, 115], "field": [95, 102, 118, 119], "fifti": 118, "file": [0, 2, 59, 60, 64, 65, 67, 70, 72, 73, 74, 78, 79, 83, 84, 85, 87, 118], "fine": 115, "firefox": 1, "firewall_rang": [94, 99, 103], "first": [67, 84], "fit": 118, "fix": 119, "float": [80, 81], "folder": [60, 65, 66, 69, 71, 73, 74, 79], "follow": [0, 67, 84, 93, 95, 102, 115, 118], "foo": 115, "forc": [92, 98], "form": [0, 2, 118], "format": [2, 15, 16, 74, 115, 118, 119], "frame": 52, "free": 118, "from": [0, 1, 15, 16, 18, 19, 21, 23, 103, 115, 118, 119], "full": [2, 27, 75, 115], "function": [0, 2, 3, 26, 28, 29, 53, 54, 90, 115, 119], "fusion": 119, "gener": [1, 13, 45, 99, 103, 118], "geographi": 119, "get": [0, 2, 55, 116], "get_jwt": [116, 119], "get_opt": 116, "get_secret": 119, "get_token": 119, "get_workspac": [89, 112], "get_workspace_group": [0, 94, 113], "give": [0, 92, 98, 118], "given": [27, 28, 29, 30, 31, 32, 38, 41, 61, 63, 64, 65, 115], "glob": 73, "global": [9, 37], "go": [92, 98], "goodwil": 118, "googl": 1, "govern": 118, "grant": 118, "grossli": 118, "group": [0, 92, 93, 94, 98, 99, 103, 105, 108, 113, 119], "gssapi": 119, "ha": [2, 92, 98, 115, 118, 119], "handler": [2, 119], "harmless": 118, "have": [93, 95, 99, 102, 103, 115, 118], "help": 119, "here": [53, 115], "herebi": 118, "herein": 118, "high": 119, "hold": 118, "host": [2, 90, 115], "hostnam": [2, 115], "hour": [99, 103], "how": 118, "howev": [53, 115, 118], "http": [1, 2, 9, 115, 118, 119], "http_proxy_port": 9, "i": [0, 1, 2, 9, 10, 18, 19, 20, 22, 52, 57, 58, 59, 63, 64, 74, 82, 83, 89, 92, 94, 95, 98, 99, 102, 103, 109, 111, 112, 113, 115, 116, 118, 119], "id": [15, 16, 41, 56, 57, 94, 102, 103, 104, 105, 109, 119], "idea": 115, "ident": 2, "identif": 118, "identifi": 118, "idl": 93, "ignor": 73, "ii": 118, "iii": 118, "impli": 118, "import": [0, 115, 118], "improv": [118, 119], "inabl": 118, "inbound": [99, 103], "incident": 118, "includ": [0, 1, 2, 73, 116, 118, 119], "include_root": 73, "inclus": 118, "incorpor": 118, "incur": 118, "indemn": 118, "indemnifi": 118, "index": 119, "indic": [2, 99, 103, 118], "indirect": 118, "individu": 118, "inf": 2, "inf_as_nul": [2, 119], "infil": [15, 119], "infile_stream": 15, "info": 0, "inform": [0, 27, 47, 48, 49, 57, 62, 118], "infring": 118, "inherit": 53, "instal": 116, "instanc": 3, "instanti": [12, 57, 58, 74, 89, 94, 101, 109, 111, 112, 113], "instead": [1, 3, 12, 57], "institut": 118, "int": [1, 2, 9, 15, 16, 18, 23, 24, 25, 41, 74, 89, 92, 93, 95, 98, 99, 102, 103], "integ": 115, "intention": 118, "interact": [0, 119], "interfac": [116, 118, 119], "interv": [95, 102], "io": 15, "ip": [2, 115], "irrevoc": 118, "issu": [118, 119], "iter": [13, 15, 16, 21, 115, 119], "its": 118, "itself": [0, 73, 115], "januari": [116, 118], "javascript": 119, "job": 119, "json": [2, 41, 119], "jsonwebtoken": 1, "juli": 116, "june": 116, "just": 0, "jwt": [1, 2, 56, 119], "kai": [95, 102], "kei": [0, 2, 15, 16, 52, 54, 55, 56, 101, 103, 115, 119], "kerbero": 119, "keyword": [2, 52, 90, 114, 115], "kind": 118, "km": 103, "kwarg": [3, 52, 53, 54, 90, 114], "languag": 118, "larg": [25, 115], "last": 81, "last_modifi": 74, "last_resumed_at": 89, "launchpad": 109, "law": 118, "lawsuit": 118, "leak": 119, "least": 118, "left": 2, "legal": 118, "len": 18, "length": 119, "liabil": 118, "liabl": 118, "licens": 116, "licensor": 118, "like": [0, 13, 52, 72, 115], "limit": 118, "link": 118, "linux": 119, "list": [1, 2, 15, 16, 17, 18, 19, 21, 52, 65, 73, 74, 89, 94, 99, 100, 103, 107, 108, 115, 118], "lite": 115, "litig": 118, "load": 0, "local": [0, 2, 15, 59, 60, 72, 73, 78, 119], "local_infil": [0, 2, 115], "local_path": [59, 60, 72, 73, 78], "locat": [1, 59, 60, 62, 65, 68, 69, 70, 71, 78, 87], "log": 119, "loss": 118, "lost": [99, 103], "made": [115, 118], "mai": [115, 116, 118], "mail": 118, "make": [66, 118, 119], "malfunct": 118, "manag": [2, 56, 111, 116, 118, 119], "manage_workspac": [0, 101, 116], "managementerror": [92, 98], "managemnt": 119, "map": 115, "march": 116, "mark": 118, "max": [2, 15, 16], "maximum": [95, 102], "me": 2, "mean": 118, "mechan": 118, "media": 118, "medium": 118, "meet": 118, "memori": [2, 24, 115, 119], "merchant": 118, "mere": 118, "meth": 0, "method": [0, 3, 9, 12, 22, 52, 57, 58, 74, 89, 94, 101, 115], "mimetyp": 74, "min": 2, "minimum": 119, "mkdir": 0, "mode": [2, 4, 23, 67, 84, 92, 93, 98], "modif": 118, "modifi": [81, 118], "modul": [0, 1, 119], "more": [2, 21, 22, 54, 118, 119], "mostli": 115, "move": [23, 70, 87], "multi_stat": [2, 119], "multipl": [2, 13, 16, 22], "multipli": [93, 95, 102], "must": [22, 115, 118], "my_db": 2, "myprocedur": 13, "mysoldb": 22, "mysql": [2, 115], "mytabl": [15, 16], "name": [1, 2, 13, 28, 29, 30, 31, 32, 54, 55, 57, 73, 74, 77, 89, 94, 95, 99, 102, 103, 109, 114, 118, 119], "namedlist": [100, 108], "namedtupl": [2, 115, 119], "nan": 2, "nan_as_nul": [2, 119], "ndarrai": [17, 18, 19, 21], "necessarili": 118, "need": 119, "neglig": 118, "nest": 73, "new": [0, 7, 67, 70, 84, 87, 95, 102, 103, 116], "new_path": [70, 87], "next": 22, "nextset": 13, "non": [2, 118, 119], "none": [1, 2, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 24, 25, 45, 52, 53, 54, 56, 59, 60, 67, 68, 69, 71, 73, 74, 78, 84, 85, 86, 87, 88, 89, 92, 93, 94, 95, 98, 99, 101, 102, 103, 114], "normal": 118, "notat": [93, 95, 102], "note": 1, "notebook": [116, 119], "noth": 118, "notic": 118, "notwithstand": 118, "novemb": 116, "now": 119, "np": [17, 18, 19, 21], "null": 2, "number": [1, 9, 15, 16, 22, 92, 95, 98, 102, 115], "numer": 119, "numpi": [2, 119], "o": 2, "object": [0, 3, 7, 12, 52, 57, 58, 61, 63, 64, 72, 74, 75, 76, 77, 82, 83, 89, 90, 91, 94, 96, 109, 110, 111, 112, 113, 116, 118, 119], "oblig": 118, "obtain": 118, "octob": 116, "off": [2, 115], "offer": 118, "old_path": 70, "onc": [22, 115], "one": [1, 54, 67, 84, 93, 95, 102, 115, 118], "ones": 0, "onli": [73, 103, 118], "open": 72, "oper": [0, 74], "optim": 45, "option": [0, 1, 2, 9, 13, 15, 16, 53, 54, 55, 56, 59, 60, 65, 66, 67, 70, 72, 73, 78, 84, 87, 90, 92, 93, 95, 98, 99, 101, 102, 103, 114, 115, 119], "order": 53, "org": 118, "organ": [0, 56, 116], "organization_id": [56, 101], "origin": [70, 118], "other": [13, 22, 56, 101, 115, 118], "otherwis": 118, "out": [0, 1, 18, 118], "outfil": 45, "outlin": 119, "output": 0, "outstand": 118, "over": 115, "overal": 2, "overwrit": [59, 60, 66, 70, 72, 73, 78, 87], "overwritten": [59, 60, 66, 70, 72, 73, 78, 87], "own": 118, "owner": 118, "ownership": 118, "p455w0rd": 2, "pa": [17, 18, 19, 21], "packag": [0, 115, 119], "packet": 119, "page": 118, "pair": 114, "panda": [2, 119], "param": 13, "paramet": [0, 1, 2, 3, 9, 13, 15, 16, 23, 24, 52, 53, 54, 55, 56, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 78, 84, 87, 90, 92, 93, 95, 98, 99, 101, 102, 103, 104, 105, 114, 116, 119], "paramt": [15, 16], "pars": 119, "part": 118, "parti": 118, "particular": 118, "pass": 115, "password": [2, 99, 103, 115, 119], "patent": 118, "path": [2, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 78, 84, 87], "pathlik": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 78, 87], "pattern": [73, 115], "pd": [17, 18, 19, 21], "pend": [6, 11], "per": 115, "percent": 118, "perform": [118, 119], "permiss": 118, "perpetu": 118, "persist": [93, 95, 102], "pertain": 118, "pip": 117, "pipelin": 30, "pl": [17, 18, 19, 21], "place": 118, "plan_id": 41, "plugin": 119, "point": [0, 119], "polar": [2, 119], "poll": [95, 102], "port": [2, 9, 90, 115], "portal": [0, 1, 109, 119], "posit": [23, 119], "possibl": [0, 115, 118], "power": 118, "pre": 119, "predefin": 24, "prefer": 118, "prepar": 118, "previou": 0, "primari": [0, 103], "primarili": [0, 52], "print": [13, 17, 18, 19, 54, 115, 118], "privileg": 9, "procedur": [13, 22], "product": [118, 119], "program": 2, "program_nam": 2, "program_vers": 2, "promin": 118, "propag": 119, "properti": [97, 100, 106, 108], "protocol": 2, "provid": [57, 95, 102, 118], "proxi": [0, 9], "publicli": 118, "pure": [2, 119], "pure_python": 2, "purg": 119, "purpos": 118, "put": 115, "pyc": 73, "pyformat": [15, 16], "pygeo": 119, "pymysql": [22, 119], "pytest": 119, "python": [1, 2, 53, 115, 117, 119], "queri": [0, 2, 12, 13, 15, 16, 42, 45, 116, 119], "queue": [15, 119], "quot": 115, "r": [67, 84], "rais": [21, 92, 95, 98, 102], "rang": [99, 103], "rather": 3, "rawiobas": 15, "rb": [67, 84], "reach": [92, 98], "read": [67, 84, 119], "readabl": 118, "reason": 118, "receiv": 118, "recipi": 118, "recommend": 118, "recoveri": 103, "recurs": [65, 69, 73, 86], "redistribut": 118, "refactor": 119, "refer": 116, "regard": 118, "region": [94, 103, 116, 119], "rel": 23, "releas": 119, "remain": [17, 18, 19, 118], "renam": [0, 2, 119], "replac": [115, 118], "replic": 103, "repres": 118, "reproduc": 118, "reproduct": 118, "request": [1, 99, 103], "requir": [9, 115, 118, 119], "respect": 115, "respons": [99, 103, 118], "result": [0, 2, 13, 17, 18, 19, 21, 22, 23, 52, 57, 59, 74, 78, 89, 94, 109, 112, 113, 116, 118, 119], "results_format": [2, 119], "results_typ": [2, 115, 119], "resum": 119, "resume_attach": 89, "retain": [22, 118], "retriev": [0, 1, 13, 56, 104, 105, 115, 119], "retur": [99, 103], "return": [0, 1, 2, 7, 9, 10, 15, 16, 17, 18, 19, 21, 22, 53, 55, 56, 58, 59, 61, 62, 63, 64, 65, 66, 67, 75, 76, 77, 78, 80, 81, 84, 90, 92, 95, 98, 100, 102, 103, 104, 105, 106, 107, 108, 111, 115, 119], "revis": 118, "right": 118, "risk": 118, "root": 73, "routin": 119, "row": [15, 16, 17, 18, 19, 21, 115], "royalti": 118, "rt": [67, 84], "rule": 119, "run": [9, 44], "s2": [0, 2, 115], "s2db": 109, "safari": 1, "same": [53, 115, 118], "scaling_progress": 89, "schedul": 93, "scheme": 2, "screen": 0, "sdk": 0, "seamless": 103, "second": [1, 2, 92, 95, 98, 102], "secondari": 103, "secret": [0, 116, 119], "section": [115, 118], "see": [0, 3, 118], "seen": 115, "select": [0, 15, 16], "sell": 118, "send": 52, "sent": 118, "separ": [118, 119], "septemb": 116, "sequenc": [13, 15, 16, 24], "server": [0, 2, 9, 34, 37, 46, 47, 48, 90, 92, 98, 115, 119], "servic": [0, 118, 119], "session": [2, 47], "set": [0, 2, 4, 9, 13, 16, 17, 19, 21, 22, 23, 25, 53, 95, 102, 114, 115, 119], "set_opt": 116, "shall": 118, "shape": 119, "share": 118, "should": [0, 2, 9, 12, 59, 60, 66, 70, 72, 73, 78, 87, 92, 101, 103, 118], "show": [0, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 115, 119], "shown": [0, 115], "showresult": [26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51], "sign": 1, "simpl": 52, "singl": [1, 2, 19, 115], "singlestor": [0, 1, 95, 102, 116, 118], "singlestoredb": [0, 115, 117, 119], "singlestoredb_password": 2, "singlestoredb_url": [2, 119], "singlestoredb_us": 2, "singleton": 0, "sinlgestoredb": 0, "size": [18, 24, 25, 74, 89, 93, 95, 102, 115], "skip": 22, "small": 115, "smaller": 115, "smart": 103, "smart_dr": 103, "smartdr": 103, "so": 0, "softwar": 118, "sole": 118, "solut": 103, "sourc": [118, 119], "special": 118, "specif": 118, "specifi": [0, 1, 2, 9, 18, 67, 84, 93, 95, 99, 102, 103, 116, 119], "sql": [15, 16, 119], "sqlalchemi": [0, 53, 115, 119], "ssl": 2, "ssl_ca": 2, "ssl_cert": 2, "ssl_cipher": [2, 119], "ssl_disabl": 2, "ssl_kei": 2, "ssl_verify_cert": [2, 119], "ssl_verify_ident": [2, 119], "sso": 1, "stage": [74, 78, 82, 83, 84, 85, 86, 87, 88, 116, 119], "stage_path": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73], "stageobject": [62, 66, 70, 72, 73, 116], "stageobjectbytesread": [67, 84], "stageobjectbyteswrit": [67, 84], "stageobjecttextread": [67, 84], "stageobjecttextwrit": [67, 84], "standard": 2, "start": [9, 116], "state": [89, 91, 96, 118], "statement": [2, 15, 16, 42, 118, 119], "statu": [33, 37, 47, 49, 52], "still": [10, 20], "stopiter": 21, "stoppag": 118, "store": [0, 13, 103], "str": [1, 2, 13, 15, 16, 17, 18, 19, 21, 23, 25, 27, 28, 29, 30, 31, 32, 38, 45, 54, 55, 56, 57, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 84, 87, 89, 93, 94, 95, 99, 101, 102, 103, 104, 105, 114], "strain": 115, "stream": 15, "string": [0, 2, 54, 67, 84, 115, 119], "stringio": [67, 84], "structsequ": 119, "structur": 115, "style": [15, 16], "sub": 0, "subject": 118, "sublicens": 118, "submiss": 118, "submit": [12, 118], "subsequ": [13, 118], "substit": 115, "substitut": [2, 15, 16, 116], "supersed": 118, "suppli": [90, 99, 103], "support": [67, 84, 103, 118, 119], "suspend": [93, 95, 102, 119], "syntax": [0, 52, 118, 119], "system": 118, "t": [67, 84, 118], "tabl": [17, 18, 19, 21, 27, 31, 38, 49], "taken": 53, "target": [59, 60, 73, 78], "telemetri": 2, "term": 118, "termin": [52, 99, 103, 118], "terminated_at": [89, 94], "test": 119, "text": [67, 84, 118], "textio": 72, "textiobas": 15, "than": [3, 22], "thei": [0, 60, 115], "them": 3, "theori": 118, "thereof": 118, "thi": [0, 1, 2, 3, 9, 12, 22, 52, 53, 54, 57, 58, 74, 89, 90, 94, 95, 101, 102, 103, 109, 111, 112, 113, 115, 118, 119], "third": 118, "those": 118, "thread": 44, "three": 115, "through": [0, 3, 118], "time": [1, 99, 103], "timeout": [1, 2, 92, 98, 119], "timestamp": [80, 81, 99, 103], "titl": 118, "token": [1, 56, 101], "tool": 116, "top": 73, "tort": 118, "total": [92, 98], "track": [0, 2, 118, 119], "track_env": [2, 119], "trade": 118, "trademark": 118, "traffic": [99, 103], "transact": [6, 11], "transfer": 118, "transform": 118, "transit": 115, "translat": 118, "treat": [2, 52], "tree": 73, "tri": 1, "troubleshoot": 45, "true": [0, 2, 4, 18, 19, 22, 73, 95, 102, 115, 119], "truncat": [67, 84], "tupl": [2, 17, 18, 19, 21, 114], "two": 115, "type": [1, 2, 7, 9, 10, 15, 16, 18, 19, 21, 53, 55, 56, 61, 62, 63, 64, 65, 66, 67, 74, 78, 84, 90, 93, 95, 102, 103, 104, 105, 116, 118, 119], "typic": [2, 3], "udf": 119, "unbuff": 119, "under": 118, "underli": 52, "union": 118, "unix": [80, 81], "unless": [2, 118], "until": [1, 22], "up": [92, 98], "updat": [91, 96, 103, 119], "update_window": [99, 103], "upload": [2, 72, 73, 119], "upload_fil": 0, "upload_fold": 0, "url": [0, 1, 2, 56, 101, 116, 119], "us": [0, 1, 2, 9, 12, 13, 15, 16, 18, 21, 22, 52, 56, 57, 59, 67, 73, 74, 78, 84, 89, 94, 101, 109, 112, 113, 116, 117, 118, 119], "usag": 2, "user": [1, 2, 115], "usernam": 2, "utf8": 2, "util": 116, "v0": [115, 116], "v1": 116, "valu": [0, 1, 2, 4, 9, 17, 18, 19, 21, 23, 52, 55, 93, 95, 102, 114, 115], "variabl": [0, 2, 9, 53, 115, 119], "variable_nam": 115, "variou": [0, 74, 119], "vector": [2, 119], "vector_data_format": [2, 119], "verbal": 118, "verifi": 2, "version": [56, 101, 118, 119], "view": 32, "volum": 103, "w": [67, 84], "wa": [1, 118], "wai": 115, "wait": [1, 92, 95, 98, 102], "wait_interv": [92, 95, 98, 102], "wait_on_act": [95, 102], "wait_on_termin": [92, 98], "wait_timeout": [92, 95, 98, 102], "warranti": 118, "wb": [67, 84], "we": 118, "web": [0, 52], "webbrows": 1, "well": 115, "what": 116, "when": [2, 15, 16, 22, 99, 103, 115], "where": [0, 15, 16, 23, 52, 103, 115, 118], "wherev": 118, "whether": [95, 102, 118], "which": [0, 2, 90, 115, 118], "while": [18, 19, 118, 119], "whole": 118, "whom": 118, "window": [99, 103, 119], "within": [0, 2, 93, 118], "without": [0, 53, 118], "work": [1, 115, 118], "workspac": [56, 113, 116, 119], "workspace_group": [0, 58, 89, 94, 102, 116], "workspace_id": 89, "workspacegroup": [58, 74, 89, 102, 103, 105, 108, 111, 116], "workspacemanag": [56, 57, 58, 89, 94, 109, 112, 113, 116], "worldwid": 118, "wrapper": 110, "writabl": 74, "write": [1, 67, 84, 118], "written": 118, "wt": [67, 84], "www": 118, "x": [67, 84], "xb": [67, 84], "xt": [67, 84], "you": [0, 2, 115, 118], "your": [0, 115, 118]}, "titles": ["API Reference", "singlestoredb.auth.get_jwt", "singlestoredb.connect", "singlestoredb.connection.Connection", "singlestoredb.connection.Connection.autocommit", "singlestoredb.connection.Connection.close", "singlestoredb.connection.Connection.commit", "singlestoredb.connection.Connection.cursor", "singlestoredb.connection.Connection.disable_data_api", "singlestoredb.connection.Connection.enable_data_api", "singlestoredb.connection.Connection.is_connected", "singlestoredb.connection.Connection.rollback", "singlestoredb.connection.Cursor", "singlestoredb.connection.Cursor.callproc", "singlestoredb.connection.Cursor.close", "singlestoredb.connection.Cursor.execute", "singlestoredb.connection.Cursor.executemany", "singlestoredb.connection.Cursor.fetchall", "singlestoredb.connection.Cursor.fetchmany", "singlestoredb.connection.Cursor.fetchone", "singlestoredb.connection.Cursor.is_connected", "singlestoredb.connection.Cursor.next", "singlestoredb.connection.Cursor.nextset", "singlestoredb.connection.Cursor.scroll", "singlestoredb.connection.Cursor.setinputsizes", "singlestoredb.connection.Cursor.setoutputsize", "singlestoredb.connection.ShowAccessor.aggregates", "singlestoredb.connection.ShowAccessor.columns", "singlestoredb.connection.ShowAccessor.create_aggregate", "singlestoredb.connection.ShowAccessor.create_function", "singlestoredb.connection.ShowAccessor.create_pipeline", "singlestoredb.connection.ShowAccessor.create_table", "singlestoredb.connection.ShowAccessor.create_view", "singlestoredb.connection.ShowAccessor.database_status", "singlestoredb.connection.ShowAccessor.databases", "singlestoredb.connection.ShowAccessor.errors", "singlestoredb.connection.ShowAccessor.functions", "singlestoredb.connection.ShowAccessor.global_status", "singlestoredb.connection.ShowAccessor.indexes", "singlestoredb.connection.ShowAccessor.partitions", "singlestoredb.connection.ShowAccessor.pipelines", "singlestoredb.connection.ShowAccessor.plan", "singlestoredb.connection.ShowAccessor.plancache", "singlestoredb.connection.ShowAccessor.procedures", "singlestoredb.connection.ShowAccessor.processlist", "singlestoredb.connection.ShowAccessor.reproduction", "singlestoredb.connection.ShowAccessor.schemas", "singlestoredb.connection.ShowAccessor.session_status", "singlestoredb.connection.ShowAccessor.status", "singlestoredb.connection.ShowAccessor.table_status", "singlestoredb.connection.ShowAccessor.tables", "singlestoredb.connection.ShowAccessor.warnings", "singlestoredb.connection.ShowResult", "singlestoredb.create_engine", "singlestoredb.describe_option", "singlestoredb.get_option", "singlestoredb.manage_workspaces", "singlestoredb.management.region.Region", "singlestoredb.management.workspace.Stage", "singlestoredb.management.workspace.Stage.download_file", "singlestoredb.management.workspace.Stage.download_folder", "singlestoredb.management.workspace.Stage.exists", "singlestoredb.management.workspace.Stage.info", "singlestoredb.management.workspace.Stage.is_dir", "singlestoredb.management.workspace.Stage.is_file", "singlestoredb.management.workspace.Stage.listdir", "singlestoredb.management.workspace.Stage.mkdir", "singlestoredb.management.workspace.Stage.open", "singlestoredb.management.workspace.Stage.remove", "singlestoredb.management.workspace.Stage.removedirs", "singlestoredb.management.workspace.Stage.rename", "singlestoredb.management.workspace.Stage.rmdir", "singlestoredb.management.workspace.Stage.upload_file", "singlestoredb.management.workspace.Stage.upload_folder", "singlestoredb.management.workspace.StageObject", "singlestoredb.management.workspace.StageObject.abspath", "singlestoredb.management.workspace.StageObject.basename", "singlestoredb.management.workspace.StageObject.dirname", "singlestoredb.management.workspace.StageObject.download", "singlestoredb.management.workspace.StageObject.exists", "singlestoredb.management.workspace.StageObject.getctime", "singlestoredb.management.workspace.StageObject.getmtime", "singlestoredb.management.workspace.StageObject.is_dir", "singlestoredb.management.workspace.StageObject.is_file", "singlestoredb.management.workspace.StageObject.open", "singlestoredb.management.workspace.StageObject.remove", "singlestoredb.management.workspace.StageObject.removedirs", "singlestoredb.management.workspace.StageObject.rename", "singlestoredb.management.workspace.StageObject.rmdir", "singlestoredb.management.workspace.Workspace", "singlestoredb.management.workspace.Workspace.connect", "singlestoredb.management.workspace.Workspace.refresh", "singlestoredb.management.workspace.Workspace.terminate", "singlestoredb.management.workspace.Workspace.update", "singlestoredb.management.workspace.WorkspaceGroup", "singlestoredb.management.workspace.WorkspaceGroup.create_workspace", "singlestoredb.management.workspace.WorkspaceGroup.refresh", "singlestoredb.management.workspace.WorkspaceGroup.stage", "singlestoredb.management.workspace.WorkspaceGroup.terminate", "singlestoredb.management.workspace.WorkspaceGroup.update", "singlestoredb.management.workspace.WorkspaceGroup.workspaces", "singlestoredb.management.workspace.WorkspaceManager", "singlestoredb.management.workspace.WorkspaceManager.create_workspace", "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", "singlestoredb.management.workspace.WorkspaceManager.get_workspace", "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", "singlestoredb.management.workspace.WorkspaceManager.organization", "singlestoredb.management.workspace.WorkspaceManager.regions", "singlestoredb.management.workspace.WorkspaceManager.workspace_groups", "singlestoredb.notebook.organization", "singlestoredb.notebook.secrets", "singlestoredb.notebook.stage", "singlestoredb.notebook.workspace", "singlestoredb.notebook.workspace_group", "singlestoredb.set_option", "Getting Started", "SingleStoreDB Python SDK", "Installation", "License", "What\u2019s New"], "titleterms": {"": 119, "0": 119, "1": 119, "10": 119, "12": 119, "13": 119, "14": 119, "15": 119, "16": 119, "17": 119, "18": 119, "19": 119, "2": 119, "20": 119, "2022": 119, "2023": 119, "2024": 119, "21": 119, "23": 119, "24": 119, "25": 119, "26": 119, "28": 119, "29": 119, "3": 119, "31": 119, "4": 119, "5": 119, "6": 119, "7": 119, "8": 119, "9": 119, "abspath": 75, "addit": 115, "aggreg": 26, "api": [0, 115, 119], "april": 119, "august": 119, "auth": 1, "autocommit": 4, "basenam": 76, "callproc": 13, "chang": 119, "close": [5, 14], "column": 27, "commit": 6, "configur": 0, "connect": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 90, 115], "content": 116, "create_aggreg": 28, "create_engin": 53, "create_funct": 29, "create_pipelin": 30, "create_t": 31, "create_view": 32, "create_workspac": [95, 102], "create_workspace_group": 103, "cursor": [0, 7, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "databas": 34, "database_statu": 33, "db": 115, "decemb": 119, "default": 115, "describe_opt": 54, "dictionari": 115, "dirnam": 77, "disable_data_api": 8, "download": 78, "download_fil": 59, "download_fold": 60, "enable_data_api": 9, "error": 35, "execut": [15, 115], "executemani": 16, "exist": [61, 79], "februari": 119, "fetch": 115, "fetchal": 17, "fetchmani": 18, "fetchon": 19, "function": 36, "get": 115, "get_jwt": 1, "get_opt": 55, "get_workspac": 104, "get_workspace_group": 105, "getctim": 80, "getmtim": 81, "global_statu": 37, "index": 38, "info": 62, "instal": 117, "is_connect": [10, 20], "is_dir": [63, 82], "is_fil": [64, 83], "januari": 119, "juli": 119, "june": 119, "licens": 118, "listdir": 65, "mai": 119, "manag": [0, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108], "manage_workspac": 56, "march": 119, "mkdir": 66, "name": 115, "new": 119, "next": 21, "nextset": 22, "notebook": [0, 109, 110, 111, 112, 113], "novemb": 119, "octob": 119, "open": [67, 84], "organ": [106, 109], "paraemet": 70, "paramet": 115, "partit": 39, "pipelin": 40, "plan": 41, "plancach": 42, "posit": 115, "procedur": 43, "processlist": 44, "python": 116, "queri": 115, "refer": 0, "refresh": [91, 96], "region": [0, 57, 107], "remov": [68, 85], "removedir": [69, 86], "renam": [70, 87], "reproduct": 45, "result": 115, "rmdir": [71, 88], "rollback": 11, "schema": 46, "scroll": 23, "sdk": 116, "secret": 110, "septemb": 119, "session_statu": 47, "set_opt": 114, "setinputs": 24, "setoutputs": 25, "showaccessor": [26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51], "showresult": [0, 52], "singlestoredb": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 116], "specifi": 115, "stage": [0, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 97, 111], "stageobject": [0, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88], "start": 115, "statu": 48, "substitut": 115, "tabl": 50, "table_statu": 49, "termin": [92, 98], "tool": 0, "tupl": 115, "type": 115, "updat": [93, 99], "upload_fil": 72, "upload_fold": 73, "url": 115, "us": 115, "util": 0, "v0": 119, "v1": 119, "warn": 51, "what": 119, "workspac": [0, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 112], "workspace_group": [108, 113], "workspacegroup": [0, 94, 95, 96, 97, 98, 99, 100], "workspacemanag": [0, 101, 102, 103, 104, 105, 106, 107, 108]}}) +Search.setIndex({"alltitles": {"API Reference": [[0, null]], "Configuration": [[0, "configuration"]], "Connect using DB-API Parameters": [[115, "connect-using-db-api-parameters"]], "Connect using a URL": [[115, "connect-using-a-url"]], "Connection": [[0, "connection"]], "Connections": [[0, "connections"]], "Contents:": [[116, null]], "Cursor": [[0, "cursor"]], "Dictionaries": [[115, "dictionaries"]], "Executing Queries": [[115, "executing-queries"]], "Fetching Results": [[115, "fetching-results"]], "Getting Started": [[115, null]], "Installation": [[117, null]], "License": [[118, null]], "Management API": [[0, "management-api"]], "Named Substitution": [[115, "named-substitution"]], "Named Tuples": [[115, "named-tuples"]], "Notebook Tools": [[0, "notebook-tools"]], "Paraemeters": [[70, "paraemeters"]], "Parameter Substitution": [[115, "parameter-substitution"]], "Positional Substitution": [[115, "positional-substitution"]], "Region": [[0, "region"]], "Result Type": [[115, "result-type"]], "ShowResult": [[0, "showresult"]], "SingleStoreDB Python SDK": [[116, null]], "Specifying Additional Connection Parameters": [[115, "specifying-additional-connection-parameters"]], "Stage": [[0, "stage"]], "StageObject": [[0, "stageobject"]], "Tuples (Default)": [[115, "tuples-default"]], "Utilities": [[0, "utilities"]], "What\u2019s New": [[119, null]], "Workspace": [[0, "workspace"]], "WorkspaceGroup": [[0, "workspacegroup"]], "WorkspaceManager": [[0, "workspacemanager"]], "singlestoredb.auth.get_jwt": [[1, null]], "singlestoredb.connect": [[2, null]], "singlestoredb.connection.Connection": [[3, null]], "singlestoredb.connection.Connection.autocommit": [[4, null]], "singlestoredb.connection.Connection.close": [[5, null]], "singlestoredb.connection.Connection.commit": [[6, null]], "singlestoredb.connection.Connection.cursor": [[7, null]], "singlestoredb.connection.Connection.disable_data_api": [[8, null]], "singlestoredb.connection.Connection.enable_data_api": [[9, null]], "singlestoredb.connection.Connection.is_connected": [[10, null]], "singlestoredb.connection.Connection.rollback": [[11, null]], "singlestoredb.connection.Cursor": [[12, null]], "singlestoredb.connection.Cursor.callproc": [[13, null]], "singlestoredb.connection.Cursor.close": [[14, null]], "singlestoredb.connection.Cursor.execute": [[15, null]], "singlestoredb.connection.Cursor.executemany": [[16, null]], "singlestoredb.connection.Cursor.fetchall": [[17, null]], "singlestoredb.connection.Cursor.fetchmany": [[18, null]], "singlestoredb.connection.Cursor.fetchone": [[19, null]], "singlestoredb.connection.Cursor.is_connected": [[20, null]], "singlestoredb.connection.Cursor.next": [[21, null]], "singlestoredb.connection.Cursor.nextset": [[22, null]], "singlestoredb.connection.Cursor.scroll": [[23, null]], "singlestoredb.connection.Cursor.setinputsizes": [[24, null]], "singlestoredb.connection.Cursor.setoutputsize": [[25, null]], "singlestoredb.connection.ShowAccessor.aggregates": [[26, null]], "singlestoredb.connection.ShowAccessor.columns": [[27, null]], "singlestoredb.connection.ShowAccessor.create_aggregate": [[28, null]], "singlestoredb.connection.ShowAccessor.create_function": [[29, null]], "singlestoredb.connection.ShowAccessor.create_pipeline": [[30, null]], "singlestoredb.connection.ShowAccessor.create_table": [[31, null]], "singlestoredb.connection.ShowAccessor.create_view": [[32, null]], "singlestoredb.connection.ShowAccessor.database_status": [[33, null]], "singlestoredb.connection.ShowAccessor.databases": [[34, null]], "singlestoredb.connection.ShowAccessor.errors": [[35, null]], "singlestoredb.connection.ShowAccessor.functions": [[36, null]], "singlestoredb.connection.ShowAccessor.global_status": [[37, null]], "singlestoredb.connection.ShowAccessor.indexes": [[38, null]], "singlestoredb.connection.ShowAccessor.partitions": [[39, null]], "singlestoredb.connection.ShowAccessor.pipelines": [[40, null]], "singlestoredb.connection.ShowAccessor.plan": [[41, null]], "singlestoredb.connection.ShowAccessor.plancache": [[42, null]], "singlestoredb.connection.ShowAccessor.procedures": [[43, null]], "singlestoredb.connection.ShowAccessor.processlist": [[44, null]], "singlestoredb.connection.ShowAccessor.reproduction": [[45, null]], "singlestoredb.connection.ShowAccessor.schemas": [[46, null]], "singlestoredb.connection.ShowAccessor.session_status": [[47, null]], "singlestoredb.connection.ShowAccessor.status": [[48, null]], "singlestoredb.connection.ShowAccessor.table_status": [[49, null]], "singlestoredb.connection.ShowAccessor.tables": [[50, null]], "singlestoredb.connection.ShowAccessor.warnings": [[51, null]], "singlestoredb.connection.ShowResult": [[52, null]], "singlestoredb.create_engine": [[53, null]], "singlestoredb.describe_option": [[54, null]], "singlestoredb.get_option": [[55, null]], "singlestoredb.manage_workspaces": [[56, null]], "singlestoredb.management.region.Region": [[57, null]], "singlestoredb.management.workspace.Stage": [[58, null]], "singlestoredb.management.workspace.Stage.download_file": [[59, null]], "singlestoredb.management.workspace.Stage.download_folder": [[60, null]], "singlestoredb.management.workspace.Stage.exists": [[61, null]], "singlestoredb.management.workspace.Stage.info": [[62, null]], "singlestoredb.management.workspace.Stage.is_dir": [[63, null]], "singlestoredb.management.workspace.Stage.is_file": [[64, null]], "singlestoredb.management.workspace.Stage.listdir": [[65, null]], "singlestoredb.management.workspace.Stage.mkdir": [[66, null]], "singlestoredb.management.workspace.Stage.open": [[67, null]], "singlestoredb.management.workspace.Stage.remove": [[68, null]], "singlestoredb.management.workspace.Stage.removedirs": [[69, null]], "singlestoredb.management.workspace.Stage.rename": [[70, null]], "singlestoredb.management.workspace.Stage.rmdir": [[71, null]], "singlestoredb.management.workspace.Stage.upload_file": [[72, null]], "singlestoredb.management.workspace.Stage.upload_folder": [[73, null]], "singlestoredb.management.workspace.StageObject": [[74, null]], "singlestoredb.management.workspace.StageObject.abspath": [[75, null]], "singlestoredb.management.workspace.StageObject.basename": [[76, null]], "singlestoredb.management.workspace.StageObject.dirname": [[77, null]], "singlestoredb.management.workspace.StageObject.download": [[78, null]], "singlestoredb.management.workspace.StageObject.exists": [[79, null]], "singlestoredb.management.workspace.StageObject.getctime": [[80, null]], "singlestoredb.management.workspace.StageObject.getmtime": [[81, null]], "singlestoredb.management.workspace.StageObject.is_dir": [[82, null]], "singlestoredb.management.workspace.StageObject.is_file": [[83, null]], "singlestoredb.management.workspace.StageObject.open": [[84, null]], "singlestoredb.management.workspace.StageObject.remove": [[85, null]], "singlestoredb.management.workspace.StageObject.removedirs": [[86, null]], "singlestoredb.management.workspace.StageObject.rename": [[87, null]], "singlestoredb.management.workspace.StageObject.rmdir": [[88, null]], "singlestoredb.management.workspace.Workspace": [[89, null]], "singlestoredb.management.workspace.Workspace.connect": [[90, null]], "singlestoredb.management.workspace.Workspace.refresh": [[91, null]], "singlestoredb.management.workspace.Workspace.terminate": [[92, null]], "singlestoredb.management.workspace.Workspace.update": [[93, null]], "singlestoredb.management.workspace.WorkspaceGroup": [[94, null]], "singlestoredb.management.workspace.WorkspaceGroup.create_workspace": [[95, null]], "singlestoredb.management.workspace.WorkspaceGroup.refresh": [[96, null]], "singlestoredb.management.workspace.WorkspaceGroup.stage": [[97, null]], "singlestoredb.management.workspace.WorkspaceGroup.terminate": [[98, null]], "singlestoredb.management.workspace.WorkspaceGroup.update": [[99, null]], "singlestoredb.management.workspace.WorkspaceGroup.workspaces": [[100, null]], "singlestoredb.management.workspace.WorkspaceManager": [[101, null]], "singlestoredb.management.workspace.WorkspaceManager.create_workspace": [[102, null]], "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group": [[103, null]], "singlestoredb.management.workspace.WorkspaceManager.get_workspace": [[104, null]], "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group": [[105, null]], "singlestoredb.management.workspace.WorkspaceManager.organization": [[106, null]], "singlestoredb.management.workspace.WorkspaceManager.regions": [[107, null]], "singlestoredb.management.workspace.WorkspaceManager.workspace_groups": [[108, null]], "singlestoredb.notebook.organization": [[109, null]], "singlestoredb.notebook.secrets": [[110, null]], "singlestoredb.notebook.stage": [[111, null]], "singlestoredb.notebook.workspace": [[112, null]], "singlestoredb.notebook.workspace_group": [[113, null]], "singlestoredb.set_option": [[114, null]], "v0.1.0 - May 6, 2022": [[119, "v0-1-0-may-6-2022"]], "v0.10.0 - December 12, 2023": [[119, "v0-10-0-december-12-2023"]], "v0.10.1 - December 13, 2023": [[119, "v0-10-1-december-13-2023"]], "v0.10.2 - December 14, 2023": [[119, "v0-10-2-december-14-2023"]], "v0.10.3 - January 17, 2024": [[119, "v0-10-3-january-17-2024"]], "v0.10.4 - January 18, 2024": [[119, "v0-10-4-january-18-2024"]], "v0.10.5 - January 23, 2024": [[119, "v0-10-5-january-23-2024"]], "v0.10.6 - January 26, 2024": [[119, "v0-10-6-january-26-2024"]], "v0.10.7 - January 31, 2024": [[119, "v0-10-7-january-31-2024"]], "v0.2.0 - August 5, 2022": [[119, "v0-2-0-august-5-2022"]], "v0.3.0 - September 9, 2022": [[119, "v0-3-0-september-9-2022"]], "v0.3.1 - September 9, 2022": [[119, "v0-3-1-september-9-2022"]], "v0.3.2 - September 14, 2022": [[119, "v0-3-2-september-14-2022"]], "v0.3.3 - September 21, 2022": [[119, "v0-3-3-september-21-2022"]], "v0.4.0 - October 19, 2022": [[119, "v0-4-0-october-19-2022"]], "v0.5.0 - December 8, 2022 (API CHANGES)": [[119, "v0-5-0-december-8-2022-api-changes"]], "v0.5.1 - December 9, 2022": [[119, "v0-5-1-december-9-2022"]], "v0.5.2 - December 14, 2022": [[119, "v0-5-2-december-14-2022"]], "v0.5.3 - January 9, 2023": [[119, "v0-5-3-january-9-2023"]], "v0.5.4 - March 15, 2023": [[119, "v0-5-4-march-15-2023"]], "v0.6.0 - May 17, 2023": [[119, "v0-6-0-may-17-2023"]], "v0.6.1 - May 18, 2023": [[119, "v0-6-1-may-18-2023"]], "v0.7.0 - June 9, 2023": [[119, "v0-7-0-june-9-2023"]], "v0.7.1 - June 15, 2023": [[119, "v0-7-1-june-15-2023"]], "v0.8.0 - July 12, 2023": [[119, "v0-8-0-july-12-2023"]], "v0.8.1 - July 12, 2023": [[119, "v0-8-1-july-12-2023"]], "v0.8.2 - August 10, 2023": [[119, "v0-8-2-august-10-2023"]], "v0.8.3 - August 23, 2023": [[119, "v0-8-3-august-23-2023"]], "v0.8.4 - August 28, 2023": [[119, "v0-8-4-august-28-2023"]], "v0.8.5 - August 29, 2023": [[119, "v0-8-5-august-29-2023"]], "v0.8.6 - August 29, 2023": [[119, "v0-8-6-august-29-2023"]], "v0.8.7 - September 19, 2023": [[119, "v0-8-7-september-19-2023"]], "v0.8.8 - September 26, 2023": [[119, "v0-8-8-september-26-2023"]], "v0.8.9 - October 4, 2023": [[119, "v0-8-9-october-4-2023"]], "v0.9.0 - October 16, 2023": [[119, "v0-9-0-october-16-2023"]], "v0.9.1 - October 17, 2023": [[119, "v0-9-1-october-17-2023"]], "v0.9.2 - October 24, 2023": [[119, "v0-9-2-october-24-2023"]], "v0.9.3 - October 25, 2023": [[119, "v0-9-3-october-25-2023"]], "v0.9.4 - October 31, 2023": [[119, "v0-9-4-october-31-2023"]], "v0.9.5 - October 31, 2023": [[119, "v0-9-5-october-31-2023"]], "v0.9.6 - November 2, 2023": [[119, "v0-9-6-november-2-2023"]], "v1.0.0 - February, 12 2024": [[119, "v1-0-0-february-12-2024"]], "v1.0.1 - February, 16 2024": [[119, "v1-0-1-february-16-2024"]], "v1.0.2 - March, 8 2024": [[119, "v1-0-2-march-8-2024"]], "v1.0.3 - April, 2 2024": [[119, "v1-0-3-april-2-2024"]], "v1.0.4 - April, 3 2024": [[119, "v1-0-4-april-3-2024"]], "v1.1.0 - April, 18 2024": [[119, "v1-1-0-april-18-2024"]], "v1.2.0 - April 25, 2024": [[119, "v1-2-0-april-25-2024"]], "v1.3.0 - May 10, 2024": [[119, "v1-3-0-may-10-2024"]], "v1.3.1 - May 23, 2024": [[119, "v1-3-1-may-23-2024"]], "v1.4.0 - June 13, 2024": [[119, "v1-4-0-june-13-2024"]], "v1.4.1 - July 2, 2024": [[119, "v1-4-1-july-2-2024"]], "v1.4.2 - July 9, 2024": [[119, "v1-4-2-july-9-2024"]], "v1.4.3 - July 10, 2024": [[119, "v1-4-3-july-10-2024"]], "v1.5.0 - July 12, 2024": [[119, "v1-5-0-july-12-2024"]], "v1.6.0 - July 29, 2024": [[119, "v1-6-0-july-29-2024"]], "v1.6.1 - July 31, 2024": [[119, "v1-6-1-july-31-2024"]], "v1.6.2 - August 6, 2024": [[119, "v1-6-2-august-6-2024"]], "v1.6.3 - September 5, 2024": [[119, "v1-6-3-september-5-2024"]], "v1.7.0 - September 20, 2024": [[119, "v1-7-0-september-20-2024"]], "v1.7.1 - September 20, 2024": [[119, "v1-7-1-september-20-2024"]], "v1.7.2 - October 16, 2024": [[119, "v1-7-2-october-16-2024"]]}, "docnames": ["api", "generated/singlestoredb.auth.get_jwt", "generated/singlestoredb.connect", "generated/singlestoredb.connection.Connection", "generated/singlestoredb.connection.Connection.autocommit", "generated/singlestoredb.connection.Connection.close", "generated/singlestoredb.connection.Connection.commit", "generated/singlestoredb.connection.Connection.cursor", "generated/singlestoredb.connection.Connection.disable_data_api", "generated/singlestoredb.connection.Connection.enable_data_api", "generated/singlestoredb.connection.Connection.is_connected", "generated/singlestoredb.connection.Connection.rollback", "generated/singlestoredb.connection.Cursor", "generated/singlestoredb.connection.Cursor.callproc", "generated/singlestoredb.connection.Cursor.close", "generated/singlestoredb.connection.Cursor.execute", "generated/singlestoredb.connection.Cursor.executemany", "generated/singlestoredb.connection.Cursor.fetchall", "generated/singlestoredb.connection.Cursor.fetchmany", "generated/singlestoredb.connection.Cursor.fetchone", "generated/singlestoredb.connection.Cursor.is_connected", "generated/singlestoredb.connection.Cursor.next", "generated/singlestoredb.connection.Cursor.nextset", "generated/singlestoredb.connection.Cursor.scroll", "generated/singlestoredb.connection.Cursor.setinputsizes", "generated/singlestoredb.connection.Cursor.setoutputsize", "generated/singlestoredb.connection.ShowAccessor.aggregates", "generated/singlestoredb.connection.ShowAccessor.columns", "generated/singlestoredb.connection.ShowAccessor.create_aggregate", "generated/singlestoredb.connection.ShowAccessor.create_function", "generated/singlestoredb.connection.ShowAccessor.create_pipeline", "generated/singlestoredb.connection.ShowAccessor.create_table", "generated/singlestoredb.connection.ShowAccessor.create_view", "generated/singlestoredb.connection.ShowAccessor.database_status", "generated/singlestoredb.connection.ShowAccessor.databases", "generated/singlestoredb.connection.ShowAccessor.errors", "generated/singlestoredb.connection.ShowAccessor.functions", "generated/singlestoredb.connection.ShowAccessor.global_status", "generated/singlestoredb.connection.ShowAccessor.indexes", "generated/singlestoredb.connection.ShowAccessor.partitions", "generated/singlestoredb.connection.ShowAccessor.pipelines", "generated/singlestoredb.connection.ShowAccessor.plan", "generated/singlestoredb.connection.ShowAccessor.plancache", "generated/singlestoredb.connection.ShowAccessor.procedures", "generated/singlestoredb.connection.ShowAccessor.processlist", "generated/singlestoredb.connection.ShowAccessor.reproduction", "generated/singlestoredb.connection.ShowAccessor.schemas", "generated/singlestoredb.connection.ShowAccessor.session_status", "generated/singlestoredb.connection.ShowAccessor.status", "generated/singlestoredb.connection.ShowAccessor.table_status", "generated/singlestoredb.connection.ShowAccessor.tables", "generated/singlestoredb.connection.ShowAccessor.warnings", "generated/singlestoredb.connection.ShowResult", "generated/singlestoredb.create_engine", "generated/singlestoredb.describe_option", "generated/singlestoredb.get_option", "generated/singlestoredb.manage_workspaces", "generated/singlestoredb.management.region.Region", "generated/singlestoredb.management.workspace.Stage", "generated/singlestoredb.management.workspace.Stage.download_file", "generated/singlestoredb.management.workspace.Stage.download_folder", "generated/singlestoredb.management.workspace.Stage.exists", "generated/singlestoredb.management.workspace.Stage.info", "generated/singlestoredb.management.workspace.Stage.is_dir", "generated/singlestoredb.management.workspace.Stage.is_file", "generated/singlestoredb.management.workspace.Stage.listdir", "generated/singlestoredb.management.workspace.Stage.mkdir", "generated/singlestoredb.management.workspace.Stage.open", "generated/singlestoredb.management.workspace.Stage.remove", "generated/singlestoredb.management.workspace.Stage.removedirs", "generated/singlestoredb.management.workspace.Stage.rename", "generated/singlestoredb.management.workspace.Stage.rmdir", "generated/singlestoredb.management.workspace.Stage.upload_file", "generated/singlestoredb.management.workspace.Stage.upload_folder", "generated/singlestoredb.management.workspace.StageObject", "generated/singlestoredb.management.workspace.StageObject.abspath", "generated/singlestoredb.management.workspace.StageObject.basename", "generated/singlestoredb.management.workspace.StageObject.dirname", "generated/singlestoredb.management.workspace.StageObject.download", "generated/singlestoredb.management.workspace.StageObject.exists", "generated/singlestoredb.management.workspace.StageObject.getctime", "generated/singlestoredb.management.workspace.StageObject.getmtime", "generated/singlestoredb.management.workspace.StageObject.is_dir", "generated/singlestoredb.management.workspace.StageObject.is_file", "generated/singlestoredb.management.workspace.StageObject.open", "generated/singlestoredb.management.workspace.StageObject.remove", "generated/singlestoredb.management.workspace.StageObject.removedirs", "generated/singlestoredb.management.workspace.StageObject.rename", "generated/singlestoredb.management.workspace.StageObject.rmdir", "generated/singlestoredb.management.workspace.Workspace", "generated/singlestoredb.management.workspace.Workspace.connect", "generated/singlestoredb.management.workspace.Workspace.refresh", "generated/singlestoredb.management.workspace.Workspace.terminate", "generated/singlestoredb.management.workspace.Workspace.update", "generated/singlestoredb.management.workspace.WorkspaceGroup", "generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace", "generated/singlestoredb.management.workspace.WorkspaceGroup.refresh", "generated/singlestoredb.management.workspace.WorkspaceGroup.stage", "generated/singlestoredb.management.workspace.WorkspaceGroup.terminate", "generated/singlestoredb.management.workspace.WorkspaceGroup.update", "generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces", "generated/singlestoredb.management.workspace.WorkspaceManager", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", "generated/singlestoredb.management.workspace.WorkspaceManager.organization", "generated/singlestoredb.management.workspace.WorkspaceManager.regions", "generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups", "generated/singlestoredb.notebook.organization", "generated/singlestoredb.notebook.secrets", "generated/singlestoredb.notebook.stage", "generated/singlestoredb.notebook.workspace", "generated/singlestoredb.notebook.workspace_group", "generated/singlestoredb.set_option", "getting-started", "index", "install", "license", "whatsnew"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1}, "filenames": ["api.rst", "generated/singlestoredb.auth.get_jwt.rst", "generated/singlestoredb.connect.rst", "generated/singlestoredb.connection.Connection.rst", "generated/singlestoredb.connection.Connection.autocommit.rst", "generated/singlestoredb.connection.Connection.close.rst", "generated/singlestoredb.connection.Connection.commit.rst", "generated/singlestoredb.connection.Connection.cursor.rst", "generated/singlestoredb.connection.Connection.disable_data_api.rst", "generated/singlestoredb.connection.Connection.enable_data_api.rst", "generated/singlestoredb.connection.Connection.is_connected.rst", "generated/singlestoredb.connection.Connection.rollback.rst", "generated/singlestoredb.connection.Cursor.rst", "generated/singlestoredb.connection.Cursor.callproc.rst", "generated/singlestoredb.connection.Cursor.close.rst", "generated/singlestoredb.connection.Cursor.execute.rst", "generated/singlestoredb.connection.Cursor.executemany.rst", "generated/singlestoredb.connection.Cursor.fetchall.rst", "generated/singlestoredb.connection.Cursor.fetchmany.rst", "generated/singlestoredb.connection.Cursor.fetchone.rst", "generated/singlestoredb.connection.Cursor.is_connected.rst", "generated/singlestoredb.connection.Cursor.next.rst", "generated/singlestoredb.connection.Cursor.nextset.rst", "generated/singlestoredb.connection.Cursor.scroll.rst", "generated/singlestoredb.connection.Cursor.setinputsizes.rst", "generated/singlestoredb.connection.Cursor.setoutputsize.rst", "generated/singlestoredb.connection.ShowAccessor.aggregates.rst", "generated/singlestoredb.connection.ShowAccessor.columns.rst", "generated/singlestoredb.connection.ShowAccessor.create_aggregate.rst", "generated/singlestoredb.connection.ShowAccessor.create_function.rst", "generated/singlestoredb.connection.ShowAccessor.create_pipeline.rst", "generated/singlestoredb.connection.ShowAccessor.create_table.rst", "generated/singlestoredb.connection.ShowAccessor.create_view.rst", "generated/singlestoredb.connection.ShowAccessor.database_status.rst", "generated/singlestoredb.connection.ShowAccessor.databases.rst", "generated/singlestoredb.connection.ShowAccessor.errors.rst", "generated/singlestoredb.connection.ShowAccessor.functions.rst", "generated/singlestoredb.connection.ShowAccessor.global_status.rst", "generated/singlestoredb.connection.ShowAccessor.indexes.rst", "generated/singlestoredb.connection.ShowAccessor.partitions.rst", "generated/singlestoredb.connection.ShowAccessor.pipelines.rst", "generated/singlestoredb.connection.ShowAccessor.plan.rst", "generated/singlestoredb.connection.ShowAccessor.plancache.rst", "generated/singlestoredb.connection.ShowAccessor.procedures.rst", "generated/singlestoredb.connection.ShowAccessor.processlist.rst", "generated/singlestoredb.connection.ShowAccessor.reproduction.rst", "generated/singlestoredb.connection.ShowAccessor.schemas.rst", "generated/singlestoredb.connection.ShowAccessor.session_status.rst", "generated/singlestoredb.connection.ShowAccessor.status.rst", "generated/singlestoredb.connection.ShowAccessor.table_status.rst", "generated/singlestoredb.connection.ShowAccessor.tables.rst", "generated/singlestoredb.connection.ShowAccessor.warnings.rst", "generated/singlestoredb.connection.ShowResult.rst", "generated/singlestoredb.create_engine.rst", "generated/singlestoredb.describe_option.rst", "generated/singlestoredb.get_option.rst", "generated/singlestoredb.manage_workspaces.rst", "generated/singlestoredb.management.region.Region.rst", "generated/singlestoredb.management.workspace.Stage.rst", "generated/singlestoredb.management.workspace.Stage.download_file.rst", "generated/singlestoredb.management.workspace.Stage.download_folder.rst", "generated/singlestoredb.management.workspace.Stage.exists.rst", "generated/singlestoredb.management.workspace.Stage.info.rst", "generated/singlestoredb.management.workspace.Stage.is_dir.rst", "generated/singlestoredb.management.workspace.Stage.is_file.rst", "generated/singlestoredb.management.workspace.Stage.listdir.rst", "generated/singlestoredb.management.workspace.Stage.mkdir.rst", "generated/singlestoredb.management.workspace.Stage.open.rst", "generated/singlestoredb.management.workspace.Stage.remove.rst", "generated/singlestoredb.management.workspace.Stage.removedirs.rst", "generated/singlestoredb.management.workspace.Stage.rename.rst", "generated/singlestoredb.management.workspace.Stage.rmdir.rst", "generated/singlestoredb.management.workspace.Stage.upload_file.rst", "generated/singlestoredb.management.workspace.Stage.upload_folder.rst", "generated/singlestoredb.management.workspace.StageObject.rst", "generated/singlestoredb.management.workspace.StageObject.abspath.rst", "generated/singlestoredb.management.workspace.StageObject.basename.rst", "generated/singlestoredb.management.workspace.StageObject.dirname.rst", "generated/singlestoredb.management.workspace.StageObject.download.rst", "generated/singlestoredb.management.workspace.StageObject.exists.rst", "generated/singlestoredb.management.workspace.StageObject.getctime.rst", "generated/singlestoredb.management.workspace.StageObject.getmtime.rst", "generated/singlestoredb.management.workspace.StageObject.is_dir.rst", "generated/singlestoredb.management.workspace.StageObject.is_file.rst", "generated/singlestoredb.management.workspace.StageObject.open.rst", "generated/singlestoredb.management.workspace.StageObject.remove.rst", "generated/singlestoredb.management.workspace.StageObject.removedirs.rst", "generated/singlestoredb.management.workspace.StageObject.rename.rst", "generated/singlestoredb.management.workspace.StageObject.rmdir.rst", "generated/singlestoredb.management.workspace.Workspace.rst", "generated/singlestoredb.management.workspace.Workspace.connect.rst", "generated/singlestoredb.management.workspace.Workspace.refresh.rst", "generated/singlestoredb.management.workspace.Workspace.terminate.rst", "generated/singlestoredb.management.workspace.Workspace.update.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.stage.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.update.rst", "generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.organization.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.regions.rst", "generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.rst", "generated/singlestoredb.notebook.organization.rst", "generated/singlestoredb.notebook.secrets.rst", "generated/singlestoredb.notebook.stage.rst", "generated/singlestoredb.notebook.workspace.rst", "generated/singlestoredb.notebook.workspace_group.rst", "generated/singlestoredb.set_option.rst", "getting-started.rst", "index.rst", "install.rst", "license.rst", "whatsnew.rst"], "indexentries": {"__init__() (singlestoredb.connection.connection method)": [[3, "singlestoredb.connection.Connection.__init__", false]], "__init__() (singlestoredb.connection.cursor method)": [[12, "singlestoredb.connection.Cursor.__init__", false]], "__init__() (singlestoredb.connection.showresult method)": [[52, "singlestoredb.connection.ShowResult.__init__", false]], "__init__() (singlestoredb.management.region.region method)": [[57, "singlestoredb.management.region.Region.__init__", false]], "__init__() (singlestoredb.management.workspace.stage method)": [[58, "singlestoredb.management.workspace.Stage.__init__", false]], "__init__() (singlestoredb.management.workspace.stageobject method)": [[74, "singlestoredb.management.workspace.StageObject.__init__", false]], "__init__() (singlestoredb.management.workspace.workspace method)": [[89, "singlestoredb.management.workspace.Workspace.__init__", false]], "__init__() (singlestoredb.management.workspace.workspacegroup method)": [[94, "singlestoredb.management.workspace.WorkspaceGroup.__init__", false]], "__init__() (singlestoredb.management.workspace.workspacemanager method)": [[101, "singlestoredb.management.workspace.WorkspaceManager.__init__", false]], "abspath() (singlestoredb.management.workspace.stageobject method)": [[75, "singlestoredb.management.workspace.StageObject.abspath", false]], "aggregates() (singlestoredb.connection.showaccessor method)": [[26, "singlestoredb.connection.ShowAccessor.aggregates", false]], "autocommit() (singlestoredb.connection.connection method)": [[4, "singlestoredb.connection.Connection.autocommit", false]], "basename() (singlestoredb.management.workspace.stageobject method)": [[76, "singlestoredb.management.workspace.StageObject.basename", false]], "callproc() (singlestoredb.connection.cursor method)": [[13, "singlestoredb.connection.Cursor.callproc", false]], "close() (singlestoredb.connection.connection method)": [[5, "singlestoredb.connection.Connection.close", false]], "close() (singlestoredb.connection.cursor method)": [[14, "singlestoredb.connection.Cursor.close", false]], "columns() (singlestoredb.connection.showaccessor method)": [[27, "singlestoredb.connection.ShowAccessor.columns", false]], "commit() (singlestoredb.connection.connection method)": [[6, "singlestoredb.connection.Connection.commit", false]], "connect() (in module singlestoredb)": [[2, "singlestoredb.connect", false]], "connect() (singlestoredb.management.workspace.workspace method)": [[90, "singlestoredb.management.workspace.Workspace.connect", false]], "connection (class in singlestoredb.connection)": [[3, "singlestoredb.connection.Connection", false]], "create_aggregate() (singlestoredb.connection.showaccessor method)": [[28, "singlestoredb.connection.ShowAccessor.create_aggregate", false]], "create_engine() (in module singlestoredb)": [[53, "singlestoredb.create_engine", false]], "create_function() (singlestoredb.connection.showaccessor method)": [[29, "singlestoredb.connection.ShowAccessor.create_function", false]], "create_pipeline() (singlestoredb.connection.showaccessor method)": [[30, "singlestoredb.connection.ShowAccessor.create_pipeline", false]], "create_table() (singlestoredb.connection.showaccessor method)": [[31, "singlestoredb.connection.ShowAccessor.create_table", false]], "create_view() (singlestoredb.connection.showaccessor method)": [[32, "singlestoredb.connection.ShowAccessor.create_view", false]], "create_workspace() (singlestoredb.management.workspace.workspacegroup method)": [[95, "singlestoredb.management.workspace.WorkspaceGroup.create_workspace", false]], "create_workspace() (singlestoredb.management.workspace.workspacemanager method)": [[102, "singlestoredb.management.workspace.WorkspaceManager.create_workspace", false]], "create_workspace_group() (singlestoredb.management.workspace.workspacemanager method)": [[103, "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", false]], "cursor (class in singlestoredb.connection)": [[12, "singlestoredb.connection.Cursor", false]], "cursor() (singlestoredb.connection.connection method)": [[7, "singlestoredb.connection.Connection.cursor", false]], "database_status() (singlestoredb.connection.showaccessor method)": [[33, "singlestoredb.connection.ShowAccessor.database_status", false]], "databases() (singlestoredb.connection.showaccessor method)": [[34, "singlestoredb.connection.ShowAccessor.databases", false]], "describe_option() (in module singlestoredb)": [[54, "singlestoredb.describe_option", false]], "dirname() (singlestoredb.management.workspace.stageobject method)": [[77, "singlestoredb.management.workspace.StageObject.dirname", false]], "disable_data_api() (singlestoredb.connection.connection method)": [[8, "singlestoredb.connection.Connection.disable_data_api", false]], "download() (singlestoredb.management.workspace.stageobject method)": [[78, "singlestoredb.management.workspace.StageObject.download", false]], "download_file() (singlestoredb.management.workspace.stage method)": [[59, "singlestoredb.management.workspace.Stage.download_file", false]], "download_folder() (singlestoredb.management.workspace.stage method)": [[60, "singlestoredb.management.workspace.Stage.download_folder", false]], "enable_data_api() (singlestoredb.connection.connection method)": [[9, "singlestoredb.connection.Connection.enable_data_api", false]], "errors() (singlestoredb.connection.showaccessor method)": [[35, "singlestoredb.connection.ShowAccessor.errors", false]], "execute() (singlestoredb.connection.cursor method)": [[15, "singlestoredb.connection.Cursor.execute", false]], "executemany() (singlestoredb.connection.cursor method)": [[16, "singlestoredb.connection.Cursor.executemany", false]], "exists() (singlestoredb.management.workspace.stage method)": [[61, "singlestoredb.management.workspace.Stage.exists", false]], "exists() (singlestoredb.management.workspace.stageobject method)": [[79, "singlestoredb.management.workspace.StageObject.exists", false]], "fetchall() (singlestoredb.connection.cursor method)": [[17, "singlestoredb.connection.Cursor.fetchall", false]], "fetchmany() (singlestoredb.connection.cursor method)": [[18, "singlestoredb.connection.Cursor.fetchmany", false]], "fetchone() (singlestoredb.connection.cursor method)": [[19, "singlestoredb.connection.Cursor.fetchone", false]], "functions() (singlestoredb.connection.showaccessor method)": [[36, "singlestoredb.connection.ShowAccessor.functions", false]], "get_jwt() (in module singlestoredb.auth)": [[1, "singlestoredb.auth.get_jwt", false]], "get_option() (in module singlestoredb)": [[55, "singlestoredb.get_option", false]], "get_workspace() (singlestoredb.management.workspace.workspacemanager method)": [[104, "singlestoredb.management.workspace.WorkspaceManager.get_workspace", false]], "get_workspace_group() (singlestoredb.management.workspace.workspacemanager method)": [[105, "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", false]], "getctime() (singlestoredb.management.workspace.stageobject method)": [[80, "singlestoredb.management.workspace.StageObject.getctime", false]], "getmtime() (singlestoredb.management.workspace.stageobject method)": [[81, "singlestoredb.management.workspace.StageObject.getmtime", false]], "global_status() (singlestoredb.connection.showaccessor method)": [[37, "singlestoredb.connection.ShowAccessor.global_status", false]], "indexes() (singlestoredb.connection.showaccessor method)": [[38, "singlestoredb.connection.ShowAccessor.indexes", false]], "info() (singlestoredb.management.workspace.stage method)": [[62, "singlestoredb.management.workspace.Stage.info", false]], "is_connected() (singlestoredb.connection.connection method)": [[10, "singlestoredb.connection.Connection.is_connected", false]], "is_connected() (singlestoredb.connection.cursor method)": [[20, "singlestoredb.connection.Cursor.is_connected", false]], "is_dir() (singlestoredb.management.workspace.stage method)": [[63, "singlestoredb.management.workspace.Stage.is_dir", false]], "is_dir() (singlestoredb.management.workspace.stageobject method)": [[82, "singlestoredb.management.workspace.StageObject.is_dir", false]], "is_file() (singlestoredb.management.workspace.stage method)": [[64, "singlestoredb.management.workspace.Stage.is_file", false]], "is_file() (singlestoredb.management.workspace.stageobject method)": [[83, "singlestoredb.management.workspace.StageObject.is_file", false]], "listdir() (singlestoredb.management.workspace.stage method)": [[65, "singlestoredb.management.workspace.Stage.listdir", false]], "manage_workspaces() (in module singlestoredb)": [[56, "singlestoredb.manage_workspaces", false]], "mkdir() (singlestoredb.management.workspace.stage method)": [[66, "singlestoredb.management.workspace.Stage.mkdir", false]], "module": [[0, "module-singlestoredb", false]], "next() (singlestoredb.connection.cursor method)": [[21, "singlestoredb.connection.Cursor.next", false]], "nextset() (singlestoredb.connection.cursor method)": [[22, "singlestoredb.connection.Cursor.nextset", false]], "open() (singlestoredb.management.workspace.stage method)": [[67, "singlestoredb.management.workspace.Stage.open", false]], "open() (singlestoredb.management.workspace.stageobject method)": [[84, "singlestoredb.management.workspace.StageObject.open", false]], "organization (in module singlestoredb.notebook)": [[109, "singlestoredb.notebook.organization", false]], "organization (singlestoredb.management.workspace.workspacemanager property)": [[106, "singlestoredb.management.workspace.WorkspaceManager.organization", false]], "partitions() (singlestoredb.connection.showaccessor method)": [[39, "singlestoredb.connection.ShowAccessor.partitions", false]], "pipelines() (singlestoredb.connection.showaccessor method)": [[40, "singlestoredb.connection.ShowAccessor.pipelines", false]], "plan() (singlestoredb.connection.showaccessor method)": [[41, "singlestoredb.connection.ShowAccessor.plan", false]], "plancache() (singlestoredb.connection.showaccessor method)": [[42, "singlestoredb.connection.ShowAccessor.plancache", false]], "procedures() (singlestoredb.connection.showaccessor method)": [[43, "singlestoredb.connection.ShowAccessor.procedures", false]], "processlist() (singlestoredb.connection.showaccessor method)": [[44, "singlestoredb.connection.ShowAccessor.processlist", false]], "refresh() (singlestoredb.management.workspace.workspace method)": [[91, "singlestoredb.management.workspace.Workspace.refresh", false]], "refresh() (singlestoredb.management.workspace.workspacegroup method)": [[96, "singlestoredb.management.workspace.WorkspaceGroup.refresh", false]], "region (class in singlestoredb.management.region)": [[57, "singlestoredb.management.region.Region", false]], "regions() (singlestoredb.management.workspace.workspacemanager method)": [[107, "singlestoredb.management.workspace.WorkspaceManager.regions", false]], "remove() (singlestoredb.management.workspace.stage method)": [[68, "singlestoredb.management.workspace.Stage.remove", false]], "remove() (singlestoredb.management.workspace.stageobject method)": [[85, "singlestoredb.management.workspace.StageObject.remove", false]], "removedirs() (singlestoredb.management.workspace.stage method)": [[69, "singlestoredb.management.workspace.Stage.removedirs", false]], "removedirs() (singlestoredb.management.workspace.stageobject method)": [[86, "singlestoredb.management.workspace.StageObject.removedirs", false]], "rename() (singlestoredb.management.workspace.stage method)": [[70, "singlestoredb.management.workspace.Stage.rename", false]], "rename() (singlestoredb.management.workspace.stageobject method)": [[87, "singlestoredb.management.workspace.StageObject.rename", false]], "reproduction() (singlestoredb.connection.showaccessor method)": [[45, "singlestoredb.connection.ShowAccessor.reproduction", false]], "rmdir() (singlestoredb.management.workspace.stage method)": [[71, "singlestoredb.management.workspace.Stage.rmdir", false]], "rmdir() (singlestoredb.management.workspace.stageobject method)": [[88, "singlestoredb.management.workspace.StageObject.rmdir", false]], "rollback() (singlestoredb.connection.connection method)": [[11, "singlestoredb.connection.Connection.rollback", false]], "schemas() (singlestoredb.connection.showaccessor method)": [[46, "singlestoredb.connection.ShowAccessor.schemas", false]], "scroll() (singlestoredb.connection.cursor method)": [[23, "singlestoredb.connection.Cursor.scroll", false]], "secrets (in module singlestoredb.notebook)": [[110, "singlestoredb.notebook.secrets", false]], "session_status() (singlestoredb.connection.showaccessor method)": [[47, "singlestoredb.connection.ShowAccessor.session_status", false]], "set_option() (in module singlestoredb)": [[114, "singlestoredb.set_option", false]], "setinputsizes() (singlestoredb.connection.cursor method)": [[24, "singlestoredb.connection.Cursor.setinputsizes", false]], "setoutputsize() (singlestoredb.connection.cursor method)": [[25, "singlestoredb.connection.Cursor.setoutputsize", false]], "showresult (class in singlestoredb.connection)": [[52, "singlestoredb.connection.ShowResult", false]], "singlestoredb": [[0, "module-singlestoredb", false]], "stage (class in singlestoredb.management.workspace)": [[58, "singlestoredb.management.workspace.Stage", false]], "stage (in module singlestoredb.notebook)": [[111, "singlestoredb.notebook.stage", false]], "stage (singlestoredb.management.workspace.workspacegroup property)": [[97, "singlestoredb.management.workspace.WorkspaceGroup.stage", false]], "stageobject (class in singlestoredb.management.workspace)": [[74, "singlestoredb.management.workspace.StageObject", false]], "status() (singlestoredb.connection.showaccessor method)": [[48, "singlestoredb.connection.ShowAccessor.status", false]], "table_status() (singlestoredb.connection.showaccessor method)": [[49, "singlestoredb.connection.ShowAccessor.table_status", false]], "tables() (singlestoredb.connection.showaccessor method)": [[50, "singlestoredb.connection.ShowAccessor.tables", false]], "terminate() (singlestoredb.management.workspace.workspace method)": [[92, "singlestoredb.management.workspace.Workspace.terminate", false]], "terminate() (singlestoredb.management.workspace.workspacegroup method)": [[98, "singlestoredb.management.workspace.WorkspaceGroup.terminate", false]], "update() (singlestoredb.management.workspace.workspace method)": [[93, "singlestoredb.management.workspace.Workspace.update", false]], "update() (singlestoredb.management.workspace.workspacegroup method)": [[99, "singlestoredb.management.workspace.WorkspaceGroup.update", false]], "upload_file() (singlestoredb.management.workspace.stage method)": [[72, "singlestoredb.management.workspace.Stage.upload_file", false]], "upload_folder() (singlestoredb.management.workspace.stage method)": [[73, "singlestoredb.management.workspace.Stage.upload_folder", false]], "warnings() (singlestoredb.connection.showaccessor method)": [[51, "singlestoredb.connection.ShowAccessor.warnings", false]], "workspace (class in singlestoredb.management.workspace)": [[89, "singlestoredb.management.workspace.Workspace", false]], "workspace (in module singlestoredb.notebook)": [[112, "singlestoredb.notebook.workspace", false]], "workspace_group (in module singlestoredb.notebook)": [[113, "singlestoredb.notebook.workspace_group", false]], "workspace_groups (singlestoredb.management.workspace.workspacemanager property)": [[108, "singlestoredb.management.workspace.WorkspaceManager.workspace_groups", false]], "workspacegroup (class in singlestoredb.management.workspace)": [[94, "singlestoredb.management.workspace.WorkspaceGroup", false]], "workspacemanager (class in singlestoredb.management.workspace)": [[101, "singlestoredb.management.workspace.WorkspaceManager", false]], "workspaces (singlestoredb.management.workspace.workspacegroup property)": [[100, "singlestoredb.management.workspace.WorkspaceGroup.workspaces", false]]}, "objects": {"": [[0, 0, 0, "-", "singlestoredb"]], "singlestoredb": [[2, 1, 1, "", "connect"], [53, 1, 1, "", "create_engine"], [54, 1, 1, "", "describe_option"], [55, 1, 1, "", "get_option"], [56, 1, 1, "", "manage_workspaces"], [114, 1, 1, "", "set_option"]], "singlestoredb.auth": [[1, 1, 1, "", "get_jwt"]], "singlestoredb.connection": [[3, 2, 1, "", "Connection"], [12, 2, 1, "", "Cursor"], [52, 2, 1, "", "ShowResult"]], "singlestoredb.connection.Connection": [[3, 3, 1, "", "__init__"], [4, 3, 1, "", "autocommit"], [5, 3, 1, "", "close"], [6, 3, 1, "", "commit"], [7, 3, 1, "", "cursor"], [8, 3, 1, "", "disable_data_api"], [9, 3, 1, "", "enable_data_api"], [10, 3, 1, "", "is_connected"], [11, 3, 1, "", "rollback"]], "singlestoredb.connection.Cursor": [[12, 3, 1, "", "__init__"], [13, 3, 1, "", "callproc"], [14, 3, 1, "", "close"], [15, 3, 1, "", "execute"], [16, 3, 1, "", "executemany"], [17, 3, 1, "", "fetchall"], [18, 3, 1, "", "fetchmany"], [19, 3, 1, "", "fetchone"], [20, 3, 1, "", "is_connected"], [21, 3, 1, "", "next"], [22, 3, 1, "", "nextset"], [23, 3, 1, "", "scroll"], [24, 3, 1, "", "setinputsizes"], [25, 3, 1, "", "setoutputsize"]], "singlestoredb.connection.ShowAccessor": [[26, 3, 1, "", "aggregates"], [27, 3, 1, "", "columns"], [28, 3, 1, "", "create_aggregate"], [29, 3, 1, "", "create_function"], [30, 3, 1, "", "create_pipeline"], [31, 3, 1, "", "create_table"], [32, 3, 1, "", "create_view"], [33, 3, 1, "", "database_status"], [34, 3, 1, "", "databases"], [35, 3, 1, "", "errors"], [36, 3, 1, "", "functions"], [37, 3, 1, "", "global_status"], [38, 3, 1, "", "indexes"], [39, 3, 1, "", "partitions"], [40, 3, 1, "", "pipelines"], [41, 3, 1, "", "plan"], [42, 3, 1, "", "plancache"], [43, 3, 1, "", "procedures"], [44, 3, 1, "", "processlist"], [45, 3, 1, "", "reproduction"], [46, 3, 1, "", "schemas"], [47, 3, 1, "", "session_status"], [48, 3, 1, "", "status"], [49, 3, 1, "", "table_status"], [50, 3, 1, "", "tables"], [51, 3, 1, "", "warnings"]], "singlestoredb.connection.ShowResult": [[52, 3, 1, "", "__init__"]], "singlestoredb.management.region": [[57, 2, 1, "", "Region"]], "singlestoredb.management.region.Region": [[57, 3, 1, "", "__init__"]], "singlestoredb.management.workspace": [[58, 2, 1, "", "Stage"], [74, 2, 1, "", "StageObject"], [89, 2, 1, "", "Workspace"], [94, 2, 1, "", "WorkspaceGroup"], [101, 2, 1, "", "WorkspaceManager"]], "singlestoredb.management.workspace.Stage": [[58, 3, 1, "", "__init__"], [59, 3, 1, "", "download_file"], [60, 3, 1, "", "download_folder"], [61, 3, 1, "", "exists"], [62, 3, 1, "", "info"], [63, 3, 1, "", "is_dir"], [64, 3, 1, "", "is_file"], [65, 3, 1, "", "listdir"], [66, 3, 1, "", "mkdir"], [67, 3, 1, "", "open"], [68, 3, 1, "", "remove"], [69, 3, 1, "", "removedirs"], [70, 3, 1, "", "rename"], [71, 3, 1, "", "rmdir"], [72, 3, 1, "", "upload_file"], [73, 3, 1, "", "upload_folder"]], "singlestoredb.management.workspace.StageObject": [[74, 3, 1, "", "__init__"], [75, 3, 1, "", "abspath"], [76, 3, 1, "", "basename"], [77, 3, 1, "", "dirname"], [78, 3, 1, "", "download"], [79, 3, 1, "", "exists"], [80, 3, 1, "", "getctime"], [81, 3, 1, "", "getmtime"], [82, 3, 1, "", "is_dir"], [83, 3, 1, "", "is_file"], [84, 3, 1, "", "open"], [85, 3, 1, "", "remove"], [86, 3, 1, "", "removedirs"], [87, 3, 1, "", "rename"], [88, 3, 1, "", "rmdir"]], "singlestoredb.management.workspace.Workspace": [[89, 3, 1, "", "__init__"], [90, 3, 1, "", "connect"], [91, 3, 1, "", "refresh"], [92, 3, 1, "", "terminate"], [93, 3, 1, "", "update"]], "singlestoredb.management.workspace.WorkspaceGroup": [[94, 3, 1, "", "__init__"], [95, 3, 1, "", "create_workspace"], [96, 3, 1, "", "refresh"], [97, 4, 1, "", "stage"], [98, 3, 1, "", "terminate"], [99, 3, 1, "", "update"], [100, 4, 1, "", "workspaces"]], "singlestoredb.management.workspace.WorkspaceManager": [[101, 3, 1, "", "__init__"], [102, 3, 1, "", "create_workspace"], [103, 3, 1, "", "create_workspace_group"], [104, 3, 1, "", "get_workspace"], [105, 3, 1, "", "get_workspace_group"], [106, 4, 1, "", "organization"], [107, 3, 1, "", "regions"], [108, 4, 1, "", "workspace_groups"]], "singlestoredb.notebook": [[109, 5, 1, "", "organization"], [110, 5, 1, "", "secrets"], [111, 5, 1, "", "stage"], [112, 5, 1, "", "workspace"], [113, 5, 1, "", "workspace_group"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:property", "5": "py:data"}, "terms": {"": [0, 1, 2, 15, 16, 93, 95, 102, 115, 116, 118], "0": [2, 99, 103, 115, 116, 118], "00": [95, 99, 102, 103], "01": [99, 103], "02": [99, 103], "02t15": [99, 103], "04": [99, 103], "05z07": [99, 103], "1": [0, 2, 93, 95, 102, 115, 116, 118], "10": [2, 52, 92, 95, 98, 102, 115, 116], "100": [15, 16, 18], "11": [115, 119], "12": [115, 116], "13": [115, 116], "14": 116, "15": 116, "16": 116, "17": 116, "18": 116, "19": 116, "2": [0, 2, 93, 95, 102, 115, 116, 118], "20": 116, "200": 16, "2004": 118, "2021": [99, 103, 118], "2022": 116, "2023": 116, "2024": 116, "21": 116, "23": [99, 103, 116], "24": 116, "25": 116, "26": 116, "28": 116, "29": 116, "3": [0, 115, 116], "300": 16, "31": 116, "31536000": 2, "32": 119, "3306": 2, "3h30m": [99, 103], "4": [0, 93, 95, 102, 115, 116], "427b": 109, "443": 2, "5": [0, 115, 116], "50": 118, "6": [99, 103, 115, 116], "60": 1, "600": [92, 95, 98, 102, 115], "682e": 109, "7": [115, 116], "8": [115, 116], "80": 2, "8080": 2, "9": [115, 116, 118], "A": [115, 118], "AND": 118, "AS": 118, "As": 115, "At": [99, 103], "By": [2, 115], "FOR": 118, "For": 118, "If": [1, 9, 13, 17, 18, 21, 22, 73, 92, 93, 95, 98, 99, 102, 103, 115, 118], "In": [0, 115, 118], "It": [0, 57, 58, 74, 89, 93, 94, 95, 102, 109, 111, 112, 113, 116], "Not": 118, "OF": 118, "ON": 115, "OR": 118, "The": [0, 1, 2, 9, 12, 13, 15, 16, 22, 53, 55, 56, 67, 84, 87, 93, 99, 101, 102, 103, 114, 115, 116, 117, 118], "These": 0, "To": [0, 2, 54, 73, 118], "WITH": 119, "__init__": [3, 12, 52, 57, 58, 74, 89, 94, 101], "_connector_nam": 2, "_object": [110, 111], "a6cc": 109, "aarch64": 119, "abil": 119, "abl": 115, "about": [0, 44, 62], "abov": [0, 118], "absolut": 23, "abstract": [5, 6, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 22, 23, 24, 25], "accept": 118, "access": [0, 13, 52, 56, 89, 94, 101, 110, 112, 113], "access_token": [56, 101], "accessor": 119, "account": 0, "act": [0, 118], "activ": [95, 98, 102], "ad": [67, 84, 119], "add": [118, 119], "add_endpoint_to_firewall_rang": 119, "addendum": 118, "addit": [0, 2, 116, 118], "additon": 115, "address": [2, 115], "admin": [99, 103], "admin_password": [99, 103], "advis": 118, "affect": [15, 16], "against": [16, 118], "aggreg": 28, "agre": 118, "agreement": 118, "ai": 119, "all": [0, 17, 26, 34, 36, 38, 40, 42, 43, 54, 73, 93, 99, 103, 115, 118, 119], "alleg": 118, "allow": [0, 2, 9, 99, 103], "allow_all_traff": [94, 99, 103], "alon": 118, "along": 118, "alongsid": 118, "alreadi": [66, 70, 72, 73, 87], "also": [0, 2, 52, 115, 116, 118], "amazon": 103, "amount": 115, "an": [0, 2, 22, 53, 55, 59, 60, 72, 78, 95, 99, 102, 103, 114, 115, 118, 119], "ani": [0, 1, 2, 3, 13, 15, 16, 17, 18, 19, 21, 52, 53, 54, 55, 89, 90, 93, 95, 102, 114, 118], "annot": 118, "anoth": 22, "apach": 118, "api": [2, 8, 9, 56, 57, 89, 94, 101, 109, 112, 113, 116], "app": 119, "appear": 118, "appendix": 118, "appli": [93, 118], "applic": [118, 119], "appropri": 118, "april": 116, "ar": [0, 2, 3, 17, 18, 19, 52, 53, 67, 73, 84, 89, 90, 94, 99, 103, 112, 113, 115, 118, 119], "arbitrari": 114, "archiv": 118, "area": 24, "arg": [15, 16, 52, 53, 114], "arg1": 13, "arg2": 13, "argument": [90, 114], "aris": 118, "arrai": 119, "arrays": 18, "arrow": [2, 119], "assert": 118, "associ": [93, 95, 102, 103, 118], "assum": 118, "async": 119, "attach": 118, "attribut": [0, 2, 3, 12, 18, 52, 57, 74, 89, 94, 101, 110, 118], "august": 116, "auth": [2, 116, 119], "authent": [1, 2, 56, 119], "author": [2, 118], "authorship": 118, "auto": [93, 95, 102, 115], "auto_attach": 115, "auto_increment_incr": 115, "auto_increment_offset": 115, "auto_profile_typ": 115, "auto_repl": 115, "auto_suspend": [89, 93, 95, 102], "autocommit": [2, 115, 119], "automat": [0, 2, 115, 119], "autostats_flush_interval_sec": 115, "avail": [0, 22, 100, 107, 108, 118], "aw": 103, "b": [67, 84], "back": 115, "backup": 103, "backup_bucket_kms_key_id": 103, "bar": 115, "base": [56, 101, 118, 119], "base_url": [56, 101], "basi": 118, "batch": 115, "been": [2, 115, 118], "befor": [1, 92, 95, 98, 102, 119], "behalf": 118, "behavior": 2, "being": [1, 115], "below": [0, 2, 115, 118], "benefici": 118, "better": 115, "between": [92, 95, 98, 102], "binari": [2, 67, 84, 119], "binaryio": 72, "bind": 118, "bit": 119, "blob": 119, "block": 103, "boilerpl": 118, "bool": [0, 2, 4, 10, 20, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 61, 63, 64, 65, 66, 70, 72, 73, 74, 78, 79, 82, 83, 87, 92, 94, 95, 98, 99, 102, 103], "boolean": 119, "bracket": 118, "break": [18, 19], "browser": [0, 1, 52], "browser_sso": 2, "bson": 2, "bucket": 103, "buffer": [2, 25], "builtin": 119, "byte": [15, 59, 78], "bytesio": [67, 84], "c": 119, "cach": [93, 95, 102, 119], "cache_config": [89, 93, 95, 102], "calcul": 119, "call": [0, 3, 12, 13, 22, 53, 57, 89, 94, 109, 112, 113, 115, 119], "callabl": 2, "can": [0, 1, 2, 13, 15, 16, 52, 53, 67, 84, 93, 95, 99, 102, 103, 115, 117], "cannot": 118, "carri": 118, "caus": 118, "certif": 2, "chang": [115, 116, 118], "charact": [2, 118], "charg": 118, "charset": 2, "check": [92, 98], "choic": 115, "choos": 118, "chrome": 1, "chromium": 1, "cidr": [99, 103], "cipher": [2, 119], "claim": 118, "class": [3, 12, 52, 57, 58, 74, 89, 94, 101, 118], "client": [115, 117], "client_found_row": [2, 119], "cloud": [0, 109, 116, 119], "cluster": [1, 57, 119], "cmek": 103, "code": [0, 2, 15, 16, 28, 29, 30, 31, 32, 45, 53, 118, 119], "column": [0, 25, 52, 115], "com": [1, 2], "combin": 118, "command": [12, 119], "comment": 118, "commerci": 118, "common": 118, "commun": 118, "compat": [1, 22, 119], "compil": [42, 118], "compli": 118, "complianc": 118, "compliant": [0, 116, 119], "comput": [115, 118], "condit": 118, "configur": [93, 95, 102, 116, 118, 119], "conn": [2, 52, 115], "conn_attr": 2, "connect": [1, 116, 119], "connect_timeout": [2, 119], "connector": [2, 116], "consecut": 114, "consequenti": 118, "consid": 119, "consist": 118, "conspicu": 118, "constitut": 118, "constru": 118, "constructor": 52, "consum": 2, "contain": [2, 118], "content": [59, 73, 74, 78, 118], "context": 2, "continu": 103, "contract": 118, "contribut": 118, "contributor": 118, "contributori": 118, "control": [2, 118], "conv": 2, "convers": [2, 118, 119], "convert": [59, 78, 119], "copi": 118, "copyright": 118, "correspond": 0, "counterclaim": 118, "creat": [0, 3, 7, 53, 66, 67, 74, 84, 89, 90, 94, 95, 102, 103, 112, 113], "create_engin": [0, 116, 119], "create_workspac": [0, 89, 112, 119], "create_workspace_group": [94, 113], "created_at": [89, 94], "creation": [28, 29, 30, 31, 32, 80], "credenti": [2, 115], "credential_typ": 2, "cross": 118, "cur": [2, 13, 15, 16, 17, 18, 19, 115], "current": [0, 9, 26, 33, 36, 37, 39, 40, 43, 44, 49, 50, 91, 96, 106], "cursor": [2, 115, 116], "custom": 103, "customari": 118, "dai": [99, 103], "damag": 118, "dashboard": 119, "data": [2, 8, 9, 15, 45, 52, 59, 67, 78, 84, 99, 103, 115, 119], "data_bucket_kms_key_id": 103, "databas": [0, 1, 2, 5, 10, 12, 26, 33, 36, 39, 40, 43, 49, 50, 90, 115, 116, 119], "datafram": [17, 18, 19, 21], "date": 118, "datetim": [74, 80, 81, 89, 94], "db": [0, 116, 119], "db_name": 2, "dbt": 2, "debug": 119, "decemb": 116, "decod": 2, "default": [0, 1, 2, 67, 84, 119], "defend": 118, "defer": 119, "defin": [0, 2, 115, 118], "definit": [3, 89, 93, 94, 99, 104, 105, 112, 113, 118], "delet": [68, 69, 71, 85, 86, 88], "deliber": 118, "depend": 115, "deploi": 103, "deploy": 93, "deployment_typ": [89, 93], "deprec": 2, "deriv": 118, "describ": [2, 115, 118, 119], "describe_opt": [0, 116], "descript": [54, 118], "design": 118, "destroi": 0, "detail": 44, "determin": [10, 118], "dict": [2, 15, 16, 17, 18, 19, 21, 89, 93, 95, 99, 102, 103, 114, 115], "dictionari": [0, 2, 15, 16, 52, 119], "differ": 118, "direct": 118, "directli": [3, 12, 57, 58, 74, 89, 94, 109, 111, 112, 113], "directori": [60, 63, 66, 73, 77, 82, 86, 88], "disabl": [2, 8, 93], "disable_data_api": 9, "disast": 103, "disclaim": 118, "discuss": [0, 118], "displai": [0, 52, 118], "distribut": 118, "do": 118, "doc": 119, "document": [0, 115, 118, 119], "doe": [2, 61, 79, 118, 119], "don": 118, "done": 115, "download": [0, 59, 60], "driver": [2, 119], "dummi": 119, "durat": [99, 103], "e": 22, "each": [1, 92, 95, 98, 102, 115, 118, 119], "eas": 115, "easier": 118, "eb": 103, "editori": 118, "either": [0, 52, 89, 94, 112, 113, 115, 118], "elabor": 118, "elast": 103, "electron": 118, "element": [0, 115], "email": 1, "empti": [22, 88, 99, 103], "enabl": [2, 9, 93, 95, 102, 103], "enable_data_api": 8, "enable_extended_data_typ": 2, "enable_kai": [95, 102], "enclos": 118, "encod": [59, 67, 78, 84, 119], "encoding_error": [2, 119], "encrypt": 103, "end": 118, "endpoint": 89, "engin": [0, 1, 53, 119], "enhanc": 119, "enough": 115, "ensur": 103, "entir": [2, 115], "entiti": 118, "entri": 0, "environ": [0, 2, 53, 119], "equal": 115, "error": [2, 119], "escap": [115, 119], "establish": 115, "etc": [1, 95, 102, 115], "evalu": 119, "even": [92, 98, 118], "event": [118, 119], "exampl": [2, 13, 15, 16, 17, 18, 19, 52, 73, 99, 103, 115, 118], "except": [90, 95, 102, 118], "exclud": 118, "exclus": 118, "execut": [0, 2, 16, 42, 54, 116, 118], "exercis": 118, "exist": [21, 59, 60, 66, 70, 72, 73, 78, 87, 89, 94, 112, 113, 119], "expect": [22, 115], "experiment": 119, "expir": [99, 103, 119], "expires_at": [99, 103], "explicitli": 118, "express": 118, "extend": [2, 30, 34, 39, 48, 50], "extens": 119, "extern": 119, "f01b669ed0b6": 109, "fa9edd92": 109, "failur": 118, "fairli": 115, "fals": [0, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 65, 66, 70, 72, 73, 78, 87, 92, 95, 98, 102], "featur": [103, 119], "februari": 116, "fee": 118, "fetch": [17, 18, 19, 25, 116], "fetchal": [13, 115], "fetchmani": [13, 115], "fetchon": [13, 115], "field": [95, 102, 118, 119], "fifti": 118, "file": [0, 2, 59, 60, 64, 65, 67, 70, 72, 73, 74, 78, 79, 83, 84, 85, 87, 118], "fine": 115, "firefox": 1, "firewall_rang": [94, 99, 103], "first": [67, 84], "fit": 118, "fix": 119, "float": [80, 81], "folder": [60, 65, 66, 69, 71, 73, 74, 79], "follow": [0, 67, 84, 93, 95, 102, 115, 118], "foo": 115, "forc": [92, 98], "form": [0, 2, 118], "format": [2, 15, 16, 74, 115, 118, 119], "frame": 52, "free": 118, "from": [0, 1, 15, 16, 18, 19, 21, 23, 103, 115, 118, 119], "full": [2, 27, 75, 115], "function": [0, 2, 3, 26, 28, 29, 53, 54, 90, 115, 119], "fusion": 119, "gener": [1, 13, 45, 99, 103, 118], "geographi": 119, "get": [0, 2, 55, 116], "get_jwt": [116, 119], "get_opt": 116, "get_secret": 119, "get_token": 119, "get_workspac": [89, 112], "get_workspace_group": [0, 94, 113], "give": [0, 92, 98, 118], "given": [27, 28, 29, 30, 31, 32, 38, 41, 61, 63, 64, 65, 115], "glob": 73, "global": [9, 37], "go": [92, 98], "goodwil": 118, "googl": 1, "govern": 118, "grant": 118, "grossli": 118, "group": [0, 92, 93, 94, 98, 99, 103, 105, 108, 113, 119], "gssapi": 119, "ha": [2, 92, 98, 115, 118, 119], "handler": [2, 119], "harmless": 118, "have": [93, 95, 99, 102, 103, 115, 118], "help": 119, "here": [53, 115], "herebi": 118, "herein": 118, "high": 119, "hold": 118, "host": [2, 90, 115], "hostnam": [2, 115], "hour": [99, 103], "how": 118, "howev": [53, 115, 118], "http": [1, 2, 9, 115, 118, 119], "http_proxy_port": 9, "i": [0, 1, 2, 9, 10, 18, 19, 20, 22, 52, 57, 58, 59, 63, 64, 74, 82, 83, 89, 92, 94, 95, 98, 99, 102, 103, 109, 111, 112, 113, 115, 116, 118, 119], "id": [15, 16, 41, 56, 57, 94, 102, 103, 104, 105, 109, 119], "idea": 115, "ident": 2, "identif": 118, "identifi": 118, "idl": 93, "ignor": 73, "ii": 118, "iii": 118, "impli": 118, "import": [0, 115, 118], "improv": [118, 119], "inabl": 118, "inbound": [99, 103], "incident": 118, "includ": [0, 1, 2, 73, 116, 118, 119], "include_root": 73, "inclus": 118, "incorpor": 118, "incur": 118, "indemn": 118, "indemnifi": 118, "index": 119, "indic": [2, 99, 103, 118], "indirect": 118, "individu": 118, "inf": 2, "inf_as_nul": [2, 119], "infil": [15, 119], "infile_stream": 15, "info": 0, "inform": [0, 27, 47, 48, 49, 57, 62, 118], "infring": 118, "inherit": 53, "instal": 116, "instanc": 3, "instanti": [12, 57, 58, 74, 89, 94, 101, 109, 111, 112, 113], "instead": [1, 3, 12, 57], "institut": 118, "int": [1, 2, 9, 15, 16, 18, 23, 24, 25, 41, 74, 89, 92, 93, 95, 98, 99, 102, 103], "integ": 115, "intention": 118, "interact": [0, 119], "interfac": [116, 118, 119], "interv": [95, 102], "io": 15, "ip": [2, 115], "irrevoc": 118, "issu": [118, 119], "iter": [13, 15, 16, 21, 115, 119], "its": 118, "itself": [0, 73, 115], "januari": [116, 118], "javascript": 119, "job": 119, "json": [2, 41, 119], "jsonwebtoken": 1, "juli": 116, "june": 116, "just": 0, "jwt": [1, 2, 56, 119], "kai": [95, 102], "kei": [0, 2, 15, 16, 52, 54, 55, 56, 101, 103, 115, 119], "kerbero": 119, "keyword": [2, 52, 90, 114, 115], "kind": 118, "km": 103, "kwarg": [3, 52, 53, 54, 90, 114], "languag": 118, "larg": [25, 115], "last": 81, "last_modifi": 74, "last_resumed_at": 89, "launchpad": 109, "law": 118, "lawsuit": 118, "leak": 119, "least": 118, "left": 2, "legal": 118, "len": 18, "length": 119, "liabil": 118, "liabl": 118, "licens": 116, "licensor": 118, "like": [0, 13, 52, 72, 115], "limit": 118, "link": 118, "linux": 119, "list": [1, 2, 15, 16, 17, 18, 19, 21, 52, 65, 73, 74, 89, 94, 99, 100, 103, 107, 108, 115, 118], "lite": 115, "litig": 118, "load": 0, "local": [0, 2, 15, 59, 60, 72, 73, 78, 119], "local_infil": [0, 2, 115], "local_path": [59, 60, 72, 73, 78], "locat": [1, 59, 60, 62, 65, 68, 69, 70, 71, 78, 87], "log": 119, "loss": 118, "lost": [99, 103], "made": [115, 118], "mai": [115, 116, 118], "mail": 118, "make": [66, 118, 119], "malfunct": 118, "manag": [2, 56, 111, 116, 118, 119], "manage_workspac": [0, 101, 116], "managementerror": [92, 98], "managemnt": 119, "map": 115, "march": 116, "mark": 118, "max": [2, 15, 16], "maximum": [95, 102], "me": 2, "mean": 118, "mechan": 118, "media": 118, "medium": 118, "meet": 118, "memori": [2, 24, 115, 119], "merchant": 118, "mere": 118, "meth": 0, "method": [0, 3, 9, 12, 22, 52, 57, 58, 74, 89, 94, 101, 115], "mimetyp": 74, "min": 2, "minimum": 119, "mkdir": 0, "mode": [2, 4, 23, 67, 84, 92, 93, 98], "modif": 118, "modifi": [81, 118], "modul": [0, 1, 119], "more": [2, 21, 22, 54, 118, 119], "mostli": 115, "move": [23, 70, 87], "multi_stat": [2, 119], "multipl": [2, 13, 16, 22], "multipli": [93, 95, 102], "must": [22, 115, 118], "my_db": 2, "myprocedur": 13, "mysoldb": 22, "mysql": [2, 115], "mytabl": [15, 16], "name": [1, 2, 13, 28, 29, 30, 31, 32, 54, 55, 57, 73, 74, 77, 89, 94, 95, 99, 102, 103, 109, 114, 118, 119], "namedlist": [100, 108], "namedtupl": [2, 115, 119], "nan": 2, "nan_as_nul": [2, 119], "ndarrai": [17, 18, 19, 21], "necessarili": 118, "need": 119, "neglig": 118, "nest": 73, "new": [0, 7, 67, 70, 84, 87, 95, 102, 103, 116], "new_path": [70, 87], "next": 22, "nextset": 13, "non": [2, 118, 119], "none": [1, 2, 4, 5, 6, 8, 9, 11, 13, 14, 15, 16, 17, 18, 19, 21, 22, 23, 24, 25, 45, 52, 53, 54, 56, 59, 60, 67, 68, 69, 71, 73, 74, 78, 84, 85, 86, 87, 88, 89, 92, 93, 94, 95, 98, 99, 101, 102, 103, 114], "normal": 118, "notat": [93, 95, 102], "note": 1, "notebook": [116, 119], "noth": 118, "notic": 118, "notwithstand": 118, "novemb": 116, "now": 119, "np": [17, 18, 19, 21], "null": 2, "number": [1, 9, 15, 16, 22, 92, 95, 98, 102, 115], "numer": 119, "numpi": [2, 119], "o": 2, "object": [0, 3, 7, 12, 52, 57, 58, 61, 63, 64, 72, 74, 75, 76, 77, 82, 83, 89, 90, 91, 94, 96, 109, 110, 111, 112, 113, 116, 118, 119], "oblig": 118, "obtain": 118, "octob": 116, "off": [2, 115], "offer": 118, "old_path": 70, "onc": [22, 115], "one": [1, 54, 67, 84, 93, 95, 102, 115, 118], "ones": 0, "onli": [73, 103, 118], "open": 72, "oper": [0, 74], "optim": 45, "option": [0, 1, 2, 9, 13, 15, 16, 53, 54, 55, 56, 59, 60, 65, 66, 67, 70, 72, 73, 78, 84, 87, 90, 92, 93, 95, 98, 99, 101, 102, 103, 114, 115, 119], "order": 53, "org": 118, "organ": [0, 56, 116], "organization_id": [56, 101], "origin": [70, 118], "other": [13, 22, 56, 101, 115, 118], "otherwis": 118, "out": [0, 1, 18, 118], "outfil": 45, "outlin": 119, "output": 0, "outstand": 118, "over": 115, "overal": 2, "overwrit": [59, 60, 66, 70, 72, 73, 78, 87], "overwritten": [59, 60, 66, 70, 72, 73, 78, 87], "own": 118, "owner": 118, "ownership": 118, "p455w0rd": 2, "pa": [17, 18, 19, 21], "packag": [0, 115, 119], "packet": 119, "page": 118, "pair": 114, "panda": [2, 119], "param": 13, "paramet": [0, 1, 2, 3, 9, 13, 15, 16, 23, 24, 52, 53, 54, 55, 56, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73, 78, 84, 87, 90, 92, 93, 95, 98, 99, 101, 102, 103, 104, 105, 114, 116, 119], "paramt": [15, 16], "pars": 119, "part": 118, "parti": 118, "particular": 118, "pass": 115, "password": [2, 99, 103, 115, 119], "patent": 118, "path": [2, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 78, 84, 87], "pathlik": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 78, 87], "pattern": [73, 115], "pd": [17, 18, 19, 21], "pend": [6, 11], "per": 115, "percent": 118, "perform": [118, 119], "permiss": 118, "perpetu": 118, "persist": [93, 95, 102], "pertain": 118, "pip": 117, "pipelin": 30, "pl": [17, 18, 19, 21], "place": 118, "plan_id": 41, "plugin": 119, "point": [0, 119], "polar": [2, 119], "poll": [95, 102], "port": [2, 9, 90, 115], "portal": [0, 1, 109, 119], "posit": [23, 119], "possibl": [0, 115, 118], "power": 118, "pre": 119, "predefin": 24, "prefer": 118, "prepar": 118, "previou": 0, "primari": [0, 103], "primarili": [0, 52], "print": [13, 17, 18, 19, 54, 115, 118], "privileg": 9, "procedur": [13, 22], "product": [118, 119], "program": 2, "program_nam": 2, "program_vers": 2, "promin": 118, "propag": 119, "properti": [97, 100, 106, 108], "protocol": 2, "provid": [57, 95, 102, 118], "proxi": [0, 9], "publicli": 118, "pure": [2, 119], "pure_python": 2, "purg": 119, "purpos": 118, "put": 115, "pyc": 73, "pyformat": [15, 16], "pygeo": 119, "pymysql": [22, 119], "pytest": 119, "python": [1, 2, 53, 115, 117, 119], "queri": [0, 2, 12, 13, 15, 16, 42, 45, 116, 119], "queue": [15, 119], "quot": 115, "r": [67, 84], "rais": [21, 92, 95, 98, 102], "rang": [99, 103], "rather": 3, "rawiobas": 15, "rb": [67, 84], "reach": [92, 98], "read": [67, 84, 119], "readabl": 118, "reason": 118, "receiv": 118, "recipi": 118, "recommend": 118, "recoveri": 103, "recurs": [65, 69, 73, 86], "redistribut": 118, "refactor": 119, "refer": 116, "regard": 118, "region": [94, 103, 116, 119], "rel": 23, "releas": 119, "remain": [17, 18, 19, 118], "renam": [0, 2, 119], "replac": [115, 118], "replic": 103, "repres": 118, "reproduc": 118, "reproduct": 118, "request": [1, 99, 103], "requir": [9, 115, 118, 119], "respect": 115, "respons": [99, 103, 118], "result": [0, 2, 13, 17, 18, 19, 21, 22, 23, 52, 57, 59, 74, 78, 89, 94, 109, 112, 113, 116, 118, 119], "results_format": [2, 119], "results_typ": [2, 115, 119], "resum": 119, "resume_attach": 89, "retain": [22, 118], "retriev": [0, 1, 13, 56, 104, 105, 115, 119], "retur": [99, 103], "return": [0, 1, 2, 7, 9, 10, 15, 16, 17, 18, 19, 21, 22, 53, 55, 56, 58, 59, 61, 62, 63, 64, 65, 66, 67, 75, 76, 77, 78, 80, 81, 84, 90, 92, 95, 98, 100, 102, 103, 104, 105, 106, 107, 108, 111, 115, 119], "revis": 118, "right": 118, "risk": 118, "root": 73, "routin": 119, "row": [15, 16, 17, 18, 19, 21, 115], "royalti": 118, "rt": [67, 84], "rule": 119, "run": [9, 44], "s2": [0, 2, 115], "s2db": 109, "safari": 1, "same": [53, 115, 118], "scaling_progress": 89, "schedul": 93, "scheme": 2, "screen": 0, "sdk": 0, "seamless": 103, "second": [1, 2, 92, 95, 98, 102], "secondari": 103, "secret": [0, 116, 119], "section": [115, 118], "see": [0, 3, 118], "seen": 115, "select": [0, 15, 16], "sell": 118, "send": 52, "sent": 118, "separ": [118, 119], "septemb": 116, "sequenc": [13, 15, 16, 24], "server": [0, 2, 9, 34, 37, 46, 47, 48, 90, 92, 98, 115, 119], "servic": [0, 118, 119], "session": [2, 47], "set": [0, 2, 4, 9, 13, 16, 17, 19, 21, 22, 23, 25, 53, 95, 102, 114, 115, 119], "set_opt": 116, "shall": 118, "shape": 119, "share": 118, "should": [0, 2, 9, 12, 59, 60, 66, 70, 72, 73, 78, 87, 92, 101, 103, 118], "show": [0, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 115, 119], "shown": [0, 115], "showresult": [26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51], "sign": 1, "simpl": 52, "singl": [1, 2, 19, 115], "singlestor": [0, 1, 95, 102, 116, 118], "singlestoredb": [0, 115, 117, 119], "singlestoredb_password": 2, "singlestoredb_url": [2, 119], "singlestoredb_us": 2, "singleton": 0, "sinlgestoredb": 0, "size": [18, 24, 25, 74, 89, 93, 95, 102, 115], "skip": 22, "small": 115, "smaller": 115, "smart": 103, "smart_dr": 103, "smartdr": 103, "so": 0, "softwar": 118, "sole": 118, "solut": 103, "sourc": [118, 119], "special": 118, "specif": 118, "specifi": [0, 1, 2, 9, 18, 67, 84, 93, 95, 99, 102, 103, 116, 119], "sql": [15, 16, 119], "sqlalchemi": [0, 53, 115, 119], "ssl": 2, "ssl_ca": 2, "ssl_cert": 2, "ssl_cipher": [2, 119], "ssl_disabl": 2, "ssl_kei": 2, "ssl_verify_cert": [2, 119], "ssl_verify_ident": [2, 119], "sso": 1, "stage": [74, 78, 82, 83, 84, 85, 86, 87, 88, 116, 119], "stage_path": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73], "stageobject": [62, 66, 70, 72, 73, 116], "stageobjectbytesread": [67, 84], "stageobjectbyteswrit": [67, 84], "stageobjecttextread": [67, 84], "stageobjecttextwrit": [67, 84], "standard": 2, "start": [9, 116], "state": [89, 91, 96, 118], "statement": [2, 15, 16, 42, 118, 119], "statu": [33, 37, 47, 49, 52], "still": [10, 20], "stopiter": 21, "stoppag": 118, "store": [0, 13, 103], "str": [1, 2, 13, 15, 16, 17, 18, 19, 21, 23, 25, 27, 28, 29, 30, 31, 32, 38, 45, 54, 55, 56, 57, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 84, 87, 89, 93, 94, 95, 99, 101, 102, 103, 104, 105, 114], "strain": 115, "stream": 15, "string": [0, 2, 54, 67, 84, 115, 119], "stringio": [67, 84], "structsequ": 119, "structur": 115, "style": [15, 16], "sub": 0, "subject": 118, "sublicens": 118, "submiss": 118, "submit": [12, 118], "subsequ": [13, 118], "substit": 115, "substitut": [2, 15, 16, 116], "supersed": 118, "suppli": [90, 99, 103], "support": [67, 84, 103, 118, 119], "suspend": [93, 95, 102, 119], "syntax": [0, 52, 118, 119], "system": 118, "t": [67, 84, 118], "tabl": [17, 18, 19, 21, 27, 31, 38, 49], "taken": 53, "target": [59, 60, 73, 78], "telemetri": 2, "term": 118, "termin": [52, 99, 103, 118], "terminated_at": [89, 94], "test": 119, "text": [67, 84, 118], "textio": 72, "textiobas": 15, "than": [3, 22], "thei": [0, 60, 115], "them": 3, "theori": 118, "thereof": 118, "thi": [0, 1, 2, 3, 9, 12, 22, 52, 53, 54, 57, 58, 74, 89, 90, 94, 95, 101, 102, 103, 109, 111, 112, 113, 115, 118, 119], "third": 118, "those": 118, "thread": 44, "three": 115, "through": [0, 3, 118], "time": [1, 99, 103], "timeout": [1, 2, 92, 98, 119], "timestamp": [80, 81, 99, 103], "titl": 118, "token": [1, 56, 101], "tool": 116, "top": 73, "tort": 118, "total": [92, 98], "track": [0, 2, 118, 119], "track_env": [2, 119], "trade": 118, "trademark": 118, "traffic": [99, 103], "transact": [6, 11], "transfer": 118, "transform": 118, "transit": 115, "translat": 118, "treat": [2, 52], "tree": 73, "tri": 1, "troubleshoot": 45, "true": [0, 2, 4, 18, 19, 22, 73, 95, 102, 115, 119], "truncat": [67, 84], "tupl": [2, 17, 18, 19, 21, 114], "two": 115, "type": [1, 2, 7, 9, 10, 15, 16, 18, 19, 21, 53, 55, 56, 61, 62, 63, 64, 65, 66, 67, 74, 78, 84, 90, 93, 95, 102, 103, 104, 105, 116, 118, 119], "typic": [2, 3], "udf": 119, "unbuff": 119, "under": 118, "underli": 52, "union": 118, "unix": [80, 81], "unless": [2, 118], "until": [1, 22], "up": [92, 98], "updat": [91, 96, 103, 119], "update_window": [99, 103], "upload": [2, 72, 73, 119], "upload_fil": 0, "upload_fold": 0, "url": [0, 1, 2, 56, 101, 116, 119], "us": [0, 1, 2, 9, 12, 13, 15, 16, 18, 21, 22, 52, 56, 57, 59, 67, 73, 74, 78, 84, 89, 94, 101, 109, 112, 113, 116, 117, 118, 119], "usag": 2, "user": [1, 2, 115], "usernam": 2, "utf8": 2, "util": 116, "v0": [115, 116], "v1": 116, "valu": [0, 1, 2, 4, 9, 17, 18, 19, 21, 23, 52, 55, 93, 95, 102, 114, 115], "variabl": [0, 2, 9, 53, 115, 119], "variable_nam": 115, "variou": [0, 74, 119], "vector": [2, 119], "vector_data_format": [2, 119], "verbal": 118, "verifi": 2, "version": [56, 101, 118, 119], "view": 32, "volum": 103, "w": [67, 84], "wa": [1, 118], "wai": 115, "wait": [1, 92, 95, 98, 102], "wait_interv": [92, 95, 98, 102], "wait_on_act": [95, 102], "wait_on_termin": [92, 98], "wait_timeout": [92, 95, 98, 102], "warranti": 118, "wb": [67, 84], "we": 118, "web": [0, 52], "webbrows": 1, "well": 115, "what": 116, "when": [2, 15, 16, 22, 99, 103, 115], "where": [0, 15, 16, 23, 52, 103, 115, 118], "wherev": 118, "whether": [95, 102, 118], "which": [0, 2, 90, 115, 118], "while": [18, 19, 118, 119], "whole": 118, "whom": 118, "window": [99, 103, 119], "within": [0, 2, 93, 118], "without": [0, 53, 118], "work": [1, 115, 118], "workspac": [56, 113, 116, 119], "workspace_group": [0, 58, 89, 94, 102, 116], "workspace_id": 89, "workspacegroup": [58, 74, 89, 102, 103, 105, 108, 111, 116], "workspacemanag": [56, 57, 58, 89, 94, 109, 112, 113, 116], "worldwid": 118, "wrapper": 110, "writabl": 74, "write": [1, 67, 84, 118], "written": 118, "wt": [67, 84], "www": 118, "x": [67, 84], "xb": [67, 84], "xt": [67, 84], "you": [0, 2, 115, 118], "your": [0, 115, 118]}, "titles": ["API Reference", "singlestoredb.auth.get_jwt", "singlestoredb.connect", "singlestoredb.connection.Connection", "singlestoredb.connection.Connection.autocommit", "singlestoredb.connection.Connection.close", "singlestoredb.connection.Connection.commit", "singlestoredb.connection.Connection.cursor", "singlestoredb.connection.Connection.disable_data_api", "singlestoredb.connection.Connection.enable_data_api", "singlestoredb.connection.Connection.is_connected", "singlestoredb.connection.Connection.rollback", "singlestoredb.connection.Cursor", "singlestoredb.connection.Cursor.callproc", "singlestoredb.connection.Cursor.close", "singlestoredb.connection.Cursor.execute", "singlestoredb.connection.Cursor.executemany", "singlestoredb.connection.Cursor.fetchall", "singlestoredb.connection.Cursor.fetchmany", "singlestoredb.connection.Cursor.fetchone", "singlestoredb.connection.Cursor.is_connected", "singlestoredb.connection.Cursor.next", "singlestoredb.connection.Cursor.nextset", "singlestoredb.connection.Cursor.scroll", "singlestoredb.connection.Cursor.setinputsizes", "singlestoredb.connection.Cursor.setoutputsize", "singlestoredb.connection.ShowAccessor.aggregates", "singlestoredb.connection.ShowAccessor.columns", "singlestoredb.connection.ShowAccessor.create_aggregate", "singlestoredb.connection.ShowAccessor.create_function", "singlestoredb.connection.ShowAccessor.create_pipeline", "singlestoredb.connection.ShowAccessor.create_table", "singlestoredb.connection.ShowAccessor.create_view", "singlestoredb.connection.ShowAccessor.database_status", "singlestoredb.connection.ShowAccessor.databases", "singlestoredb.connection.ShowAccessor.errors", "singlestoredb.connection.ShowAccessor.functions", "singlestoredb.connection.ShowAccessor.global_status", "singlestoredb.connection.ShowAccessor.indexes", "singlestoredb.connection.ShowAccessor.partitions", "singlestoredb.connection.ShowAccessor.pipelines", "singlestoredb.connection.ShowAccessor.plan", "singlestoredb.connection.ShowAccessor.plancache", "singlestoredb.connection.ShowAccessor.procedures", "singlestoredb.connection.ShowAccessor.processlist", "singlestoredb.connection.ShowAccessor.reproduction", "singlestoredb.connection.ShowAccessor.schemas", "singlestoredb.connection.ShowAccessor.session_status", "singlestoredb.connection.ShowAccessor.status", "singlestoredb.connection.ShowAccessor.table_status", "singlestoredb.connection.ShowAccessor.tables", "singlestoredb.connection.ShowAccessor.warnings", "singlestoredb.connection.ShowResult", "singlestoredb.create_engine", "singlestoredb.describe_option", "singlestoredb.get_option", "singlestoredb.manage_workspaces", "singlestoredb.management.region.Region", "singlestoredb.management.workspace.Stage", "singlestoredb.management.workspace.Stage.download_file", "singlestoredb.management.workspace.Stage.download_folder", "singlestoredb.management.workspace.Stage.exists", "singlestoredb.management.workspace.Stage.info", "singlestoredb.management.workspace.Stage.is_dir", "singlestoredb.management.workspace.Stage.is_file", "singlestoredb.management.workspace.Stage.listdir", "singlestoredb.management.workspace.Stage.mkdir", "singlestoredb.management.workspace.Stage.open", "singlestoredb.management.workspace.Stage.remove", "singlestoredb.management.workspace.Stage.removedirs", "singlestoredb.management.workspace.Stage.rename", "singlestoredb.management.workspace.Stage.rmdir", "singlestoredb.management.workspace.Stage.upload_file", "singlestoredb.management.workspace.Stage.upload_folder", "singlestoredb.management.workspace.StageObject", "singlestoredb.management.workspace.StageObject.abspath", "singlestoredb.management.workspace.StageObject.basename", "singlestoredb.management.workspace.StageObject.dirname", "singlestoredb.management.workspace.StageObject.download", "singlestoredb.management.workspace.StageObject.exists", "singlestoredb.management.workspace.StageObject.getctime", "singlestoredb.management.workspace.StageObject.getmtime", "singlestoredb.management.workspace.StageObject.is_dir", "singlestoredb.management.workspace.StageObject.is_file", "singlestoredb.management.workspace.StageObject.open", "singlestoredb.management.workspace.StageObject.remove", "singlestoredb.management.workspace.StageObject.removedirs", "singlestoredb.management.workspace.StageObject.rename", "singlestoredb.management.workspace.StageObject.rmdir", "singlestoredb.management.workspace.Workspace", "singlestoredb.management.workspace.Workspace.connect", "singlestoredb.management.workspace.Workspace.refresh", "singlestoredb.management.workspace.Workspace.terminate", "singlestoredb.management.workspace.Workspace.update", "singlestoredb.management.workspace.WorkspaceGroup", "singlestoredb.management.workspace.WorkspaceGroup.create_workspace", "singlestoredb.management.workspace.WorkspaceGroup.refresh", "singlestoredb.management.workspace.WorkspaceGroup.stage", "singlestoredb.management.workspace.WorkspaceGroup.terminate", "singlestoredb.management.workspace.WorkspaceGroup.update", "singlestoredb.management.workspace.WorkspaceGroup.workspaces", "singlestoredb.management.workspace.WorkspaceManager", "singlestoredb.management.workspace.WorkspaceManager.create_workspace", "singlestoredb.management.workspace.WorkspaceManager.create_workspace_group", "singlestoredb.management.workspace.WorkspaceManager.get_workspace", "singlestoredb.management.workspace.WorkspaceManager.get_workspace_group", "singlestoredb.management.workspace.WorkspaceManager.organization", "singlestoredb.management.workspace.WorkspaceManager.regions", "singlestoredb.management.workspace.WorkspaceManager.workspace_groups", "singlestoredb.notebook.organization", "singlestoredb.notebook.secrets", "singlestoredb.notebook.stage", "singlestoredb.notebook.workspace", "singlestoredb.notebook.workspace_group", "singlestoredb.set_option", "Getting Started", "SingleStoreDB Python SDK", "Installation", "License", "What\u2019s New"], "titleterms": {"": 119, "0": 119, "1": 119, "10": 119, "12": 119, "13": 119, "14": 119, "15": 119, "16": 119, "17": 119, "18": 119, "19": 119, "2": 119, "20": 119, "2022": 119, "2023": 119, "2024": 119, "21": 119, "23": 119, "24": 119, "25": 119, "26": 119, "28": 119, "29": 119, "3": 119, "31": 119, "4": 119, "5": 119, "6": 119, "7": 119, "8": 119, "9": 119, "abspath": 75, "addit": 115, "aggreg": 26, "api": [0, 115, 119], "april": 119, "august": 119, "auth": 1, "autocommit": 4, "basenam": 76, "callproc": 13, "chang": 119, "close": [5, 14], "column": 27, "commit": 6, "configur": 0, "connect": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 90, 115], "content": 116, "create_aggreg": 28, "create_engin": 53, "create_funct": 29, "create_pipelin": 30, "create_t": 31, "create_view": 32, "create_workspac": [95, 102], "create_workspace_group": 103, "cursor": [0, 7, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25], "databas": 34, "database_statu": 33, "db": 115, "decemb": 119, "default": 115, "describe_opt": 54, "dictionari": 115, "dirnam": 77, "disable_data_api": 8, "download": 78, "download_fil": 59, "download_fold": 60, "enable_data_api": 9, "error": 35, "execut": [15, 115], "executemani": 16, "exist": [61, 79], "februari": 119, "fetch": 115, "fetchal": 17, "fetchmani": 18, "fetchon": 19, "function": 36, "get": 115, "get_jwt": 1, "get_opt": 55, "get_workspac": 104, "get_workspace_group": 105, "getctim": 80, "getmtim": 81, "global_statu": 37, "index": 38, "info": 62, "instal": 117, "is_connect": [10, 20], "is_dir": [63, 82], "is_fil": [64, 83], "januari": 119, "juli": 119, "june": 119, "licens": 118, "listdir": 65, "mai": 119, "manag": [0, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108], "manage_workspac": 56, "march": 119, "mkdir": 66, "name": 115, "new": 119, "next": 21, "nextset": 22, "notebook": [0, 109, 110, 111, 112, 113], "novemb": 119, "octob": 119, "open": [67, 84], "organ": [106, 109], "paraemet": 70, "paramet": 115, "partit": 39, "pipelin": 40, "plan": 41, "plancach": 42, "posit": 115, "procedur": 43, "processlist": 44, "python": 116, "queri": 115, "refer": 0, "refresh": [91, 96], "region": [0, 57, 107], "remov": [68, 85], "removedir": [69, 86], "renam": [70, 87], "reproduct": 45, "result": 115, "rmdir": [71, 88], "rollback": 11, "schema": 46, "scroll": 23, "sdk": 116, "secret": 110, "septemb": 119, "session_statu": 47, "set_opt": 114, "setinputs": 24, "setoutputs": 25, "showaccessor": [26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51], "showresult": [0, 52], "singlestoredb": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 116], "specifi": 115, "stage": [0, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 97, 111], "stageobject": [0, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88], "start": 115, "statu": 48, "substitut": 115, "tabl": 50, "table_statu": 49, "termin": [92, 98], "tool": 0, "tupl": 115, "type": 115, "updat": [93, 99], "upload_fil": 72, "upload_fold": 73, "url": 115, "us": 115, "util": 0, "v0": 119, "v1": 119, "warn": 51, "what": 119, "workspac": [0, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 112], "workspace_group": [108, 113], "workspacegroup": [0, 94, 95, 96, 97, 98, 99, 100], "workspacemanag": [0, 101, 102, 103, 104, 105, 106, 107, 108]}}) diff --git a/docs/src/whatsnew.rst b/docs/src/whatsnew.rst index c3e5b4de..618d4511 100644 --- a/docs/src/whatsnew.rst +++ b/docs/src/whatsnew.rst @@ -8,6 +8,10 @@ This document outlines features and improvements from each release. are for non-production testing and evaluation, and may include changes to the API. +v1.7.2 - October 16, 2024 +------------------------- +* Fixes for apps + v1.7.1 - September 20, 2024 --------------------------- * Fixes for apps diff --git a/docs/whatsnew.html b/docs/whatsnew.html index c254d939..eb90c414 100644 --- a/docs/whatsnew.html +++ b/docs/whatsnew.html @@ -3,14 +3,14 @@ - What’s New — SingleStoreDB 1.7.1 documentation + What’s New — SingleStoreDB 1.7.2 documentation - + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.7.1 + 1.7.2
      @@ -42,6 +42,7 @@
      • Installation
      • What’s New
          +
        • v1.7.2 - October 16, 2024
        • v1.7.1 - September 20, 2024
        • v1.7.0 - September 20, 2024
        • v1.6.3 - September 5, 2024
        • @@ -139,6 +140,12 @@

          What’s New +

          v1.7.2 - October 16, 2024

          +
            +
          • Fixes for apps

          • +
          +

          v1.7.1 - September 20, 2024

            diff --git a/setup.cfg b/setup.cfg index 1e66da5b..f4a78196 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = singlestoredb -version = 1.7.1 +version = 1.7.2 description = Interface to the SingleStoreDB database and workspace management APIs long_description = file: README.md long_description_content_type = text/markdown diff --git a/singlestoredb/__init__.py b/singlestoredb/__init__.py index f8997f7f..c95ca4bb 100644 --- a/singlestoredb/__init__.py +++ b/singlestoredb/__init__.py @@ -13,7 +13,7 @@ """ -__version__ = '1.7.1' +__version__ = '1.7.2' from typing import Any