diff --git a/docs/_sources/api.rst.txt b/docs/_sources/api.rst.txt index f006b72fb..fbbe95cb0 100644 --- a/docs/_sources/api.rst.txt +++ b/docs/_sources/api.rst.txt @@ -226,6 +226,50 @@ calls to the currently selected portal services. workspace_group stage workspace +Server Tools +------------ +If you have Docker installed on your machine, you can use the Docker interface +included with the Python SDK to start a SingleStoreDB server in Docker. This +allows you to open interactive shells, SQL Studio, and also use the `%sql` +magic commands from Jupysql with a SingleStoreDB server running in a container. +An example of starting SingleStoreDB in Docker is shown below. +.. sourcecode:: python + from singlestoredb.server import docker + s2db = docker.start() + with s2db.connect() as conn: + with conn.cursor() as cur: + cur.execute('SHOW DATABASES') + for line in cur: + print(line) + s2db.stop() +It is possible to use the server instance as a context manager as well. +This will automatically shut down the container after exiting the ``with`` +block. +.. sourcecode:: python + from singlestoredb.server import docker + with docker.start() as s2db: + with s2db.connect() as conn: + with conn.cursor() as cur: + cur.execute('SHOW DATABASES') + for line in cur: + print(line) +If you do not explicitly shut down the container, it will get shut +down when the Python process exits. +.. currentmodule:: singlestoredb.server.docker +.. autosummary:: + :toctree: generated/ + start + SingleStoreDB.logs + SingleStoreDB.connect + SingleStoreDB.connect_kai + SingleStoreDB.connection_url + SingleStoreDB.http_connection_url + SingleStoreDB.kai_url + SingleStoreDB.studio_url + SingleStoreDB.open_studio + SingleStoreDB.open_shell + SingleStoreDB.open_mongosh + SingleStoreDB.stop Configuration ------------- The following functions are used to get and set package configuration settings. diff --git a/docs/api.html b/docs/api.html index e7611b2b6..562815706 100644 --- a/docs/api.html +++ b/docs/api.html @@ -191,6 +191,21 @@
  • singlestoredb.notebook.workspace
    • +
  • Server Tools +
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connect.html b/docs/generated/singlestoredb.connect.html index be46a66bc..a8c708ed3 100644 --- a/docs/generated/singlestoredb.connect.html +++ b/docs/generated/singlestoredb.connect.html @@ -57,6 +57,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • @@ -88,7 +89,7 @@

    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, tls_sni_servername: str | 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, tls_sni_servername: str | 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, parse_json: bool | None = None) → Connection

    Return a SingleStoreDB connection.

    Parameters:
    diff --git a/docs/generated/singlestoredb.connection.Connection.autocommit.html b/docs/generated/singlestoredb.connection.Connection.autocommit.html index 2dc3085bd..0b9ff68d0 100644 --- a/docs/generated/singlestoredb.connection.Connection.autocommit.html +++ b/docs/generated/singlestoredb.connection.Connection.autocommit.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.close.html b/docs/generated/singlestoredb.connection.Connection.close.html index 302afc3a2..ba6536cd1 100644 --- a/docs/generated/singlestoredb.connection.Connection.close.html +++ b/docs/generated/singlestoredb.connection.Connection.close.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.commit.html b/docs/generated/singlestoredb.connection.Connection.commit.html index 5f1817d93..89adf901a 100644 --- a/docs/generated/singlestoredb.connection.Connection.commit.html +++ b/docs/generated/singlestoredb.connection.Connection.commit.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.cursor.html b/docs/generated/singlestoredb.connection.Connection.cursor.html index 173393f49..4aac03263 100644 --- a/docs/generated/singlestoredb.connection.Connection.cursor.html +++ b/docs/generated/singlestoredb.connection.Connection.cursor.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html index 549710b9a..557e6e22a 100644 --- a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html index 62ef2b021..9d595a25b 100644 --- a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.html b/docs/generated/singlestoredb.connection.Connection.html index e53c5325b..523397fde 100644 --- a/docs/generated/singlestoredb.connection.Connection.html +++ b/docs/generated/singlestoredb.connection.Connection.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.is_connected.html b/docs/generated/singlestoredb.connection.Connection.is_connected.html index ee5bf0e77..53eb29ded 100644 --- a/docs/generated/singlestoredb.connection.Connection.is_connected.html +++ b/docs/generated/singlestoredb.connection.Connection.is_connected.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Connection.rollback.html b/docs/generated/singlestoredb.connection.Connection.rollback.html index 94c233811..e5540e371 100644 --- a/docs/generated/singlestoredb.connection.Connection.rollback.html +++ b/docs/generated/singlestoredb.connection.Connection.rollback.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.callproc.html b/docs/generated/singlestoredb.connection.Cursor.callproc.html index ac1f9fd04..9a373f42d 100644 --- a/docs/generated/singlestoredb.connection.Cursor.callproc.html +++ b/docs/generated/singlestoredb.connection.Cursor.callproc.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.close.html b/docs/generated/singlestoredb.connection.Cursor.close.html index 9d6607bac..0adf69ce8 100644 --- a/docs/generated/singlestoredb.connection.Cursor.close.html +++ b/docs/generated/singlestoredb.connection.Cursor.close.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.execute.html b/docs/generated/singlestoredb.connection.Cursor.execute.html index b11449bb2..511424ccc 100644 --- a/docs/generated/singlestoredb.connection.Cursor.execute.html +++ b/docs/generated/singlestoredb.connection.Cursor.execute.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.executemany.html b/docs/generated/singlestoredb.connection.Cursor.executemany.html index 8c6f21071..36eb5346b 100644 --- a/docs/generated/singlestoredb.connection.Cursor.executemany.html +++ b/docs/generated/singlestoredb.connection.Cursor.executemany.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchall.html b/docs/generated/singlestoredb.connection.Cursor.fetchall.html index 4aba8a681..b16303591 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchall.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchall.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html index 7c842a199..b55d43afc 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchone.html b/docs/generated/singlestoredb.connection.Cursor.fetchone.html index dcbb91e76..58634c55a 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchone.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchone.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.html b/docs/generated/singlestoredb.connection.Cursor.html index 315046412..e4154ec61 100644 --- a/docs/generated/singlestoredb.connection.Cursor.html +++ b/docs/generated/singlestoredb.connection.Cursor.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.is_connected.html b/docs/generated/singlestoredb.connection.Cursor.is_connected.html index d49a5c490..bb22f6fae 100644 --- a/docs/generated/singlestoredb.connection.Cursor.is_connected.html +++ b/docs/generated/singlestoredb.connection.Cursor.is_connected.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.next.html b/docs/generated/singlestoredb.connection.Cursor.next.html index fd41c3014..efbb0326e 100644 --- a/docs/generated/singlestoredb.connection.Cursor.next.html +++ b/docs/generated/singlestoredb.connection.Cursor.next.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.nextset.html b/docs/generated/singlestoredb.connection.Cursor.nextset.html index 57312d8d7..305367006 100644 --- a/docs/generated/singlestoredb.connection.Cursor.nextset.html +++ b/docs/generated/singlestoredb.connection.Cursor.nextset.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.scroll.html b/docs/generated/singlestoredb.connection.Cursor.scroll.html index 49a713d59..251700d6f 100644 --- a/docs/generated/singlestoredb.connection.Cursor.scroll.html +++ b/docs/generated/singlestoredb.connection.Cursor.scroll.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html index 6209d84b4..3b57ff886 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html +++ b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html index 2787c5fed..8c2b04497 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html +++ b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html @@ -70,6 +70,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html index 16a2b4a0d..d7eca5d83 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html index 53887582e..eb875f8c2 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html index b95be2f47..30033e0b1 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html index 44dd440c8..ee0e98ee4 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html index cabc1ecf3..001e1a87c 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html index c6bfe291e..2d10913c3 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html index 0867adcb2..7b96d4212 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html index 28fea0e5c..041cc236e 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html index 4781b2afd..019e0c2da 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html index b06786923..5b60ef604 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html index be0dd3d11..5d00ec849 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html index 44382eae8..443fcc908 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html index 49815e454..140c7f3c3 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html index ffbbeca34..bce41877a 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html index 2ba205cce..300010d4a 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html index 56cc2f295..138b4ea1e 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html index 3d638b362..b34983284 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html index 43d34c92b..2da3df0ce 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html index 7850fd9cc..4c390bb4a 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html index e91b790a5..3baf19d82 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html index 698a039cc..bbb156514 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html index 607ccf3e5..367106cbf 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.status.html b/docs/generated/singlestoredb.connection.ShowAccessor.status.html index daa7890b6..f65440e6c 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.status.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html index 242ffdb54..9759f4302 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html index 1cacaf6eb..571c598e5 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html index b665828fe..75f1033a9 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.connection.ShowResult.html b/docs/generated/singlestoredb.connection.ShowResult.html index 76400b7bf..8aa0cb0e1 100644 --- a/docs/generated/singlestoredb.connection.ShowResult.html +++ b/docs/generated/singlestoredb.connection.ShowResult.html @@ -92,6 +92,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.create_engine.html b/docs/generated/singlestoredb.create_engine.html index a56c07b46..f13c2202b 100644 --- a/docs/generated/singlestoredb.create_engine.html +++ b/docs/generated/singlestoredb.create_engine.html @@ -57,6 +57,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.describe_option.html b/docs/generated/singlestoredb.describe_option.html index f9249b43e..04947f4ef 100644 --- a/docs/generated/singlestoredb.describe_option.html +++ b/docs/generated/singlestoredb.describe_option.html @@ -48,6 +48,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.region.Region.html b/docs/generated/singlestoredb.management.region.Region.html index c567d68bb..a494b11f7 100644 --- a/docs/generated/singlestoredb.management.region.Region.html +++ b/docs/generated/singlestoredb.management.region.Region.html @@ -60,6 +60,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html index be7f540ee..efd5c87f4 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html index b2d0ff6b9..4328d4390 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.exists.html b/docs/generated/singlestoredb.management.workspace.Stage.exists.html index 16543bb56..066fb6747 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.exists.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.exists.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.html b/docs/generated/singlestoredb.management.workspace.Stage.html index 374b1b366..dcdcd3575 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.info.html b/docs/generated/singlestoredb.management.workspace.Stage.info.html index 3a0455214..4af5a9419 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.info.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.info.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html index 1cf1325e2..ba462a777 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html index d50802e66..362fa04f8 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html index c520b2d27..993d91596 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html index 75313e392..05a488501 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.open.html b/docs/generated/singlestoredb.management.workspace.Stage.open.html index 996fb7ea2..3ad86ce7a 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.open.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.open.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.remove.html b/docs/generated/singlestoredb.management.workspace.Stage.remove.html index d0dd5481a..09be605a4 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.remove.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.remove.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html index bca46a5d4..eeb397a25 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rename.html b/docs/generated/singlestoredb.management.workspace.Stage.rename.html index e4806f475..46df729fe 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rename.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rename.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html index be553cc67..0f55cfa6e 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html index 74a579482..e70fc99d0 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html index 7f4ef189e..406f40fb5 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html @@ -75,6 +75,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html index 2614a4e0f..50fd9965c 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html index 5408ba0db..dfa906562 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html index 29fcef2de..d77bc5271 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.download.html b/docs/generated/singlestoredb.management.workspace.StageObject.download.html index e318e9db6..9c9d8951d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.download.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.download.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html index a6e1fea13..ea788a8c8 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html index b439d66c0..8c046be5f 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html index 278027012..4299b5193 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.html b/docs/generated/singlestoredb.management.workspace.StageObject.html index 4f89379ad..973037ee8 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html index 47907a4a4..111185dc7 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html index c4fb79ab1..ddf9a6671 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.open.html b/docs/generated/singlestoredb.management.workspace.StageObject.open.html index a5f8d3b7b..cd966f53e 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.open.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.open.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html index 0e2a5b56f..679e82b6d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html index 918abd249..55ad828f9 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html index f379bbf2c..f08b73c09 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html index 5b6e0ea09..eb8b386bd 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html @@ -74,6 +74,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html index 9f9c1a4b5..a97c42158 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html @@ -64,6 +64,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.html b/docs/generated/singlestoredb.management.workspace.Workspace.html index 57c1cafee..4a1e17b39 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.html @@ -64,6 +64,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html index 662207185..50f4c2834 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html @@ -64,6 +64,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html index abbb52b00..e48dc9291 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html @@ -64,6 +64,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.update.html b/docs/generated/singlestoredb.management.workspace.Workspace.update.html index 292e03b36..795159ba6 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.update.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.update.html @@ -64,6 +64,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html index ab47ed88d..baa33de34 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html index ed8667199..651eaeeb9 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html index 7edfb6ed1..d6d202580 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html index c91a51b5a..35e087be6 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html index 139776058..938a02f1d 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html index 7d9bdcfb3..d3bc019ba 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html index f52b986bd..19a381007 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html @@ -66,6 +66,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html index d28e6b8de..ab718d1f2 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • 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 8f831c7ae..642c48835 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html index 00ed6116c..6a06338d9 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • 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 3cb3cf0a6..6065adc13 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html index 6d6534040..4c7682326 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html index afedd61f3..5acaf2992 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html index 81bfc4f4c..a3165d40a 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html index e4a79bb58..bc68d8884 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html @@ -67,6 +67,7 @@
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.notebook.organization.html b/docs/generated/singlestoredb.notebook.organization.html index c7fb792ec..339173dd9 100644 --- a/docs/generated/singlestoredb.notebook.organization.html +++ b/docs/generated/singlestoredb.notebook.organization.html @@ -58,6 +58,7 @@
  • singlestoredb.notebook.workspace
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.notebook.secrets.html b/docs/generated/singlestoredb.notebook.secrets.html index 110495190..89f95ed77 100644 --- a/docs/generated/singlestoredb.notebook.secrets.html +++ b/docs/generated/singlestoredb.notebook.secrets.html @@ -58,6 +58,7 @@
  • singlestoredb.notebook.workspace
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.notebook.stage.html b/docs/generated/singlestoredb.notebook.stage.html index a34b1607f..774bf0000 100644 --- a/docs/generated/singlestoredb.notebook.stage.html +++ b/docs/generated/singlestoredb.notebook.stage.html @@ -58,6 +58,7 @@
  • singlestoredb.notebook.workspace
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.notebook.workspace.html b/docs/generated/singlestoredb.notebook.workspace.html index fc415689f..dcc9fbc8a 100644 --- a/docs/generated/singlestoredb.notebook.workspace.html +++ b/docs/generated/singlestoredb.notebook.workspace.html @@ -16,7 +16,7 @@ - + @@ -58,6 +58,7 @@ +
  • Server Tools
  • Configuration
    • @@ -106,7 +107,7 @@

    singlestoredb.notebook.workspace - +
    diff --git a/docs/generated/singlestoredb.notebook.workspace_group.html b/docs/generated/singlestoredb.notebook.workspace_group.html index 99f202ea4..986b13767 100644 --- a/docs/generated/singlestoredb.notebook.workspace_group.html +++ b/docs/generated/singlestoredb.notebook.workspace_group.html @@ -58,6 +58,7 @@
  • singlestoredb.notebook.workspace
    • +
  • Server Tools
  • Configuration
    • diff --git a/docs/generated/singlestoredb.set_option.html b/docs/generated/singlestoredb.set_option.html index f8662d7cd..61e00965e 100644 --- a/docs/generated/singlestoredb.set_option.html +++ b/docs/generated/singlestoredb.set_option.html @@ -48,6 +48,7 @@
  • Utilities
  • Management API
  • Notebook Tools
    • +
  • Server Tools
  • Configuration
    • +
  • open_mongosh() (singlestoredb.server.docker.SingleStoreDB method) +
    • +
  • StageObject (in module singlestoredb.management.workspace) +
    • +
  • start() (in module singlestoredb.server.docker)
  • status() (singlestoredb.connection.ShowAccessor method) +
    • +
  • stop() (singlestoredb.server.docker.SingleStoreDB method) +
    • +
  • studio_url (singlestoredb.server.docker.SingleStoreDB property)
    • diff --git a/docs/index.html b/docs/index.html index aa7db54c1..8c9d7ba65 100644 --- a/docs/index.html +++ b/docs/index.html @@ -189,6 +189,21 @@

    SingleStoreDB Python SDKsinglestoredb.notebook.workspace +
  • Server Tools +
  • Configuration
    • singlestoredb.get_option
    • singlestoredb.set_option
      • diff --git a/docs/objects.inv b/docs/objects.inv index 1c68afb3d..2dff482bc 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/searchindex.js b/docs/searchindex.js index 2301616bc..89f91c1b2 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.10.0 - December 10, 2024": [[119, "v1-10-0-december-10-2024"]], "v1.11.0 - January 9, 2025": [[119, "v1-11-0-january-9-2025"]], "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"]], "v1.8.0 - November 19, 2024": [[119, "v1-8-0-november-19-2024"]], "v1.9.0 - December 4, 2024": [[119, "v1-9-0-december-4-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.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 (in module 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, 4, 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": [[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, 5, 1, "", "stage"], [98, 3, 1, "", "terminate"], [99, 3, 1, "", "update"], [100, 5, 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, 5, 1, "", "organization"], [107, 3, 1, "", "regions"], [108, 5, 1, "", "workspace_groups"]], "singlestoredb.notebook": [[109, 6, 1, "", "organization"], [110, 6, 1, "", "secrets"], [111, 6, 1, "", "stage"], [112, 6, 1, "", "workspace"], [113, 6, 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", "attribute", "Python attribute"], "5": ["py", "property", "Python property"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute", "5": "py:property", "6": "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, 116], "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, "2025": 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, 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, 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, "alia": 74, "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, 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, 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, 119], "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, 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, 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, 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": [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_id": 58, "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, 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, "egress": 119, "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, "export": 119, "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, 78, 79, 83, 84, 85, 87, 118, 119], "filesobject": [62, 66, 70, 72, 73, 74], "filesobjectbytesread": [67, 84], "filesobjectbyteswrit": [67, 84], "filesobjecttextread": [67, 84], "filesobjecttextwrit": [67, 84], "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, 79], "follow": [0, 67, 84, 93, 95, 102, 115, 118], "foo": 115, "forc": [92, 98], "form": [0, 2, 118], "format": [2, 15, 16, 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, 82, 83, 89, 92, 94, 95, 98, 99, 102, 103, 109, 111, 112, 113, 115, 116, 118, 119], "iceberg": 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, 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, 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_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, 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], "magic": 119, "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, 89, 94, 101, 115], "min": 2, "minimum": 119, "mkdir": 0, "mode": [2, 4, 23, 67, 84, 92, 93, 98], "model": 119, "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, 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, 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, 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, "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, 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], "person": 119, "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, 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], "run_person": 119, "run_shar": 119, "s2": [0, 2, 115], "s2db": 109, "safari": 1, "same": [53, 115, 118], "scaling_progress": 89, "schedul": [93, 119], "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, 119], "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, 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, 119], "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": [116, 119], "stage_path": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73], "stageobject": 116, "standard": 2, "start": [9, 116], "starterworkspac": [58, 111], "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, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 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, 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, "tls_sni_servernam": [2, 119], "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, 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, 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, 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, 89, 94, 102, 116], "workspace_id": 89, "workspacegroup": [58, 89, 102, 103, 105, 108, 111, 116], "workspacemanag": [56, 57, 58, 89, 94, 109, 112, 113, 116], "worldwid": 118, "wrapper": 110, "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, "11": 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, "2025": 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": [[127, "connect-using-db-api-parameters"]], "Connect using a URL": [[127, "connect-using-a-url"]], "Connection": [[0, "connection"]], "Connections": [[0, "connections"]], "Contents:": [[128, null]], "Cursor": [[0, "cursor"]], "Dictionaries": [[127, "dictionaries"]], "Executing Queries": [[127, "executing-queries"]], "Fetching Results": [[127, "fetching-results"]], "Getting Started": [[127, null]], "Installation": [[129, null]], "License": [[130, null]], "Management API": [[0, "management-api"]], "Named Substitution": [[127, "named-substitution"]], "Named Tuples": [[127, "named-tuples"]], "Notebook Tools": [[0, "notebook-tools"]], "Paraemeters": [[70, "paraemeters"]], "Parameter Substitution": [[127, "parameter-substitution"]], "Positional Substitution": [[127, "positional-substitution"]], "Region": [[0, "region"]], "Result Type": [[127, "result-type"]], "Server Tools": [[0, "server-tools"]], "ShowResult": [[0, "showresult"]], "SingleStoreDB Python SDK": [[128, null]], "Specifying Additional Connection Parameters": [[127, "specifying-additional-connection-parameters"]], "Stage": [[0, "stage"]], "StageObject": [[0, "stageobject"]], "Tuples (Default)": [[127, "tuples-default"]], "Utilities": [[0, "utilities"]], "What\u2019s New": [[131, 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.server.docker.SingleStoreDB.connect": [[114, null]], "singlestoredb.server.docker.SingleStoreDB.connect_kai": [[115, null]], "singlestoredb.server.docker.SingleStoreDB.connection_url": [[116, null]], "singlestoredb.server.docker.SingleStoreDB.http_connection_url": [[117, null]], "singlestoredb.server.docker.SingleStoreDB.kai_url": [[118, null]], "singlestoredb.server.docker.SingleStoreDB.logs": [[119, null]], "singlestoredb.server.docker.SingleStoreDB.open_mongosh": [[120, null]], "singlestoredb.server.docker.SingleStoreDB.open_shell": [[121, null]], "singlestoredb.server.docker.SingleStoreDB.open_studio": [[122, null]], "singlestoredb.server.docker.SingleStoreDB.stop": [[123, null]], "singlestoredb.server.docker.SingleStoreDB.studio_url": [[124, null]], "singlestoredb.server.docker.start": [[125, null]], "singlestoredb.set_option": [[126, null]], "v0.1.0 - May 6, 2022": [[131, "v0-1-0-may-6-2022"]], "v0.10.0 - December 12, 2023": [[131, "v0-10-0-december-12-2023"]], "v0.10.1 - December 13, 2023": [[131, "v0-10-1-december-13-2023"]], "v0.10.2 - December 14, 2023": [[131, "v0-10-2-december-14-2023"]], "v0.10.3 - January 17, 2024": [[131, "v0-10-3-january-17-2024"]], "v0.10.4 - January 18, 2024": [[131, "v0-10-4-january-18-2024"]], "v0.10.5 - January 23, 2024": [[131, "v0-10-5-january-23-2024"]], "v0.10.6 - January 26, 2024": [[131, "v0-10-6-january-26-2024"]], "v0.10.7 - January 31, 2024": [[131, "v0-10-7-january-31-2024"]], "v0.2.0 - August 5, 2022": [[131, "v0-2-0-august-5-2022"]], "v0.3.0 - September 9, 2022": [[131, "v0-3-0-september-9-2022"]], "v0.3.1 - September 9, 2022": [[131, "v0-3-1-september-9-2022"]], "v0.3.2 - September 14, 2022": [[131, "v0-3-2-september-14-2022"]], "v0.3.3 - September 21, 2022": [[131, "v0-3-3-september-21-2022"]], "v0.4.0 - October 19, 2022": [[131, "v0-4-0-october-19-2022"]], "v0.5.0 - December 8, 2022 (API CHANGES)": [[131, "v0-5-0-december-8-2022-api-changes"]], "v0.5.1 - December 9, 2022": [[131, "v0-5-1-december-9-2022"]], "v0.5.2 - December 14, 2022": [[131, "v0-5-2-december-14-2022"]], "v0.5.3 - January 9, 2023": [[131, "v0-5-3-january-9-2023"]], "v0.5.4 - March 15, 2023": [[131, "v0-5-4-march-15-2023"]], "v0.6.0 - May 17, 2023": [[131, "v0-6-0-may-17-2023"]], "v0.6.1 - May 18, 2023": [[131, "v0-6-1-may-18-2023"]], "v0.7.0 - June 9, 2023": [[131, "v0-7-0-june-9-2023"]], "v0.7.1 - June 15, 2023": [[131, "v0-7-1-june-15-2023"]], "v0.8.0 - July 12, 2023": [[131, "v0-8-0-july-12-2023"]], "v0.8.1 - July 12, 2023": [[131, "v0-8-1-july-12-2023"]], "v0.8.2 - August 10, 2023": [[131, "v0-8-2-august-10-2023"]], "v0.8.3 - August 23, 2023": [[131, "v0-8-3-august-23-2023"]], "v0.8.4 - August 28, 2023": [[131, "v0-8-4-august-28-2023"]], "v0.8.5 - August 29, 2023": [[131, "v0-8-5-august-29-2023"]], "v0.8.6 - August 29, 2023": [[131, "v0-8-6-august-29-2023"]], "v0.8.7 - September 19, 2023": [[131, "v0-8-7-september-19-2023"]], "v0.8.8 - September 26, 2023": [[131, "v0-8-8-september-26-2023"]], "v0.8.9 - October 4, 2023": [[131, "v0-8-9-october-4-2023"]], "v0.9.0 - October 16, 2023": [[131, "v0-9-0-october-16-2023"]], "v0.9.1 - October 17, 2023": [[131, "v0-9-1-october-17-2023"]], "v0.9.2 - October 24, 2023": [[131, "v0-9-2-october-24-2023"]], "v0.9.3 - October 25, 2023": [[131, "v0-9-3-october-25-2023"]], "v0.9.4 - October 31, 2023": [[131, "v0-9-4-october-31-2023"]], "v0.9.5 - October 31, 2023": [[131, "v0-9-5-october-31-2023"]], "v0.9.6 - November 2, 2023": [[131, "v0-9-6-november-2-2023"]], "v1.0.0 - February, 12 2024": [[131, "v1-0-0-february-12-2024"]], "v1.0.1 - February, 16 2024": [[131, "v1-0-1-february-16-2024"]], "v1.0.2 - March, 8 2024": [[131, "v1-0-2-march-8-2024"]], "v1.0.3 - April, 2 2024": [[131, "v1-0-3-april-2-2024"]], "v1.0.4 - April, 3 2024": [[131, "v1-0-4-april-3-2024"]], "v1.1.0 - April, 18 2024": [[131, "v1-1-0-april-18-2024"]], "v1.10.0 - December 10, 2024": [[131, "v1-10-0-december-10-2024"]], "v1.11.0 - January 9, 2025": [[131, "v1-11-0-january-9-2025"]], "v1.2.0 - April 25, 2024": [[131, "v1-2-0-april-25-2024"]], "v1.3.0 - May 10, 2024": [[131, "v1-3-0-may-10-2024"]], "v1.3.1 - May 23, 2024": [[131, "v1-3-1-may-23-2024"]], "v1.4.0 - June 13, 2024": [[131, "v1-4-0-june-13-2024"]], "v1.4.1 - July 2, 2024": [[131, "v1-4-1-july-2-2024"]], "v1.4.2 - July 9, 2024": [[131, "v1-4-2-july-9-2024"]], "v1.4.3 - July 10, 2024": [[131, "v1-4-3-july-10-2024"]], "v1.5.0 - July 12, 2024": [[131, "v1-5-0-july-12-2024"]], "v1.6.0 - July 29, 2024": [[131, "v1-6-0-july-29-2024"]], "v1.6.1 - July 31, 2024": [[131, "v1-6-1-july-31-2024"]], "v1.6.2 - August 6, 2024": [[131, "v1-6-2-august-6-2024"]], "v1.6.3 - September 5, 2024": [[131, "v1-6-3-september-5-2024"]], "v1.7.0 - September 20, 2024": [[131, "v1-7-0-september-20-2024"]], "v1.7.1 - September 20, 2024": [[131, "v1-7-1-september-20-2024"]], "v1.7.2 - October 16, 2024": [[131, "v1-7-2-october-16-2024"]], "v1.8.0 - November 19, 2024": [[131, "v1-8-0-november-19-2024"]], "v1.9.0 - December 4, 2024": [[131, "v1-9-0-december-4-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.server.docker.SingleStoreDB.connect", "generated/singlestoredb.server.docker.SingleStoreDB.connect_kai", "generated/singlestoredb.server.docker.SingleStoreDB.connection_url", "generated/singlestoredb.server.docker.SingleStoreDB.http_connection_url", "generated/singlestoredb.server.docker.SingleStoreDB.kai_url", "generated/singlestoredb.server.docker.SingleStoreDB.logs", "generated/singlestoredb.server.docker.SingleStoreDB.open_mongosh", "generated/singlestoredb.server.docker.SingleStoreDB.open_shell", "generated/singlestoredb.server.docker.SingleStoreDB.open_studio", "generated/singlestoredb.server.docker.SingleStoreDB.stop", "generated/singlestoredb.server.docker.SingleStoreDB.studio_url", "generated/singlestoredb.server.docker.start", "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.server.docker.SingleStoreDB.connect.rst", "generated/singlestoredb.server.docker.SingleStoreDB.connect_kai.rst", "generated/singlestoredb.server.docker.SingleStoreDB.connection_url.rst", "generated/singlestoredb.server.docker.SingleStoreDB.http_connection_url.rst", "generated/singlestoredb.server.docker.SingleStoreDB.kai_url.rst", "generated/singlestoredb.server.docker.SingleStoreDB.logs.rst", "generated/singlestoredb.server.docker.SingleStoreDB.open_mongosh.rst", "generated/singlestoredb.server.docker.SingleStoreDB.open_shell.rst", "generated/singlestoredb.server.docker.SingleStoreDB.open_studio.rst", "generated/singlestoredb.server.docker.SingleStoreDB.stop.rst", "generated/singlestoredb.server.docker.SingleStoreDB.studio_url.rst", "generated/singlestoredb.server.docker.start.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.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]], "connect() (singlestoredb.server.docker.singlestoredb method)": [[114, "singlestoredb.server.docker.SingleStoreDB.connect", false]], "connect_kai() (singlestoredb.server.docker.singlestoredb method)": [[115, "singlestoredb.server.docker.SingleStoreDB.connect_kai", false]], "connection (class in singlestoredb.connection)": [[3, "singlestoredb.connection.Connection", false]], "connection_url (singlestoredb.server.docker.singlestoredb property)": [[116, "singlestoredb.server.docker.SingleStoreDB.connection_url", 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]], "http_connection_url (singlestoredb.server.docker.singlestoredb property)": [[117, "singlestoredb.server.docker.SingleStoreDB.http_connection_url", 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]], "kai_url (singlestoredb.server.docker.singlestoredb property)": [[118, "singlestoredb.server.docker.SingleStoreDB.kai_url", false]], "listdir() (singlestoredb.management.workspace.stage method)": [[65, "singlestoredb.management.workspace.Stage.listdir", false]], "logs() (singlestoredb.server.docker.singlestoredb method)": [[119, "singlestoredb.server.docker.SingleStoreDB.logs", 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]], "open_mongosh() (singlestoredb.server.docker.singlestoredb method)": [[120, "singlestoredb.server.docker.SingleStoreDB.open_mongosh", false]], "open_shell() (singlestoredb.server.docker.singlestoredb method)": [[121, "singlestoredb.server.docker.SingleStoreDB.open_shell", false]], "open_studio() (singlestoredb.server.docker.singlestoredb method)": [[122, "singlestoredb.server.docker.SingleStoreDB.open_studio", 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)": [[126, "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 (in module singlestoredb.management.workspace)": [[74, "singlestoredb.management.workspace.StageObject", false]], "start() (in module singlestoredb.server.docker)": [[125, "singlestoredb.server.docker.start", false]], "status() (singlestoredb.connection.showaccessor method)": [[48, "singlestoredb.connection.ShowAccessor.status", false]], "stop() (singlestoredb.server.docker.singlestoredb method)": [[123, "singlestoredb.server.docker.SingleStoreDB.stop", false]], "studio_url (singlestoredb.server.docker.singlestoredb property)": [[124, "singlestoredb.server.docker.SingleStoreDB.studio_url", 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"], [126, 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, 4, 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": [[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, 5, 1, "", "stage"], [98, 3, 1, "", "terminate"], [99, 3, 1, "", "update"], [100, 5, 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, 5, 1, "", "organization"], [107, 3, 1, "", "regions"], [108, 5, 1, "", "workspace_groups"]], "singlestoredb.notebook": [[109, 6, 1, "", "organization"], [110, 6, 1, "", "secrets"], [111, 6, 1, "", "stage"], [112, 6, 1, "", "workspace"], [113, 6, 1, "", "workspace_group"]], "singlestoredb.server.docker": [[125, 1, 1, "", "start"]], "singlestoredb.server.docker.SingleStoreDB": [[114, 3, 1, "", "connect"], [115, 3, 1, "", "connect_kai"], [116, 5, 1, "", "connection_url"], [117, 5, 1, "", "http_connection_url"], [118, 5, 1, "", "kai_url"], [119, 3, 1, "", "logs"], [120, 3, 1, "", "open_mongosh"], [121, 3, 1, "", "open_shell"], [122, 3, 1, "", "open_studio"], [123, 3, 1, "", "stop"], [124, 5, 1, "", "studio_url"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"], "5": ["py", "property", "Python property"], "6": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute", "5": "py:property", "6": "py:data"}, "terms": {"": [0, 1, 2, 15, 16, 93, 95, 102, 127, 128, 130], "0": [2, 99, 103, 127, 128, 130], "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, 127, 128, 130], "10": [2, 52, 92, 95, 98, 102, 127, 128], "100": [15, 16, 18], "11": [127, 128], "12": [127, 128], "13": [127, 128], "14": 128, "15": 128, "16": 128, "17": 128, "18": 128, "19": 128, "2": [0, 2, 93, 95, 102, 127, 128, 130], "20": 128, "200": 16, "2004": 130, "2021": [99, 103, 130], "2022": 128, "2023": 128, "2024": 128, "2025": 128, "21": 128, "23": [99, 103, 128], "24": 128, "25": 128, "26": 128, "28": 128, "29": 128, "3": [0, 127, 128], "300": 16, "31": 128, "31536000": 2, "32": 131, "3306": 2, "3h30m": [99, 103], "4": [0, 93, 95, 102, 127, 128], "427b": 109, "443": 2, "5": [0, 127, 128], "50": 130, "6": [99, 103, 127, 128], "60": 1, "600": [92, 95, 98, 102, 127], "682e": 109, "7": [127, 128], "8": [127, 128], "80": 2, "8080": 2, "9": [127, 128, 130], "A": [127, 130], "AND": 130, "AS": 130, "As": 127, "At": [99, 103], "By": [2, 127], "FOR": 130, "For": 130, "If": [0, 1, 9, 13, 17, 18, 21, 22, 73, 92, 93, 95, 98, 99, 102, 103, 127, 130], "In": [0, 127, 130], "It": [0, 57, 58, 89, 93, 94, 95, 102, 109, 111, 112, 113, 128], "Not": 130, "OF": 130, "ON": 127, "OR": 130, "The": [0, 1, 2, 9, 12, 13, 15, 16, 22, 53, 55, 56, 67, 84, 87, 93, 99, 101, 102, 103, 126, 127, 128, 129, 130], "These": 0, "To": [0, 2, 54, 73, 130], "WITH": 131, "__init__": [3, 12, 52, 57, 58, 89, 94, 101], "_connector_nam": 2, "_object": [110, 111], "a6cc": 109, "aarch64": 131, "abil": 131, "abl": 127, "about": [0, 44, 62], "abov": [0, 130], "absolut": 23, "abstract": [5, 6, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 22, 23, 24, 25], "accept": 130, "access": [0, 13, 52, 56, 89, 94, 101, 110, 112, 113], "access_token": [56, 101], "accessor": 131, "account": 0, "act": [0, 130], "activ": [95, 98, 102], "ad": [67, 84, 131], "add": [130, 131], "add_endpoint_to_firewall_rang": 131, "addendum": 130, "addit": [0, 2, 114, 128, 130], "additon": 127, "address": [2, 127], "admin": [99, 103], "admin_password": [99, 103], "advis": 130, "affect": [15, 16], "after": 0, "against": [16, 130], "aggreg": 28, "agre": 130, "agreement": 130, "ai": 131, "alia": 74, "all": [0, 17, 26, 34, 36, 38, 40, 42, 43, 54, 73, 93, 99, 103, 127, 130, 131], "alleg": 130, "allow": [0, 2, 9, 99, 103], "allow_all_traff": [94, 99, 103], "alon": 130, "along": 130, "alongsid": 130, "alreadi": [66, 70, 72, 73, 87], "also": [0, 2, 52, 127, 128, 130], "amazon": 103, "amount": 127, "an": [0, 2, 22, 53, 55, 59, 60, 72, 78, 95, 99, 102, 103, 125, 126, 127, 130, 131], "ani": [0, 1, 2, 3, 13, 15, 16, 17, 18, 19, 21, 52, 53, 54, 55, 89, 90, 93, 95, 102, 114, 125, 126, 130], "annot": 130, "anoth": 22, "apach": 130, "api": [2, 8, 9, 56, 57, 89, 94, 101, 109, 112, 113, 114, 125, 128], "app": 131, "appear": 130, "appendix": 130, "appli": [93, 130], "applic": [130, 131], "appropri": 130, "april": 128, "ar": [0, 2, 3, 17, 18, 19, 52, 53, 67, 73, 84, 89, 90, 94, 99, 103, 112, 113, 127, 130, 131], "arbitrari": 126, "archiv": 130, "area": 24, "arg": [15, 16, 52, 53, 126], "arg1": 13, "arg2": 13, "argument": [90, 114, 126], "aris": 130, "arrai": 131, "arrays": 18, "arrow": [2, 131], "assert": 130, "associ": [93, 95, 102, 103, 130], "assum": 130, "async": 131, "attach": 130, "attribut": [0, 2, 3, 12, 18, 52, 57, 89, 94, 101, 110, 130], "august": 128, "auth": [2, 128, 131], "authent": [1, 2, 56, 131], "author": [2, 130], "authorship": 130, "auto": [93, 95, 102, 127], "auto_attach": 127, "auto_increment_incr": 127, "auto_increment_offset": 127, "auto_profile_typ": 127, "auto_repl": 127, "auto_suspend": [89, 93, 95, 102], "autocommit": [2, 127, 131], "automat": [0, 2, 127, 131], "autostats_flush_interval_sec": 127, "avail": [0, 22, 100, 107, 108, 130], "aw": 103, "b": [67, 84], "back": 127, "backup": 103, "backup_bucket_kms_key_id": 103, "bar": 127, "base": [56, 101, 130, 131], "base_url": [56, 101], "basi": 130, "batch": 127, "been": [2, 127, 130], "befor": [1, 92, 95, 98, 102, 131], "behalf": 130, "behavior": 2, "being": [1, 127], "below": [0, 2, 127, 130], "benefici": 130, "better": 127, "between": [92, 95, 98, 102], "binari": [2, 67, 84, 131], "binaryio": 72, "bind": 130, "bit": 131, "blob": 131, "block": [0, 103], "boilerpl": 130, "bool": [0, 2, 4, 10, 20, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 61, 63, 64, 65, 66, 70, 72, 73, 78, 79, 82, 83, 87, 92, 94, 95, 98, 99, 102, 103, 114, 125], "boolean": 131, "bracket": 130, "break": [18, 19], "browser": [0, 1, 52, 122], "browser_sso": 2, "bson": 2, "bucket": 103, "buffer": [2, 25], "builtin": 131, "byte": [15, 59, 78], "bytesio": [67, 84], "c": 131, "cach": [93, 95, 102, 131], "cache_config": [89, 93, 95, 102], "calcul": 131, "call": [0, 3, 12, 13, 22, 53, 57, 89, 94, 109, 112, 113, 127, 131], "callabl": 2, "can": [0, 1, 2, 13, 15, 16, 52, 53, 67, 84, 93, 95, 99, 102, 103, 127, 129], "cannot": 130, "carri": 130, "caus": 130, "certif": 2, "chang": [127, 128, 130], "charact": [2, 130, 131], "charg": 130, "charset": 2, "check": [92, 98], "choic": 127, "choos": 130, "chrome": 1, "chromium": 1, "cidr": [99, 103], "cipher": [2, 131], "claim": 130, "class": [3, 12, 52, 57, 58, 89, 94, 101, 130], "client": [127, 129], "client_found_row": [2, 131], "cloud": [0, 109, 128, 131], "cluster": [1, 57, 131], "cmek": 103, "code": [0, 2, 15, 16, 28, 29, 30, 31, 32, 45, 53, 130, 131], "column": [0, 25, 52, 127], "com": [1, 2], "combin": 130, "command": [0, 12, 131], "comment": 130, "commerci": 130, "common": 130, "commun": 130, "compat": [1, 22, 131], "compil": [42, 130], "compli": 130, "complianc": 130, "compliant": [0, 128, 131], "comput": [127, 130], "condit": 130, "configur": [93, 95, 102, 128, 130, 131], "conn": [0, 2, 52, 127], "conn_attr": 2, "connect": [1, 115, 116, 117, 118, 125, 128, 131], "connect_kai": 128, "connect_timeout": [2, 131], "connection_url": 128, "connector": [2, 128], "consecut": 126, "consequenti": 130, "consid": 131, "consist": 130, "conspicu": 130, "constitut": 130, "constru": 130, "constructor": 52, "consum": 2, "contain": [0, 2, 125, 130], "content": [59, 73, 78, 130], "context": [0, 2], "continu": 103, "contract": 130, "contribut": 130, "contributor": 130, "contributori": 130, "control": [2, 130], "conv": 2, "convers": [2, 130, 131], "convert": [59, 78, 131], "copi": 130, "copyright": 130, "correspond": 0, "counterclaim": 130, "creat": [0, 3, 7, 53, 66, 67, 84, 89, 90, 94, 95, 102, 103, 112, 113], "create_engin": [0, 128, 131], "create_workspac": [0, 89, 112, 131], "create_workspace_group": [94, 113], "created_at": [89, 94], "creation": [28, 29, 30, 31, 32, 80], "credenti": [2, 127], "credential_typ": 2, "cross": 130, "cur": [0, 2, 13, 15, 16, 17, 18, 19, 127], "current": [0, 9, 26, 33, 36, 37, 39, 40, 43, 44, 49, 50, 91, 96, 106], "cursor": [2, 127, 128], "custom": 103, "customari": 130, "dai": [99, 103], "damag": 130, "dashboard": 131, "data": [2, 8, 9, 15, 45, 52, 59, 67, 78, 84, 99, 103, 114, 125, 127, 131], "data_api_port": 125, "data_bucket_kms_key_id": 103, "data_dir": 125, "databas": [0, 1, 2, 5, 10, 12, 26, 33, 36, 39, 40, 43, 49, 50, 90, 125, 127, 128, 131], "datafram": [17, 18, 19, 21], "date": 130, "datetim": [80, 81, 89, 94], "db": [0, 128, 131], "db_name": 2, "dbt": 2, "debug": 131, "decemb": 128, "decod": 2, "default": [0, 1, 2, 67, 84, 125, 131], "defend": 130, "defer": 131, "defin": [0, 2, 127, 130], "definit": [3, 89, 93, 94, 99, 104, 105, 112, 113, 130], "delet": [68, 69, 71, 85, 86, 88], "deliber": 130, "depend": 127, "deploi": 103, "deploy": 93, "deployment_id": 58, "deployment_typ": [89, 93], "deprec": 2, "deriv": 130, "describ": [2, 127, 130, 131], "describe_opt": [0, 128], "descript": [54, 130], "design": 130, "destroi": 0, "detail": 44, "determin": [10, 130], "dev": 125, "dict": [2, 15, 16, 17, 18, 19, 21, 89, 93, 95, 99, 102, 103, 125, 126, 127], "dictionari": [0, 2, 15, 16, 52, 131], "differ": 130, "direct": 130, "directli": [3, 12, 57, 58, 89, 94, 109, 111, 112, 113], "directori": [60, 63, 66, 73, 77, 82, 86, 88, 125], "disabl": [2, 8, 93], "disable_data_api": 9, "disast": 103, "disclaim": 130, "discuss": [0, 130], "displai": [0, 52, 130], "distribut": 130, "do": [0, 130], "doc": 131, "docker": [0, 128], "document": [0, 127, 130, 131], "doe": [2, 61, 79, 130, 131], "don": 130, "done": 127, "down": 0, "download": [0, 59, 60], "driver": [2, 131], "dummi": 131, "durat": [99, 103], "e": 22, "each": [1, 92, 95, 98, 102, 127, 130, 131], "eas": 127, "easier": 130, "eb": 103, "editori": 130, "egress": 131, "either": [0, 52, 89, 94, 112, 113, 127, 130], "elabor": 130, "elast": 103, "electron": 130, "element": [0, 127], "email": 1, "empti": [22, 88, 99, 103], "enabl": [2, 9, 93, 95, 102, 103, 125], "enable_data_api": 8, "enable_extended_data_typ": 2, "enable_kai": [95, 102, 125], "enclos": 130, "encod": [59, 67, 78, 84, 131], "encoding_error": [2, 131], "encrypt": 103, "end": 130, "endpoint": 89, "engin": [0, 1, 53, 131], "enhanc": 131, "enough": 127, "ensur": 103, "entir": [2, 127], "entiti": 130, "entri": 0, "environ": [0, 2, 53, 131], "equal": 127, "error": [2, 131], "escap": [127, 131], "establish": 127, "etc": [1, 95, 102, 127], "evalu": 131, "even": [92, 98, 130], "event": [130, 131], "exampl": [0, 2, 13, 15, 16, 17, 18, 19, 52, 73, 99, 103, 127, 130], "except": [90, 95, 102, 130], "exclud": 130, "exclus": 130, "execut": [0, 2, 16, 42, 54, 128, 130], "exercis": 130, "exist": [21, 59, 60, 66, 70, 72, 73, 78, 87, 89, 94, 112, 113, 131], "exit": 0, "expect": [22, 127], "experiment": 131, "expir": [99, 103, 131], "expires_at": [99, 103], "explicitli": [0, 130], "export": 131, "express": 130, "extend": [2, 30, 34, 39, 48, 50], "extens": 131, "extern": 131, "f01b669ed0b6": 109, "fa9edd92": 109, "failur": 130, "fairli": 127, "fals": [0, 22, 27, 30, 34, 39, 41, 48, 50, 59, 60, 65, 66, 70, 72, 73, 78, 87, 92, 95, 98, 102, 114, 125], "featur": [103, 131], "februari": 128, "fee": 130, "fetch": [17, 18, 19, 25, 128], "fetchal": [13, 127], "fetchmani": [13, 127], "fetchon": [13, 127], "field": [95, 102, 130, 131], "fifti": 130, "file": [0, 2, 59, 60, 64, 65, 67, 70, 72, 73, 78, 79, 83, 84, 85, 87, 125, 130, 131], "filesobject": [62, 66, 70, 72, 73, 74], "filesobjectbytesread": [67, 84], "filesobjectbyteswrit": [67, 84], "filesobjecttextread": [67, 84], "filesobjecttextwrit": [67, 84], "fine": 127, "firefox": 1, "firewall_rang": [94, 99, 103], "first": [67, 84], "fit": 130, "fix": 131, "float": [80, 81], "folder": [60, 65, 66, 69, 71, 73, 79], "follow": [0, 67, 84, 93, 95, 102, 127, 130], "foo": 127, "forc": [92, 98], "form": [0, 2, 130], "format": [2, 15, 16, 127, 130, 131], "frame": 52, "free": 130, "from": [0, 1, 15, 16, 18, 19, 21, 23, 103, 127, 130, 131], "full": [2, 27, 75, 127], "function": [0, 2, 3, 26, 28, 29, 53, 54, 90, 127, 131], "fusion": 131, "gener": [1, 13, 45, 99, 103, 130], "geographi": 131, "get": [0, 2, 55, 128], "get_jwt": [128, 131], "get_opt": 128, "get_secret": 131, "get_token": 131, "get_workspac": [89, 112], "get_workspace_group": [0, 94, 113], "ghcr": 125, "give": [0, 92, 98, 130], "given": [27, 28, 29, 30, 31, 32, 38, 41, 61, 63, 64, 65, 127], "glob": 73, "global": [9, 37, 125], "global_var": 125, "go": [92, 98], "goodwil": 130, "googl": 1, "govern": 130, "grant": 130, "grossli": 130, "group": [0, 92, 93, 94, 98, 99, 103, 105, 108, 113, 131], "gssapi": 131, "ha": [2, 92, 98, 127, 130, 131], "handler": [2, 131], "harmless": 130, "have": [0, 93, 95, 99, 102, 103, 127, 130], "help": 131, "here": [53, 127], "herebi": 130, "herein": 130, "high": 131, "hold": 130, "host": [2, 90, 127], "hostnam": [2, 125, 127], "hour": [99, 103], "how": 130, "howev": [53, 127, 130], "http": [1, 2, 9, 117, 127, 130, 131], "http_connection_url": 128, "http_proxy_port": 9, "i": [0, 1, 2, 9, 10, 18, 19, 20, 22, 52, 57, 58, 59, 63, 64, 82, 83, 89, 92, 94, 95, 98, 99, 102, 103, 109, 111, 112, 113, 127, 128, 130, 131], "iceberg": 131, "id": [15, 16, 41, 56, 57, 94, 102, 103, 104, 105, 109, 131], "idea": 127, "ident": 2, "identif": 130, "identifi": 130, "idl": 93, "ignor": 73, "ii": 130, "iii": 130, "imag": 125, "impli": 130, "import": [0, 127, 130], "improv": [130, 131], "inabl": 130, "inbound": [99, 103], "incident": 130, "includ": [0, 1, 2, 73, 128, 130, 131], "include_root": 73, "inclus": 130, "incorpor": 130, "incur": 130, "indemn": 130, "indemnifi": 130, "index": 131, "indic": [2, 99, 103, 130], "indirect": 130, "individu": 130, "inf": 2, "inf_as_nul": [2, 131], "infil": [15, 131], "infile_stream": 15, "info": 0, "inform": [0, 27, 47, 48, 49, 57, 62, 130], "infring": 130, "inherit": 53, "init_sql": 125, "instal": [0, 128], "instanc": [0, 3], "instanti": [12, 57, 58, 89, 94, 101, 109, 111, 112, 113], "instead": [1, 3, 12, 57], "institut": 130, "int": [1, 2, 9, 15, 16, 18, 23, 24, 25, 41, 89, 92, 93, 95, 98, 99, 102, 103, 125], "integ": 127, "intention": 130, "interact": [0, 131], "interfac": [0, 128, 130, 131], "interv": [95, 102], "io": [15, 125], "ip": [2, 127], "irrevoc": 130, "issu": [130, 131], "iter": [13, 15, 16, 21, 127, 131], "its": 130, "itself": [0, 73, 127], "januari": [128, 130], "javascript": 131, "job": 131, "json": [2, 41, 131], "jsonwebtoken": 1, "juli": 128, "june": 128, "jupysql": 0, "just": 0, "jwt": [1, 2, 56, 131], "kai": [95, 102, 115, 118, 125], "kai_port": 125, "kai_url": 128, "kei": [0, 2, 15, 16, 52, 54, 55, 56, 101, 103, 125, 127, 131], "kerbero": 131, "keyword": [2, 52, 90, 114, 126, 127], "kind": 130, "km": 103, "kwarg": [3, 52, 53, 54, 90, 114, 126], "lab": 125, "languag": 130, "larg": [25, 127], "last": 81, "last_resumed_at": 89, "latest": 125, "launchpad": 109, "law": 130, "lawsuit": 130, "leak": 131, "least": 130, "left": 2, "legal": 130, "len": 18, "length": 131, "liabil": 130, "liabl": 130, "licens": [125, 128], "licensor": 130, "like": [0, 13, 52, 72, 127], "limit": 130, "line": 0, "link": 130, "linux": 131, "list": [1, 2, 15, 16, 17, 18, 19, 21, 52, 65, 73, 89, 94, 99, 100, 103, 107, 108, 119, 127, 130], "lite": 127, "litig": 130, "load": 0, "local": [0, 2, 15, 59, 60, 72, 73, 78, 131], "local_infil": [0, 2, 127], "local_path": [59, 60, 72, 73, 78], "locat": [1, 59, 60, 62, 65, 68, 69, 70, 71, 78, 87], "log": [125, 128, 131], "logs_dir": 125, "loss": 130, "lost": [99, 103], "machin": 0, "made": [127, 130], "magic": [0, 131], "mai": [127, 128, 130], "mail": 130, "make": [66, 130, 131], "malfunct": 130, "manag": [2, 56, 111, 125, 128, 130, 131], "manage_workspac": [0, 101, 128], "managementerror": [92, 98], "managemnt": 131, "map": 127, "march": 128, "mark": 130, "max": [2, 15, 16], "maximum": [95, 102], "me": 2, "mean": 130, "mechan": 130, "media": 130, "medium": 130, "meet": 130, "memori": [2, 24, 127, 131], "merchant": 130, "mere": 130, "meth": 0, "method": [0, 3, 9, 12, 22, 52, 57, 58, 89, 94, 101, 127], "min": 2, "minimum": 131, "mkdir": 0, "mode": [2, 4, 23, 67, 84, 92, 93, 98], "model": 131, "modif": 130, "modifi": [81, 130], "modul": [0, 1, 131], "mongocli": 115, "mongodb": [115, 118, 125], "mongosh": 120, "more": [2, 21, 22, 54, 130, 131], "mostli": 127, "move": [23, 70, 87], "multi_stat": [2, 131], "multipl": [2, 13, 16, 22], "multipli": [93, 95, 102], "must": [22, 127, 130], "my_db": 2, "myprocedur": 13, "mysoldb": 22, "mysql": [2, 127], "mytabl": [15, 16], "name": [1, 2, 13, 28, 29, 30, 31, 32, 54, 55, 57, 73, 77, 89, 94, 95, 99, 102, 103, 109, 125, 126, 130, 131], "namedlist": [100, 108], "namedtupl": [2, 127, 131], "nan": 2, "nan_as_nul": [2, 131], "ndarrai": [17, 18, 19, 21], "necessarili": 130, "need": 131, "neglig": 130, "nest": 73, "new": [0, 7, 67, 70, 84, 87, 95, 102, 103, 128], "new_path": [70, 87], "next": 22, "nextset": 13, "non": [2, 130, 131], "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, 78, 84, 85, 86, 87, 88, 89, 92, 93, 94, 95, 98, 99, 101, 102, 103, 118, 120, 121, 122, 123, 125, 126], "normal": 130, "notat": [93, 95, 102], "note": 1, "notebook": [128, 131], "noth": 130, "notic": 130, "notwithstand": 130, "novemb": 128, "now": 131, "np": [17, 18, 19, 21], "null": 2, "number": [1, 9, 15, 16, 22, 92, 95, 98, 102, 127], "numer": 131, "numpi": [2, 131], "o": 2, "object": [0, 3, 7, 12, 52, 57, 58, 61, 63, 64, 72, 75, 76, 77, 82, 83, 89, 90, 91, 94, 96, 109, 110, 111, 112, 113, 128, 130, 131], "oblig": 130, "obtain": 130, "octob": 128, "off": [2, 127], "offer": 130, "old_path": 70, "onc": [22, 127], "one": [1, 54, 67, 84, 93, 95, 102, 127, 130], "ones": 0, "onli": [73, 103, 130], "open": [0, 72, 120, 121, 122], "open_mongosh": 128, "open_shel": 128, "open_studio": 128, "oper": 0, "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, 125, 126, 127, 131], "order": 53, "org": 130, "organ": [0, 56, 128], "organization_id": [56, 101], "origin": [70, 130], "other": [13, 22, 56, 101, 127, 130], "otherwis": 130, "out": [0, 1, 18, 130], "outfil": 45, "outlin": 131, "output": 0, "outstand": 130, "over": 127, "overal": 2, "overwrit": [59, 60, 66, 70, 72, 73, 78, 87], "overwritten": [59, 60, 66, 70, 72, 73, 78, 87], "own": 130, "owner": 130, "ownership": 130, "p455w0rd": 2, "pa": [17, 18, 19, 21], "packag": [0, 127, 131], "packet": 131, "page": 130, "pair": 126, "panda": [2, 131], "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, 125, 126, 128, 131], "paramt": [15, 16], "pars": 131, "parse_json": 2, "part": 130, "parti": 130, "particular": 130, "pass": [114, 127], "password": [2, 99, 103, 125, 127, 131], "patent": 130, "path": [2, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 75, 78, 84, 87, 125], "pathlik": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 78, 87], "pattern": [73, 127], "pd": [17, 18, 19, 21], "pend": [6, 11], "per": 127, "percent": 130, "perform": [130, 131], "permiss": 130, "perpetu": 130, "persist": [93, 95, 102], "person": 131, "pertain": 130, "pip": 129, "pipelin": 30, "pl": [17, 18, 19, 21], "place": 130, "plan_id": 41, "plugin": 131, "point": [0, 131], "polar": [2, 131], "poll": [95, 102], "port": [2, 9, 90, 125, 127], "portal": [0, 1, 109, 131], "posit": [23, 131], "possibl": [0, 127, 130], "power": 130, "pre": 131, "predefin": 24, "prefer": 130, "prepar": 130, "previou": 0, "primari": [0, 103], "primarili": [0, 52], "print": [0, 13, 17, 18, 19, 54, 127, 130], "privileg": 9, "procedur": [13, 22], "process": 0, "product": [130, 131], "program": 2, "program_nam": 2, "program_vers": 2, "promin": 130, "propag": 131, "properti": [97, 100, 106, 108, 116, 117, 118, 124], "protocol": 2, "provid": [57, 95, 102, 130], "proxi": [0, 9], "publicli": 130, "pure": [2, 131], "pure_python": 2, "purg": 131, "purpos": 130, "put": 127, "pyc": 73, "pyformat": [15, 16], "pygeo": 131, "pymongo": 115, "pymysql": [22, 131], "pytest": 131, "python": [0, 1, 2, 53, 127, 129, 131], "queri": [0, 2, 12, 13, 15, 16, 42, 45, 128, 131], "queue": [15, 131], "quot": 127, "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, 131], "readabl": 130, "reason": 130, "receiv": 130, "recipi": 130, "recommend": 130, "recoveri": 103, "recurs": [65, 69, 73, 86], "redistribut": 130, "refactor": 131, "refer": 128, "regard": 130, "region": [94, 103, 128, 131], "rel": 23, "releas": 131, "remain": [17, 18, 19, 130], "renam": [0, 2, 131], "replac": [127, 130], "replic": 103, "repres": 130, "reproduc": 130, "reproduct": 130, "request": [1, 99, 103], "requir": [9, 127, 130, 131], "respect": 127, "respons": [99, 103, 130], "result": [0, 2, 13, 17, 18, 19, 21, 22, 23, 52, 57, 59, 78, 89, 94, 109, 112, 113, 128, 130, 131], "results_format": [2, 131], "results_typ": [2, 127, 131], "resum": 131, "resume_attach": 89, "retain": [22, 130], "retriev": [0, 1, 13, 56, 104, 105, 127, 131], "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, 114, 127, 131], "revis": 130, "right": 130, "risk": 130, "root": [73, 125], "root_password": 125, "routin": 131, "row": [15, 16, 17, 18, 19, 21, 127], "royalti": 130, "rt": [67, 84], "rule": 131, "run": [0, 9, 44, 125], "run_person": 131, "run_shar": 131, "s2": [0, 2, 127], "s2db": [0, 109], "safari": 1, "same": [53, 127, 130], "scaling_progress": 89, "schedul": [93, 131], "scheme": 2, "screen": 0, "sdk": 0, "seamless": 103, "second": [1, 2, 92, 95, 98, 102], "secondari": 103, "secret": [0, 128, 131], "section": [127, 130], "see": [0, 3, 130], "seen": 127, "select": [0, 15, 16], "sell": 130, "send": 52, "sent": 130, "separ": [130, 131], "septemb": 128, "sequenc": [13, 15, 16, 24], "server": [2, 9, 34, 37, 46, 47, 48, 90, 92, 98, 127, 128, 131], "server_dir": 125, "server_port": 125, "servic": [0, 130, 131], "session": [2, 47], "set": [0, 2, 4, 9, 13, 16, 17, 19, 21, 22, 23, 25, 53, 95, 102, 125, 126, 127, 131], "set_opt": 128, "shall": 130, "shape": 131, "share": [130, 131], "shell": [0, 121], "should": [0, 2, 9, 12, 59, 60, 66, 70, 72, 73, 78, 87, 92, 101, 103, 130], "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, 127, 131], "shown": [0, 127], "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], "shut": 0, "sign": 1, "simpl": 52, "singl": [1, 2, 19, 127], "singlestor": [0, 1, 95, 102, 125, 128, 130], "singlestoredb": [0, 127, 129, 131], "singlestoredb_password": 2, "singlestoredb_url": [2, 131], "singlestoredb_us": 2, "singleton": 0, "sinlgestoredb": 0, "size": [18, 24, 25, 89, 93, 95, 102, 127], "skip": 22, "small": 127, "smaller": 127, "smart": 103, "smart_dr": 103, "smartdr": 103, "so": 0, "softwar": 130, "sole": 130, "solut": 103, "sourc": [130, 131], "special": [130, 131], "specif": 130, "specifi": [0, 1, 2, 9, 18, 67, 84, 93, 95, 99, 102, 103, 128, 131], "sql": [0, 15, 16, 125, 131], "sqlalchemi": [0, 53, 127, 131], "ssl": 2, "ssl_ca": 2, "ssl_cert": 2, "ssl_cipher": [2, 131], "ssl_disabl": 2, "ssl_kei": 2, "ssl_verify_cert": [2, 131], "ssl_verify_ident": [2, 131], "sso": 1, "stage": [128, 131], "stage_path": [59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 71, 72, 73], "stageobject": 128, "standard": 2, "start": [0, 9, 128], "starterworkspac": [58, 111], "startup": 125, "state": [89, 91, 96, 130], "statement": [2, 15, 16, 42, 130, 131], "statu": [33, 37, 47, 49, 52], "still": [10, 20], "stop": [0, 128], "stopiter": 21, "stoppag": 130, "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, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 75, 76, 77, 78, 84, 87, 89, 93, 94, 95, 99, 101, 102, 103, 104, 105, 116, 117, 118, 119, 124, 125, 126], "strain": 127, "stream": 15, "string": [0, 2, 54, 67, 84, 127, 131], "stringio": [67, 84], "structsequ": 131, "structur": 127, "studio": [0, 122, 124, 125], "studio_port": 125, "studio_url": 128, "style": [15, 16], "sub": 0, "subject": 130, "sublicens": 130, "submiss": 130, "submit": [12, 130], "subsequ": [13, 130], "substit": 127, "substitut": [2, 15, 16, 128], "supersed": 130, "suppli": [90, 99, 103], "support": [67, 84, 103, 130, 131], "suspend": [93, 95, 102, 131], "syntax": [0, 52, 130, 131], "system": 130, "t": [67, 84, 130], "tabl": [17, 18, 19, 21, 27, 31, 38, 49], "taken": 53, "target": [59, 60, 73, 78], "telemetri": 2, "term": 130, "termin": [52, 99, 103, 130], "terminated_at": [89, 94], "test": 131, "text": [67, 84, 130], "textio": 72, "textiobas": 15, "than": [3, 22], "thei": [0, 60, 127], "them": 3, "theori": 130, "thereof": 130, "thi": [0, 1, 2, 3, 9, 12, 22, 52, 53, 54, 57, 58, 89, 90, 94, 95, 101, 102, 103, 109, 111, 112, 113, 127, 130, 131], "third": 130, "those": 130, "thread": 44, "three": 127, "through": [0, 3, 130], "time": [1, 99, 103], "timeout": [1, 2, 92, 98, 131], "timestamp": [80, 81, 99, 103], "titl": 130, "tls_sni_servernam": [2, 131], "token": [1, 56, 101], "tool": 128, "top": 73, "tort": 130, "total": [92, 98], "track": [0, 2, 130, 131], "track_env": [2, 131], "trade": 130, "trademark": 130, "traffic": [99, 103], "transact": [6, 11], "transfer": 130, "transform": 130, "transit": 127, "translat": 130, "treat": [2, 52], "tree": 73, "tri": 1, "troubleshoot": 45, "true": [0, 2, 4, 18, 19, 22, 73, 95, 102, 127, 131], "truncat": [67, 84], "tupl": [2, 17, 18, 19, 21, 126], "two": 127, "type": [1, 2, 7, 9, 10, 15, 16, 18, 19, 21, 53, 55, 56, 61, 62, 63, 64, 65, 66, 67, 78, 84, 90, 93, 95, 102, 103, 104, 105, 114, 128, 130, 131], "typic": [2, 3], "udf": 131, "unbuff": 131, "under": 130, "underli": 52, "union": 130, "unix": [80, 81], "unless": [2, 130], "until": [1, 22], "up": [92, 98], "updat": [91, 96, 103, 131], "update_window": [99, 103], "upload": [2, 72, 73, 131], "upload_fil": 0, "upload_fold": 0, "url": [0, 1, 2, 56, 101, 116, 117, 118, 124, 128, 131], "us": [0, 1, 2, 9, 12, 13, 15, 16, 18, 21, 22, 52, 56, 57, 59, 67, 73, 78, 84, 89, 94, 101, 109, 112, 113, 114, 125, 128, 129, 130, 131], "usag": 2, "use_data_api": 114, "user": [1, 2, 127], "usernam": 2, "utf8": 2, "util": 128, "v0": [127, 128], "v1": 128, "valu": [0, 1, 2, 4, 9, 17, 18, 19, 21, 23, 52, 55, 93, 95, 102, 126, 127], "variabl": [0, 2, 9, 53, 125, 127, 131], "variable_nam": 127, "variou": [0, 131], "vector": [2, 131], "vector_data_format": [2, 131], "verbal": 130, "verifi": 2, "version": [56, 101, 130, 131], "view": 32, "volum": 103, "w": [67, 84], "wa": [1, 130], "wai": 127, "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": 130, "wb": [67, 84], "we": 130, "web": [0, 52, 122], "webbrows": 1, "well": [0, 127], "what": 128, "when": [0, 2, 15, 16, 22, 99, 103, 127], "where": [0, 15, 16, 23, 52, 103, 127, 130], "wherev": 130, "whether": [95, 102, 130], "which": [0, 2, 90, 127, 130], "while": [18, 19, 130, 131], "whole": 130, "whom": 130, "window": [99, 103, 131], "within": [0, 2, 93, 130], "without": [0, 53, 130], "work": [1, 127, 130], "workspac": [56, 113, 128, 131], "workspace_group": [0, 89, 94, 102, 128], "workspace_id": 89, "workspacegroup": [58, 89, 102, 103, 105, 108, 111, 128], "workspacemanag": [56, 57, 58, 89, 94, 109, 112, 113, 128], "worldwid": 130, "wrapper": 110, "write": [1, 67, 84, 130], "written": 130, "wt": [67, 84], "www": 130, "x": [67, 84], "xb": [67, 84], "xt": [67, 84], "you": [0, 2, 127, 130], "your": [0, 127, 130]}, "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.server.docker.SingleStoreDB.connect", "singlestoredb.server.docker.SingleStoreDB.connect_kai", "singlestoredb.server.docker.SingleStoreDB.connection_url", "singlestoredb.server.docker.SingleStoreDB.http_connection_url", "singlestoredb.server.docker.SingleStoreDB.kai_url", "singlestoredb.server.docker.SingleStoreDB.logs", "singlestoredb.server.docker.SingleStoreDB.open_mongosh", "singlestoredb.server.docker.SingleStoreDB.open_shell", "singlestoredb.server.docker.SingleStoreDB.open_studio", "singlestoredb.server.docker.SingleStoreDB.stop", "singlestoredb.server.docker.SingleStoreDB.studio_url", "singlestoredb.server.docker.start", "singlestoredb.set_option", "Getting Started", "SingleStoreDB Python SDK", "Installation", "License", "What\u2019s New"], "titleterms": {"": 131, "0": 131, "1": 131, "10": 131, "11": 131, "12": 131, "13": 131, "14": 131, "15": 131, "16": 131, "17": 131, "18": 131, "19": 131, "2": 131, "20": 131, "2022": 131, "2023": 131, "2024": 131, "2025": 131, "21": 131, "23": 131, "24": 131, "25": 131, "26": 131, "28": 131, "29": 131, "3": 131, "31": 131, "4": 131, "5": 131, "6": 131, "7": 131, "8": 131, "9": 131, "abspath": 75, "addit": 127, "aggreg": 26, "api": [0, 127, 131], "april": 131, "august": 131, "auth": 1, "autocommit": 4, "basenam": 76, "callproc": 13, "chang": 131, "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, 114, 127], "connect_kai": 115, "connection_url": 116, "content": 128, "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": 127, "decemb": 131, "default": 127, "describe_opt": 54, "dictionari": 127, "dirnam": 77, "disable_data_api": 8, "docker": [114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125], "download": 78, "download_fil": 59, "download_fold": 60, "enable_data_api": 9, "error": 35, "execut": [15, 127], "executemani": 16, "exist": [61, 79], "februari": 131, "fetch": 127, "fetchal": 17, "fetchmani": 18, "fetchon": 19, "function": 36, "get": 127, "get_jwt": 1, "get_opt": 55, "get_workspac": 104, "get_workspace_group": 105, "getctim": 80, "getmtim": 81, "global_statu": 37, "http_connection_url": 117, "index": 38, "info": 62, "instal": 129, "is_connect": [10, 20], "is_dir": [63, 82], "is_fil": [64, 83], "januari": 131, "juli": 131, "june": 131, "kai_url": 118, "licens": 130, "listdir": 65, "log": 119, "mai": 131, "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": 131, "mkdir": 66, "name": 127, "new": 131, "next": 21, "nextset": 22, "notebook": [0, 109, 110, 111, 112, 113], "novemb": 131, "octob": 131, "open": [67, 84], "open_mongosh": 120, "open_shel": 121, "open_studio": 122, "organ": [106, 109], "paraemet": 70, "paramet": 127, "partit": 39, "pipelin": 40, "plan": 41, "plancach": 42, "posit": 127, "procedur": 43, "processlist": 44, "python": 128, "queri": 127, "refer": 0, "refresh": [91, 96], "region": [0, 57, 107], "remov": [68, 85], "removedir": [69, 86], "renam": [70, 87], "reproduct": 45, "result": 127, "rmdir": [71, 88], "rollback": 11, "schema": 46, "scroll": 23, "sdk": 128, "secret": 110, "septemb": 131, "server": [0, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125], "session_statu": 47, "set_opt": 126, "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, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 128], "specifi": 127, "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": [125, 127], "statu": 48, "stop": 123, "studio_url": 124, "substitut": 127, "tabl": 50, "table_statu": 49, "termin": [92, 98], "tool": 0, "tupl": 127, "type": 127, "updat": [93, 99], "upload_fil": 72, "upload_fold": 73, "url": 127, "us": 127, "util": 0, "v0": 131, "v1": 131, "warn": 51, "what": 131, "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/api.rst b/docs/src/api.rst index 9b08812b9..89389a23f 100644 --- a/docs/src/api.rst +++ b/docs/src/api.rst @@ -312,6 +312,69 @@ calls to the currently selected portal services. workspace +Server Tools +------------ + +If you have Docker installed on your machine, you can use the Docker interface +included with the Python SDK to start a SingleStoreDB server in Docker. This +allows you to open interactive shells, SQL Studio, and also use the `%sql` +magic commands from Jupysql with a SingleStoreDB server running in a container. + +An example of starting SingleStoreDB in Docker is shown below. + +.. sourcecode:: python + + + from singlestoredb.server import docker + + s2db = docker.start() + + with s2db.connect() as conn: + with conn.cursor() as cur: + cur.execute('SHOW DATABASES') + for line in cur: + print(line) + + s2db.stop() + +It is possible to use the server instance as a context manager as well. +This will automatically shut down the container after exiting the ``with`` +block. + +.. sourcecode:: python + + from singlestoredb.server import docker + + with docker.start() as s2db: + with s2db.connect() as conn: + with conn.cursor() as cur: + cur.execute('SHOW DATABASES') + for line in cur: + print(line) + +If you do not explicitly shut down the container, it will get shut +down when the Python process exits. + +.. currentmodule:: singlestoredb.server.docker + +.. autosummary:: + :toctree: generated/ + + start + SingleStoreDB.logs + SingleStoreDB.connect + SingleStoreDB.connect_kai + SingleStoreDB.connection_url + SingleStoreDB.http_connection_url + SingleStoreDB.kai_url + SingleStoreDB.studio_url + SingleStoreDB.open_studio + SingleStoreDB.open_shell + SingleStoreDB.open_mongosh + SingleStoreDB.stop + + + Configuration ------------- diff --git a/singlestoredb/server/__init__.py b/singlestoredb/server/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/singlestoredb/server/docker.py b/singlestoredb/server/docker.py new file mode 100644 index 000000000..319e9bbfe --- /dev/null +++ b/singlestoredb/server/docker.py @@ -0,0 +1,457 @@ +#!/usr/bin/env python +"""Utilities for running singlestoredb-dev-image.""" +from __future__ import annotations + +import atexit +import os +import platform +import secrets +import socket +import subprocess +import time +import urllib.parse +from contextlib import closing +from types import TracebackType +from typing import Any +from typing import Dict +from typing import List +from typing import Optional +from typing import Type + +try: + import docker + has_docker = True +except ImportError: + has_docker = False + raise RuntimeError('docker python package is not installed') + +from .. import connect +from ..connection import Connection + +try: + import pymongo + has_pymongo = True +except ImportError: + has_pymongo = False + +DEFAULT_IMAGE = 'ghcr.io/singlestore-labs/singlestoredb-dev:latest' + + +class SingleStoreDB: + """ + Manager for SingleStoreDB server running in Docker. + + Parameters + ----------- + name : str, optional + Name of the container. + root_password : str, optional + Root password for the SingleStoreDB server. + license : str, optional + License key for SingleStoreDB. + enable_kai : bool, optional + Enable Kai (MongoDB) server. + server_port : int, optional + Port for the SingleStoreDB server. + studio_port : int, optional + Port for the SingleStoreDB Studio. + data_api_port : int, optional + Port for the SingleStoreDB Data API. + kai_port : int, optional + Port for the Kai server. + hostname : str, optional + Hostname for the container. + data_dir : str, optional + Path to the data directory. + logs_dir : str, optional + Path to the logs directory. + server_dir : str, optional + Path to the server directory. + global_vars : dict, optional + Global variables to set in the SingleStoreDB server. + init_sql : str, optional + Path to an SQL file to run on startup. + image : str, optional + Docker image to use. + database : str, optional + Default database to connect to. + + """ + + root_password: str + kai_enabled: bool + server_port: int + studio_port: int + data_api_port: int + kai_port: Optional[int] + data_dir: Optional[str] + logs_dir: Optional[str] + server_dir: Optional[str] + + def __init__( + self, + name: Optional[str] = None, + *, + root_password: Optional[str] = None, + license: Optional[str] = None, + enable_kai: bool = False, + server_port: Optional[int] = None, + studio_port: Optional[int] = None, + data_api_port: Optional[int] = None, + kai_port: Optional[int] = None, + hostname: Optional[str] = None, + data_dir: Optional[str] = None, + logs_dir: Optional[str] = None, + server_dir: Optional[str] = None, + global_vars: Optional[Dict[str, Any]] = None, + init_sql: Optional[str] = None, + image: str = DEFAULT_IMAGE, + database: Optional[str] = None, + ): + self.kai_enabled = enable_kai + self.kai_port = None + self.server_port = server_port or self._get_available_port() + self.studio_port = studio_port or self._get_available_port() + self.data_api_port = data_api_port or self._get_available_port() + self.data_dir = data_dir + self.logs_dir = logs_dir + self.server_dir = server_dir + + # Setup container ports + ports = { + '3306/tcp': self.server_port, + '8080/tcp': self.studio_port, + '9000/tcp': self.data_api_port, + } + + if enable_kai: + self.kai_port = kai_port or self._get_available_port() + ports['27017/tcp'] = self.kai_port + + # Setup root password + self.root_password = root_password or secrets.token_urlsafe(10) + + # Setup license value + if license is None: + try: + license = os.environ['SINGLESTORE_LICENSE'] + except KeyError: + raise ValueError('a SingleStore license must be supplied') + + # Setup environment variables for the container + env = {'ROOT_PASSWORD': self.root_password} + + if license: + env['SINGLESTORE_LICENSE'] = license + + if enable_kai: + env['ENABLE_KAI'] = '1' + + # Construct Docker arguments + kwargs = { + 'environment': env, + 'ports': ports, + 'detach': True, + 'auto_remove': True, + 'remove': True, + } + + if 'macOS' in platform.platform(): + kwargs['platform'] = 'linux/amd64' + + for pname, pvalue in [ + ('name', name or 'singlestoredb-dev'), + ('hostname', hostname), + ]: + if pvalue is not None: + kwargs[pname] = pvalue + + # Setup volumes + volumes: Dict[str, Dict[str, str]] = {} + if data_dir: + volumes[data_dir] = {'bind': '/data', 'mode': 'rw'} + if logs_dir: + volumes[logs_dir] = {'bind': '/logs', 'mode': 'ro'} + if server_dir: + volumes[server_dir] = {'bind': '/server', 'mode': 'ro'} + if init_sql: + volumes[os.path.abspath(init_sql)] = {'bind': '/init.sql', 'mode': 'ro'} + if volumes: + kwargs['volumes'] = volumes + + # Setup global vars + for k, v in (global_vars or {}).items(): + env['SINGLESTORE_SET_GLOBAL_' + k.upper()] = str(v) + + self._saved_server_urls: Dict[str, Optional[str]] = {} + + docker_client = docker.from_env() + self.container = docker_client.containers.run(image, **kwargs) + atexit.register(self.stop) + + if not self._wait_on_ready(): + raise RuntimeError('server did not come up properly') + + self._database = database + self._set_server_urls() + + def __str__(self) -> str: + return f"SingleStoreDB('{self.connection_url}')" + + def __repr__(self) -> str: + return str(self) + + def _get_available_port(self) -> int: + with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s: + s.bind(('', 0)) + s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) + return s.getsockname()[1] + + def _set_server_urls(self) -> None: + self._saved_server_urls['DATABASE_URL'] = os.environ.get('DATABASE_URL') + os.environ['DATABASE_URL'] = self.connection_url + self._saved_server_urls['SINGLESTOREDB_URL'] = os.environ.get('SINGLESTOREDB_URL') + os.environ['SINGLESTOREDB_URL'] = self.connection_url + + def _restore_server_urls(self) -> None: + for k, v in self._saved_server_urls.items(): + if v is None: + del os.environ[k] + else: + os.environ[k] = v + + def _wait_on_ready(self) -> bool: + for i in range(60): + for line in self.logs(): + if 'INFO: ' in line: + return True + time.sleep(5) + return False + + def logs(self) -> List[str]: + return self.container.logs().decode('utf8').split('\n') + + @property + def connection_url(self) -> str: + """Connection URL for the SingleStoreDB server.""" + dbname = f'/{self._database}' if self._database else '' + root_password = urllib.parse.quote_plus(self.root_password) + return f'singlestoredb://root:{root_password}@' + \ + f'localhost:{self.server_port}{dbname}' + + @property + def http_connection_url(self) -> str: + """HTTP Connection URL for the SingleStoreDB server.""" + dbname = f'/{self._database}' if self._database else '' + root_password = urllib.parse.quote_plus(self.root_password) + return f'singlestoredb+http://root:{root_password}@' + \ + f'localhost:{self.data_api_port}{dbname}' + + def connect( + self, + use_data_api: bool = False, + **kwargs: Any, + ) -> Connection: + """ + Connect to the SingleStoreDB server. + + Parameters + ----------- + use_data_api : bool, optional + Use the Data API for the connection. + **kwargs : Any, optional + Additional keyword arguments to pass to the connection. + + Returns + -------- + Connection : Connection to the SingleStoreDB server. + + """ + if use_data_api: + return connect(self.http_connection_url, **kwargs) + return connect(self.connection_url, **kwargs) + + @property + def kai_url(self) -> Optional[str]: + """Connection URL for the Kai (MongoDB) server.""" + if not self.kai_enabled: + return None + root_password = urllib.parse.quote_plus(self.root_password) + return f'mongodb://root:{root_password}@' + \ + f'localhost:{self.kai_port}/?authMechanism=PLAIN&loadBalanced=true' + + def connect_kai(self) -> 'pymongo.MongoClient': + """Connect to the Kai (MongoDB) server.""" + if not self.kai_enabled: + raise RuntimeError('kai is not enabled') + if not has_pymongo: + raise RuntimeError('pymongo is not installed') + return pymongo.MongoClient(self.kai_url) + + @property + def studio_url(self) -> str: + """URL for the SingleStoreDB Studio.""" + return f'http://localhost:{self.studio_port}' + + def open_studio(self) -> None: + """Open the SingleStoreDB Studio in a web browser.""" + import webbrowser + if platform.platform().lower().startswith('macos'): + chrome_path = r'open -a /Applications/Google\ Chrome.app %s' + webbrowser.get(chrome_path).open(self.studio_url, new=2) + else: + webbrowser.open(self.studio_url, new=2) + + def open_shell(self) -> None: + """Open a shell in the SingleStoreDB server.""" + env_token = '_SINGLESTOREDB_TOKEN_' + self.container.id + try: + os.environ[env_token] = self.root_password + if platform.platform().lower().startswith('macos'): + subprocess.call( + f'open -a Terminal --args docker exec -it {self.container.id} ' + f'singlestore -p"${env_token}"', + shell=True, + ) + elif platform.platform().lower().startswith('linux'): + subprocess.call( + f'gnome-terminal -- docker exec -it {self.container.id} ' + f'singlestore -p"${env_token}"', + shell=True, + ) + elif platform.platform().lower().startswith('windows'): + subprocess.call( + f'start cmd /k docker exec -it {self.container.id} ' + f'singlestore -p"%{env_token}%"', + shell=True, + ) + else: + raise RuntimeError('unsupported platform') + finally: + del os.environ[env_token] + + def open_mongosh(self) -> None: + """Open a mongosh in the SingleStoreDB server.""" + if not self.kai_enabled: + raise RuntimeError('kai interface is not enabled') + env_token = '_SINGLESTOREDB_TOKEN_' + self.container.id + try: + os.environ[env_token] = self.root_password + if platform.platform().lower().startswith('macos'): + subprocess.call( + 'open -a Terminal --args ' + f'docker exec -it {self.container.id} mongosh', + shell=True, + ) + elif platform.platform().lower().startswith('linux'): + subprocess.call( + f'gnome-terminal -- docker exec -it {self.container.id} mongosh', + shell=True, + ) + elif platform.platform().lower().startswith('windows'): + subprocess.call( + f'start cmd /k docker exec -it {self.container.id} mongosh', + shell=True, + ) + else: + raise RuntimeError('unsupported platform') + finally: + del os.environ[env_token] + + def __enter__(self) -> SingleStoreDB: + return self + + def __exit__( + self, + exc_type: Optional[Type[BaseException]], + exc_val: Optional[BaseException], + exc_tb: Optional[TracebackType], + ) -> Optional[bool]: + self.stop() + return None + + def stop(self) -> None: + """Stop the SingleStoreDB server.""" + if self.container is not None: + try: + self._restore_server_urls() + self.container.stop() + finally: + self.container = None + + +def start( + name: Optional[str] = None, + root_password: Optional[str] = None, + license: Optional[str] = None, + enable_kai: bool = False, + server_port: Optional[int] = None, + studio_port: Optional[int] = None, + data_api_port: Optional[int] = None, + kai_port: Optional[int] = None, + hostname: Optional[str] = None, + data_dir: Optional[str] = None, + logs_dir: Optional[str] = None, + server_dir: Optional[str] = None, + global_vars: Optional[Dict[str, Any]] = None, + init_sql: Optional[str] = None, + image: str = DEFAULT_IMAGE, + database: Optional[str] = None, +) -> SingleStoreDB: + """ + Manager for SingleStoreDB server running in Docker. + + Parameters + ----------- + name : str, optional + Name of the container. + root_password : str, optional + Root password for the SingleStoreDB server. + license : str, optional + License key for SingleStoreDB. + enable_kai : bool, optional + Enable Kai (MongoDB) server. + server_port : int, optional + Port for the SingleStoreDB server. + studio_port : int, optional + Port for the SingleStoreDB Studio. + data_api_port : int, optional + Port for the SingleStoreDB Data API. + kai_port : int, optional + Port for the Kai server. + hostname : str, optional + Hostname for the container. + data_dir : str, optional + Path to the data directory. + logs_dir : str, optional + Path to the logs directory. + server_dir : str, optional + Path to the server directory. + global_vars : dict, optional + Global variables to set in the SingleStoreDB server. + init_sql : str, optional + Path to an SQL file to run on startup. + image : str, optional + Docker image to use. + database : str, optional + Default database to connect to. + + """ + return SingleStoreDB( + name=name, + root_password=root_password, + license=license, + enable_kai=enable_kai, + server_port=server_port, + studio_port=studio_port, + data_api_port=data_api_port, + kai_port=kai_port, + hostname=hostname, + data_dir=data_dir, + logs_dir=logs_dir, + server_dir=server_dir, + global_vars=global_vars, + init_sql=init_sql, + image=image, + database=database, + )