diff --git a/docs/.buildinfo b/docs/.buildinfo index 346e164a..69f3f06e 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 667482961abe46f8a6654e0e8ccb80a0 +config: 61b7c04058a74e2bb257b6d7af9441d6 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/_sources/whatsnew.rst.txt b/docs/_sources/whatsnew.rst.txt index c50d875e..87b90871 100644 --- a/docs/_sources/whatsnew.rst.txt +++ b/docs/_sources/whatsnew.rst.txt @@ -5,6 +5,10 @@ This document outlines features and improvements from each release. .. note:: All releases before v1.0.0 are considered pre-release and are for non-production testing and evaluation, and may include changes to the API. +v1.1.0 - April, 18 2024 +----------------------- +* Added new result types: numpy, pandas, polars, arrow +* Added `SHOW FUSION HELP` command and doc to Fusion SQL handlers v1.0.4 - April, 3 2024 ---------------------- * Management API updates diff --git a/docs/_static/basic.css b/docs/_static/basic.css index e7f78f83..8012ca51 100644 --- a/docs/_static/basic.css +++ b/docs/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -187,6 +187,9 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } +a:visited { + color: #551A8B; +} h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -533,6 +536,14 @@ dd { margin-bottom: 10px; margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -587,6 +598,12 @@ abbr, acronym { border-bottom: dotted 1px; cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} /* -- code displays --------------------------------------------------------- */ pre { overflow: auto; diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js index 83d137dd..e2a841e6 100644 --- a/docs/_static/doctools.js +++ b/docs/_static/doctools.js @@ -4,7 +4,7 @@ * * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 398ef503..49829c23 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,5 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.0.4', +const DOCUMENTATION_OPTIONS = { + VERSION: '1.1.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js index 8ddb4f42..024e709f 100644 --- a/docs/_static/language_data.js +++ b/docs/_static/language_data.js @@ -5,12 +5,12 @@ * This script contains the language-specific data used by searchtools.js, * namely the list of stopwords, stemmer, scorer and splitter. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; -/* Non-minified version is copied as a separate JS file, is available */ +/* Non-minified version is copied as a separate JS file, if available */ /** * Porter Stemmer */ diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js index 2e47da3d..9a1f517b 100644 --- a/docs/_static/searchtools.js +++ b/docs/_static/searchtools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for the full-text search. * - * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -51,12 +51,12 @@ const _removeChildren = (element) => { */ const _escapeRegExp = (string) => string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string -const _displayItem = (item, searchTerms) => { +const _displayItem = (item, searchTerms, highlightTerms) => { const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; - const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; const [docName, title, anchor, descr, score, _filename] = item; let listItem = document.createElement("li"); let requestUrl; @@ -67,28 +67,35 @@ const _displayItem = (item, searchTerms) => { if (dirname.match(/\/index\/$/)) dirname = dirname.substring(0, dirname.length - 6); else if (dirname === "index/") dirname = ""; - requestUrl = docUrlRoot + dirname; + requestUrl = contentRoot + dirname; linkUrl = requestUrl; } else { // normal html builders - requestUrl = docUrlRoot + docName + docFileSuffix; + requestUrl = contentRoot + docName + docFileSuffix; linkUrl = docName + docLinkSuffix; } let linkEl = listItem.appendChild(document.createElement("a")); linkEl.href = linkUrl + anchor; linkEl.dataset.score = score; linkEl.innerHTML = title; - if (descr) + if (descr) { listItem.appendChild(document.createElement("span")).innerHTML = " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } else if (showSearchSummary) fetch(requestUrl) .then((responseData) => responseData.text()) .then((data) => { if (data) listItem.appendChild( - Search.makeSearchSummary(data, searchTerms) + Search.makeSearchSummary(data, searchTerms, anchor) ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); }); Search.output.appendChild(listItem); }; @@ -101,26 +108,43 @@ const _finishSearch = (resultCount) => { ); else Search.status.innerText = _( - `Search finished, found ${resultCount} page(s) matching the search query.` - ); + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); }; const _displayNextItem = ( results, resultCount, - searchTerms + searchTerms, + highlightTerms, ) => { // results left, load the summary and display it // this is intended to be dynamic (don't sub resultsCount) if (results.length) { - _displayItem(results.pop(), searchTerms); + _displayItem(results.pop(), searchTerms, highlightTerms); setTimeout( - () => _displayNextItem(results, resultCount, searchTerms), + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), 5 ); } // search finished, update title and status message else _finishSearch(resultCount); }; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; /** * Default splitQuery function. Can be overridden in ``sphinx.search`` with a * custom function per language. @@ -141,13 +165,23 @@ const Search = { _index: null, _queued_query: null, _pulse_status: -1, - htmlToText: (htmlString) => { + htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() }); + for (const removalQuery of [".headerlinks", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + // if anchor not specified or not found, fall back to main content const docContent = htmlElement.querySelector('[role="main"]'); - if (docContent !== undefined) return docContent.textContent; + if (docContent) return docContent.textContent; console.warn( - "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." ); return ""; }, @@ -207,15 +241,7 @@ const Search = { if (Search.hasIndex()) Search.query(query); else Search.deferQuery(query); }, - /** - * execute search (requires search index to be loaded) - */ - query: (query) => { - const filenames = Search._index.filenames; - const docNames = Search._index.docnames; - const titles = Search._index.titles; - const allTitles = Search._index.alltitles; - const indexEntries = Search._index.indexentries; + _parseQuery: (query) => { // stem the search terms and add them to the correct list const stemmer = new Stemmer(); const searchTerms = new Set(); @@ -246,15 +272,28 @@ const Search = { // console.debug("SEARCH: searching for:"); // console.info("required: ", [...searchTerms]); // console.info("excluded: ", [...excludedTerms]); - // array of [docname, title, anchor, descr, score, filename] - let results = []; + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; _removeChildren(document.getElementById("search-progress")); - const queryLower = query.toLowerCase(); + const queryLower = query.toLowerCase().trim(); for (const [title, foundTitles] of Object.entries(allTitles)) { - if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { let score = Math.round(100 * queryLower.length / title.length) - results.push([ + normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", @@ -268,42 +307,42 @@ const Search = { // search for explicit entries in index directives for (const [entry, foundEntries] of Object.entries(indexEntries)) { if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { - for (const [file, id] of foundEntries) { - let score = Math.round(100 * queryLower.length / entry.length) - results.push([ + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ docNames[file], titles[file], id ? "#" + id : "", null, score, filenames[file], - ]); + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } } } } // lookup as object objectTerms.forEach((term) => - results.push(...Search.performObjectSearch(term, objectTerms)) + normalResults.push(...Search.performObjectSearch(term, objectTerms)) ); // lookup as search terms in fulltext - results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function - if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); - // now sort the results by score (in opposite order of appearance, since the - // display function below uses pop() to retrieve items) and then - // alphabetically - results.sort((a, b) => { - const leftScore = a[4]; - const rightScore = b[4]; - if (leftScore === rightScore) { - // same score: sort alphabetically - const leftTitle = a[1].toLowerCase(); - const rightTitle = b[1].toLowerCase(); - if (leftTitle === rightTitle) return 0; - return leftTitle > rightTitle ? -1 : 1; // inverted is intentional - } - return leftScore > rightScore ? 1 : -1; - }); + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; // remove duplicate search results // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept let seen = new Set(); @@ -315,12 +354,16 @@ const Search = { } return acc; }, []); - results = results.reverse(); + return results.reverse(); + }, + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); // for debugging //Search.lastresults = results.slice(); // a copy // console.info("search results:", Search.lastresults); // print the results - _displayNextItem(results, results.length, searchTerms); + _displayNextItem(results, results.length, searchTerms, highlightTerms); }, /** * search for object names @@ -404,14 +447,18 @@ const Search = { // add support for partial matches if (word.length > 2) { const escapedWord = _escapeRegExp(word); - Object.keys(terms).forEach((term) => { - if (term.match(escapedWord) && !terms[word]) - arr.push({ files: terms[term], score: Scorer.partialTerm }); - }); - Object.keys(titleTerms).forEach((term) => { - if (term.match(escapedWord) && !titleTerms[word]) - arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); - }); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } } // no match but word was a required one if (arr.every((record) => record.files === undefined)) return; @@ -429,9 +476,8 @@ const Search = { }); // create the mapping files.forEach((file) => { - if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) - fileMap.get(file).push(word); - else fileMap.set(file, [word]); + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); }); }); // now check if the files don't contain excluded terms @@ -477,8 +523,8 @@ const Search = { * search summary for a given text. keywords is a list * of stemmed words. */ - makeSearchSummary: (htmlText, keywords) => { - const text = Search.htmlToText(htmlText); + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); if (text === "") return null; const textLower = text.toLowerCase(); const actualStartPosition = [...keywords] diff --git a/docs/_static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js index a0b3d04a..0dbbec32 100644 --- a/docs/_static/sphinx_highlight.js +++ b/docs/_static/sphinx_highlight.js @@ -25,14 +25,19 @@ const _highlight = (node, addItems, text, className) => { span.classList.add(className); } span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); parent.insertBefore( span, parent.insertBefore( - document.createTextNode(val.substr(pos + text.length)), + rest, node.nextSibling ) ); node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); if (isInSVG) { const rect = document.createElementNS( "http://www.w3.org/2000/svg", @@ -125,5 +130,10 @@ const SphinxHighlight = { }); }, }; -_ready(SphinxHighlight.highlightSearchWords); -_ready(SphinxHighlight.initEscapeListener); +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/docs/api.html b/docs/api.html index a7cd55fc..860f6165 100644 --- a/docs/api.html +++ b/docs/api.html @@ -1,18 +1,18 @@ - + - + - API Reference — SingleStoreDB 1.0.4 documentation + API Reference — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -214,10 +214,10 @@
-
-

API Reference

+
+

API Reference

-

Connections

+

Connections

The connect() function is the primary entry point for the SingleStore package. It connects to a SingleStore database using either DB-API compliant parameters, @@ -238,7 +238,7 @@

-

Connection

+

Connection

Connection objects are created by the singlestoredb.connect() function. They are used to create Cursor objects for querying the database.

@@ -357,7 +357,7 @@

Connection -

ShowResult

+

ShowResult

The results of the above methods and attributes are in the form of a ShowResult object. This object is primarily used to display information to the screen or web browser, but columns from the output @@ -373,7 +373,7 @@

ShowResult -

Cursor

+

Cursor

Cursors are used to query the database and download results. They are created using the Connection.cursor() method.

@@ -425,7 +425,7 @@

Cursor
-

Utilities

+

Utilities

@@ -435,7 +435,7 @@

Utilities -

Management API

+

Management API

The management objects allow you to create, destroy, and interact with workspaces in the SingleStoreDB Cloud.

The manage_workspaces() function will return a WorkspaceManager @@ -448,7 +448,7 @@

Management API -

WorkspaceManager

+

WorkspaceManager

WorkspaceManager objects are returned by the manage_workspaces() function. They allow you to retrieve information about workspaces in your account, or create new ones.

@@ -482,7 +482,7 @@

WorkspaceManager -

WorkspaceGroup

+

WorkspaceGroup

WorkspaceGroup objects are retrieved from WorkspaceManager.get_workspace_group() or by retrieving an element from WorkspaceManager.workspace_groups.

get_jwt(email[, url, clusters, databases, ...])

@@ -512,7 +512,7 @@

WorkspaceGroup -

Workspace

+

Workspace

Workspaces are created within WorkspaceGroups. They can be created using either WorkspaceGroup.create_workspace() or retrieved from WorkspaceManager.workspaces.

@@ -537,7 +537,7 @@

Workspace -

Region

+

Region

Region objects are accessed from the WorkspaceManager.regions attribute.

@@ -548,7 +548,7 @@

Region
-

Stage

+

Stage

To interact with Stage, use the WorkspaceManager.stage attribute. It will return a Stage object which defines the following methods and attributes.

@@ -606,7 +606,7 @@

Stage

-

StageObject

+

StageObject

StageObject`s are returned by the :meth:`StageObject.upload_file StageObject.upload_folder(), StageObject.mkdir(), StageObject.rename(), and StageObject.info() methods.

@@ -662,7 +662,7 @@

StageObject -

Configuration

+

Configuration

The following functions are used to get and set package configuration settings. Execute the describe_option() function with no parameters to see the documentation for all options.

diff --git a/docs/generated/singlestoredb.auth.get_jwt.html b/docs/generated/singlestoredb.auth.get_jwt.html index 382e7df3..e3a1d5fa 100644 --- a/docs/generated/singlestoredb.auth.get_jwt.html +++ b/docs/generated/singlestoredb.auth.get_jwt.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.auth.get_jwt — SingleStoreDB 1.0.4 documentation + singlestoredb.auth.get_jwt — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -81,10 +81,10 @@
-

singlestoredb.auth.get_jwt

+

singlestoredb.auth.get_jwt

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

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

Parameters:
diff --git a/docs/generated/singlestoredb.connect.html b/docs/generated/singlestoredb.connect.html index 6894a4cd..44046673 100644 --- a/docs/generated/singlestoredb.connect.html +++ b/docs/generated/singlestoredb.connect.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connect — SingleStoreDB 1.0.4 documentation + singlestoredb.connect — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -84,10 +84,10 @@
-

singlestoredb.connect

+

singlestoredb.connect

-singlestoredb.connect(host: str | None = None, user: str | None = None, password: str | None = None, port: int | None = None, database: str | None = None, driver: str | None = None, pure_python: bool | None = None, local_infile: bool | None = None, charset: str | None = None, ssl_key: str | None = None, ssl_cert: str | None = None, ssl_ca: str | None = None, ssl_disabled: bool | None = None, ssl_cipher: str | None = None, ssl_verify_cert: bool | None = None, ssl_verify_identity: bool | None = None, conv: Dict[int, Callable[[...], Any]] | None = None, credential_type: str | None = None, autocommit: bool | None = None, results_type: str | None = None, buffered: bool | None = None, results_format: str | None = None, program_name: str | None = None, conn_attrs: Dict[str, str] | None = None, multi_statements: bool | None = None, 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) Connection
+singlestoredb.connect(host: str | None = None, user: str | None = None, password: str | None = None, port: int | None = None, database: str | None = None, driver: str | None = None, pure_python: bool | None = None, local_infile: bool | None = None, charset: str | None = None, ssl_key: str | None = None, ssl_cert: str | None = None, ssl_ca: str | None = None, ssl_disabled: bool | None = None, ssl_cipher: str | None = None, ssl_verify_cert: bool | None = None, ssl_verify_identity: bool | None = None, conv: Dict[int, Callable[[...], Any]] | None = None, credential_type: str | None = None, autocommit: bool | None = None, results_type: str | None = None, buffered: bool | None = None, results_format: str | None = None, program_name: str | None = None, conn_attrs: Dict[str, str] | None = None, multi_statements: bool | None = None, 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) 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 a462ba6e..522fe9b0 100644 --- a/docs/generated/singlestoredb.connection.Connection.autocommit.html +++ b/docs/generated/singlestoredb.connection.Connection.autocommit.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.autocommit — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.autocommit — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.autocommit

+

singlestoredb.connection.Connection.autocommit

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

Set autocommit mode.

diff --git a/docs/generated/singlestoredb.connection.Connection.close.html b/docs/generated/singlestoredb.connection.Connection.close.html index c37dc960..0a0e8d06 100644 --- a/docs/generated/singlestoredb.connection.Connection.close.html +++ b/docs/generated/singlestoredb.connection.Connection.close.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.close — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.close — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.close

+

singlestoredb.connection.Connection.close

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

Close the database connection.

diff --git a/docs/generated/singlestoredb.connection.Connection.commit.html b/docs/generated/singlestoredb.connection.Connection.commit.html index 4e0a2b59..8ebc8547 100644 --- a/docs/generated/singlestoredb.connection.Connection.commit.html +++ b/docs/generated/singlestoredb.connection.Connection.commit.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.commit — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.commit — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.commit

+

singlestoredb.connection.Connection.commit

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

Commit the pending transaction.

diff --git a/docs/generated/singlestoredb.connection.Connection.cursor.html b/docs/generated/singlestoredb.connection.Connection.cursor.html index ccf4701a..98223bc6 100644 --- a/docs/generated/singlestoredb.connection.Connection.cursor.html +++ b/docs/generated/singlestoredb.connection.Connection.cursor.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.cursor — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.cursor — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.cursor

+

singlestoredb.connection.Connection.cursor

-abstract Connection.cursor() Cursor
+abstract Connection.cursor() Cursor

Create a new cursor object.

See also

diff --git a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html index eccb3e20..49d91af5 100644 --- a/docs/generated/singlestoredb.connection.Connection.disable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.disable_data_api.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.disable_data_api — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.disable_data_api — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.disable_data_api

+

singlestoredb.connection.Connection.disable_data_api

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

Disable the data API.

See also

diff --git a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html index 6ddf63cd..730a505f 100644 --- a/docs/generated/singlestoredb.connection.Connection.enable_data_api.html +++ b/docs/generated/singlestoredb.connection.Connection.enable_data_api.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.enable_data_api — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.enable_data_api — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.enable_data_api

+

singlestoredb.connection.Connection.enable_data_api

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

Enable the data API in the server.

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

diff --git a/docs/generated/singlestoredb.connection.Connection.html b/docs/generated/singlestoredb.connection.Connection.html index 4b76ce7d..d3297d6e 100644 --- a/docs/generated/singlestoredb.connection.Connection.html +++ b/docs/generated/singlestoredb.connection.Connection.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection

+

singlestoredb.connection.Connection

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

SingleStoreDB connection.

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

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

Call singlestoredb.connect() instead.

Methods

diff --git a/docs/generated/singlestoredb.connection.Connection.is_connected.html b/docs/generated/singlestoredb.connection.Connection.is_connected.html index f9a909c1..3cf55a0c 100644 --- a/docs/generated/singlestoredb.connection.Connection.is_connected.html +++ b/docs/generated/singlestoredb.connection.Connection.is_connected.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.is_connected — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.is_connected — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.is_connected

+

singlestoredb.connection.Connection.is_connected

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

Determine if the database is still connected.

Return type:
diff --git a/docs/generated/singlestoredb.connection.Connection.rollback.html b/docs/generated/singlestoredb.connection.Connection.rollback.html index fc316d8e..8a06ab48 100644 --- a/docs/generated/singlestoredb.connection.Connection.rollback.html +++ b/docs/generated/singlestoredb.connection.Connection.rollback.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Connection.rollback — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Connection.rollback — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.Connection.rollback

+

singlestoredb.connection.Connection.rollback

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

Rollback the pending transaction.

diff --git a/docs/generated/singlestoredb.connection.Cursor.callproc.html b/docs/generated/singlestoredb.connection.Cursor.callproc.html index 3d975530..760ecdfd 100644 --- a/docs/generated/singlestoredb.connection.Cursor.callproc.html +++ b/docs/generated/singlestoredb.connection.Cursor.callproc.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.callproc — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.callproc — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.callproc

+

singlestoredb.connection.Cursor.callproc

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

Call a stored procedure.

The result sets generated by a store procedure can be retrieved like the results of any other query using fetchone(), diff --git a/docs/generated/singlestoredb.connection.Cursor.close.html b/docs/generated/singlestoredb.connection.Cursor.close.html index b49ab9e3..57a7ec2b 100644 --- a/docs/generated/singlestoredb.connection.Cursor.close.html +++ b/docs/generated/singlestoredb.connection.Cursor.close.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.close — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.close — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB

- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.close

+

singlestoredb.connection.Cursor.close

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

Close the cursor.

diff --git a/docs/generated/singlestoredb.connection.Cursor.execute.html b/docs/generated/singlestoredb.connection.Cursor.execute.html index 955c47e4..5b57d0d4 100644 --- a/docs/generated/singlestoredb.connection.Cursor.execute.html +++ b/docs/generated/singlestoredb.connection.Cursor.execute.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.execute — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.execute — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.execute

+

singlestoredb.connection.Cursor.execute

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

Execute a SQL statement.

Queries can use the format-style parameters (%s) when using a list of paramters or pyformat-style parameters (%(key)s) diff --git a/docs/generated/singlestoredb.connection.Cursor.executemany.html b/docs/generated/singlestoredb.connection.Cursor.executemany.html index 57089e6b..4e277661 100644 --- a/docs/generated/singlestoredb.connection.Cursor.executemany.html +++ b/docs/generated/singlestoredb.connection.Cursor.executemany.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.executemany — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.executemany — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB

- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.executemany

+

singlestoredb.connection.Cursor.executemany

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

Execute SQL code against multiple sets of parameters.

Queries can use the format-style parameters (%s) when using lists of paramters or pyformat-style parameters (%(key)s) diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchall.html b/docs/generated/singlestoredb.connection.Cursor.fetchall.html index 77c512c1..7f555221 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchall.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchall.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.fetchall — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.fetchall — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB

- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.fetchall

+

singlestoredb.connection.Cursor.fetchall

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

Fetch all rows in the result set.

Examples

>>> for row in cur.fetchall():
diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
index 50dfad3d..468fca04 100644
--- a/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
+++ b/docs/generated/singlestoredb.connection.Cursor.fetchmany.html
@@ -1,18 +1,18 @@
 
-
+
 
-  
+  
   
-  singlestoredb.connection.Cursor.fetchmany — SingleStoreDB 1.0.4 documentation
+  singlestoredb.connection.Cursor.fetchmany — SingleStoreDB 1.1.0 documentation
       
       
       
   
-        
-        
-        
+        
+        
+        
     
     
     
@@ -28,7 +28,7 @@
             SingleStoreDB
           
               
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.fetchmany

+

singlestoredb.connection.Cursor.fetchmany

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

Fetch size rows from the result.

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

Examples

diff --git a/docs/generated/singlestoredb.connection.Cursor.fetchone.html b/docs/generated/singlestoredb.connection.Cursor.fetchone.html index 1121bb2a..0170b425 100644 --- a/docs/generated/singlestoredb.connection.Cursor.fetchone.html +++ b/docs/generated/singlestoredb.connection.Cursor.fetchone.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.fetchone — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.fetchone — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.fetchone

+

singlestoredb.connection.Cursor.fetchone

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

Fetch a single row from the result set.

Examples

>>> while True:
diff --git a/docs/generated/singlestoredb.connection.Cursor.html b/docs/generated/singlestoredb.connection.Cursor.html
index 2bec5936..68af6dce 100644
--- a/docs/generated/singlestoredb.connection.Cursor.html
+++ b/docs/generated/singlestoredb.connection.Cursor.html
@@ -1,18 +1,18 @@
 
-
+
 
-  
+  
   
-  singlestoredb.connection.Cursor — SingleStoreDB 1.0.4 documentation
+  singlestoredb.connection.Cursor — SingleStoreDB 1.1.0 documentation
       
       
       
   
-        
-        
-        
+        
+        
+        
     
     
     
@@ -28,7 +28,7 @@
             SingleStoreDB
           
               
- 1.0.4 + 1.1.0
@@ -97,16 +97,16 @@
-

singlestoredb.connection.Cursor

+

singlestoredb.connection.Cursor

-class singlestoredb.connection.Cursor(connection: Connection)
+class singlestoredb.connection.Cursor(connection: Connection)

Database cursor for submitting commands and queries.

This object should not be instantiated directly. The Connection.cursor method should be used.

-__init__(connection: Connection)
+__init__(connection: Connection)

Call Connection.cursor instead.

Methods

diff --git a/docs/generated/singlestoredb.connection.Cursor.is_connected.html b/docs/generated/singlestoredb.connection.Cursor.is_connected.html index a31461e1..765c730f 100644 --- a/docs/generated/singlestoredb.connection.Cursor.is_connected.html +++ b/docs/generated/singlestoredb.connection.Cursor.is_connected.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.is_connected — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.is_connected — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.is_connected

+

singlestoredb.connection.Cursor.is_connected

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

Is the cursor still connected?

diff --git a/docs/generated/singlestoredb.connection.Cursor.next.html b/docs/generated/singlestoredb.connection.Cursor.next.html index f71f9fc3..dfbbfd83 100644 --- a/docs/generated/singlestoredb.connection.Cursor.next.html +++ b/docs/generated/singlestoredb.connection.Cursor.next.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.next — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.next — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.next

+

singlestoredb.connection.Cursor.next

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

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

Raises:
diff --git a/docs/generated/singlestoredb.connection.Cursor.nextset.html b/docs/generated/singlestoredb.connection.Cursor.nextset.html index d7bfc5de..b050751a 100644 --- a/docs/generated/singlestoredb.connection.Cursor.nextset.html +++ b/docs/generated/singlestoredb.connection.Cursor.nextset.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.nextset — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.nextset — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.nextset

+

singlestoredb.connection.Cursor.nextset

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

Skip to the next available result set.

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

diff --git a/docs/generated/singlestoredb.connection.Cursor.scroll.html b/docs/generated/singlestoredb.connection.Cursor.scroll.html index 5fb3c5ca..1d56da1c 100644 --- a/docs/generated/singlestoredb.connection.Cursor.scroll.html +++ b/docs/generated/singlestoredb.connection.Cursor.scroll.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.scroll — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.scroll — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.scroll

+

singlestoredb.connection.Cursor.scroll

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

Scroll the cursor to the position in the result set.

Parameters:
diff --git a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html index acb49c23..052b15b2 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html +++ b/docs/generated/singlestoredb.connection.Cursor.setinputsizes.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.setinputsizes — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.setinputsizes — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.setinputsizes

+

singlestoredb.connection.Cursor.setinputsizes

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

Predefine memory areas for parameters.

diff --git a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html index bb201aec..aca577c6 100644 --- a/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html +++ b/docs/generated/singlestoredb.connection.Cursor.setoutputsize.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.Cursor.setoutputsize — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.Cursor.setoutputsize — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -97,10 +97,10 @@
-

singlestoredb.connection.Cursor.setoutputsize

+

singlestoredb.connection.Cursor.setoutputsize

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

Set a column buffer size for fetches of large columns.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html index 571a25a3..32398484 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.aggregates.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.aggregates — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.aggregates — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.aggregates

+

singlestoredb.connection.ShowAccessor.aggregates

-Connection.show.aggregates() ShowResult
+Connection.show.aggregates() ShowResult

Show all aggregate functions in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html index 012f3b49..fb9cd174 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.columns.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.columns.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.columns — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.columns — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.columns

+

singlestoredb.connection.ShowAccessor.columns

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

Show the column information for the given table.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html index 3dd07cd2..3a6670ce 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_aggregate.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.create_aggregate — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.create_aggregate — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.create_aggregate

+

singlestoredb.connection.ShowAccessor.create_aggregate

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

Show the function creation code for the given aggregate function.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html index 30f38349..5799c772 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_function.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.create_function — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.create_function — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.create_function

+

singlestoredb.connection.ShowAccessor.create_function

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

Show the function creation code for the given function.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html index 7ff69ea6..ef4f30ac 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_pipeline.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.create_pipeline — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.create_pipeline — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.create_pipeline

+

singlestoredb.connection.ShowAccessor.create_pipeline

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

Show the pipeline creation code for the given pipeline.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html index 762bb812..2c8ba3cb 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_table.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.create_table — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.create_table — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.create_table

+

singlestoredb.connection.ShowAccessor.create_table

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

Show the table creation code for the given table.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html index f7db0232..6c9a73f2 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.create_view.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.create_view — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.create_view — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.create_view

+

singlestoredb.connection.ShowAccessor.create_view

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

Show the view creation code for the given view.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html index 162d0e37..71d880c9 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.database_status.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.database_status — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.database_status — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.database_status

+

singlestoredb.connection.ShowAccessor.database_status

-Connection.show.database_status() ShowResult
+Connection.show.database_status() ShowResult

Show status of the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html index fea12846..11dcbf71 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.databases.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.databases.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.databases — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.databases — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.databases

+

singlestoredb.connection.ShowAccessor.databases

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

Show all databases in the server.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html index 72a8af61..7811e070 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.errors.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.errors.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.errors — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.errors — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.errors

+

singlestoredb.connection.ShowAccessor.errors

-Connection.show.errors() ShowResult
+Connection.show.errors() ShowResult

Show errors.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html index d4ce8f5f..ebd63e12 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.functions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.functions.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.functions — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.functions — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.functions

+

singlestoredb.connection.ShowAccessor.functions

-Connection.show.functions() ShowResult
+Connection.show.functions() ShowResult

Show all functions in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html index e6d8d02d..7314f8f1 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.global_status.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.global_status — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.global_status — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.global_status

+

singlestoredb.connection.ShowAccessor.global_status

-Connection.show.global_status() ShowResult
+Connection.show.global_status() ShowResult

Show global status of the current server.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html index 69bcdbbe..ba9ef936 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.indexes.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.indexes — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.indexes — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.indexes

+

singlestoredb.connection.ShowAccessor.indexes

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

Show all indexes in the given table.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html index d67df621..aed32717 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.partitions.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.partitions — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.partitions — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.partitions

+

singlestoredb.connection.ShowAccessor.partitions

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

Show partitions in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html index 3e77ba3a..57d8fdf8 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.pipelines.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.pipelines — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.pipelines — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.pipelines

+

singlestoredb.connection.ShowAccessor.pipelines

-Connection.show.pipelines() ShowResult
+Connection.show.pipelines() ShowResult

Show all pipelines in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html index a5342f6a..487efaa4 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plan.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plan.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.plan — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.plan — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.plan

+

singlestoredb.connection.ShowAccessor.plan

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

Show the plan for the given plan ID.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html index 223b8a8f..9b9d83c7 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.plancache.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.plancache — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.plancache — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.plancache

+

singlestoredb.connection.ShowAccessor.plancache

-Connection.show.plancache() ShowResult
+Connection.show.plancache() ShowResult

Show all query statements compiled and executed.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html index ac1c9955..779e0cf3 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.procedures.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.procedures — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.procedures — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.procedures

+

singlestoredb.connection.ShowAccessor.procedures

-Connection.show.procedures() ShowResult
+Connection.show.procedures() ShowResult

Show all procedures in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html index af08ca38..0837d347 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.processlist.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.processlist — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.processlist — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.processlist

+

singlestoredb.connection.ShowAccessor.processlist

-Connection.show.processlist() ShowResult
+Connection.show.processlist() ShowResult

Show details about currently running threads.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html index 6bb5986c..a553e659 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.reproduction.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.reproduction — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.reproduction — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.reproduction

+

singlestoredb.connection.ShowAccessor.reproduction

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

Show troubleshooting data for query optimizer and code generation.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html index 617f7580..f9a4b747 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.schemas.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.schemas — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.schemas — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.schemas

+

singlestoredb.connection.ShowAccessor.schemas

-Connection.show.schemas() ShowResult
+Connection.show.schemas() ShowResult

Show schemas in the server.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html index 0f95dc6f..614054d4 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.session_status.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.session_status — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.session_status — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.session_status

+

singlestoredb.connection.ShowAccessor.session_status

-Connection.show.session_status() ShowResult
+Connection.show.session_status() ShowResult

Show server status information for a session.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.status.html b/docs/generated/singlestoredb.connection.ShowAccessor.status.html index aad7bbf5..ac2368c5 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.status.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.status — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.status — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.status

+

singlestoredb.connection.ShowAccessor.status

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

Show server status information.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html index 85d99d06..50327e98 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.table_status.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.table_status — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.table_status — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.table_status

+

singlestoredb.connection.ShowAccessor.table_status

-Connection.show.table_status() ShowResult
+Connection.show.table_status() ShowResult

Show table status information for the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html index 410cd60a..2bab737b 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.tables.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.tables.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.tables — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.tables — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.tables

+

singlestoredb.connection.ShowAccessor.tables

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

Show tables in the current database.

diff --git a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html index f776f9a9..fe94fbcf 100644 --- a/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html +++ b/docs/generated/singlestoredb.connection.ShowAccessor.warnings.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowAccessor.warnings — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowAccessor.warnings — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowAccessor.warnings

+

singlestoredb.connection.ShowAccessor.warnings

-Connection.show.warnings() ShowResult
+Connection.show.warnings() ShowResult

Show warnings.

diff --git a/docs/generated/singlestoredb.connection.ShowResult.html b/docs/generated/singlestoredb.connection.ShowResult.html index 4c8824a1..7dd4eac9 100644 --- a/docs/generated/singlestoredb.connection.ShowResult.html +++ b/docs/generated/singlestoredb.connection.ShowResult.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.connection.ShowResult — SingleStoreDB 1.0.4 documentation + singlestoredb.connection.ShowResult — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -119,10 +119,10 @@
-

singlestoredb.connection.ShowResult

+

singlestoredb.connection.ShowResult

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

Simple result object.

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

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

Methods

diff --git a/docs/generated/singlestoredb.create_engine.html b/docs/generated/singlestoredb.create_engine.html index ddcbeb88..06b0d6d0 100644 --- a/docs/generated/singlestoredb.create_engine.html +++ b/docs/generated/singlestoredb.create_engine.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.create_engine — SingleStoreDB 1.0.4 documentation + singlestoredb.create_engine — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -84,10 +84,10 @@
-

singlestoredb.create_engine

+

singlestoredb.create_engine

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

Create an SQLAlchemy engine for SingleStoreDB.

Parameters:
diff --git a/docs/generated/singlestoredb.describe_option.html b/docs/generated/singlestoredb.describe_option.html index 0464d67e..33333f48 100644 --- a/docs/generated/singlestoredb.describe_option.html +++ b/docs/generated/singlestoredb.describe_option.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.describe_option — SingleStoreDB 1.0.4 documentation + singlestoredb.describe_option — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -83,10 +83,10 @@
-

singlestoredb.describe_option

+

singlestoredb.describe_option

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

Print the description of one or more options.

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

diff --git a/docs/generated/singlestoredb.get_option.html b/docs/generated/singlestoredb.get_option.html index 345c40d4..804236de 100644 --- a/docs/generated/singlestoredb.get_option.html +++ b/docs/generated/singlestoredb.get_option.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.get_option — SingleStoreDB 1.0.4 documentation + singlestoredb.get_option — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -83,10 +83,10 @@
-

singlestoredb.get_option

+

singlestoredb.get_option

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

Get the value of an option.

Parameters:
diff --git a/docs/generated/singlestoredb.manage_workspaces.html b/docs/generated/singlestoredb.manage_workspaces.html index 8bc4802a..ff2a3a5d 100644 --- a/docs/generated/singlestoredb.manage_workspaces.html +++ b/docs/generated/singlestoredb.manage_workspaces.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.manage_workspaces — SingleStoreDB 1.0.4 documentation + singlestoredb.manage_workspaces — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -87,10 +87,10 @@
-

singlestoredb.manage_workspaces

+

singlestoredb.manage_workspaces

-singlestoredb.manage_workspaces(access_token: str | None = None, version: str = 'v1', base_url: str = 'https://api.singlestore.com', *, organization_id: str | None = None) WorkspaceManager
+singlestoredb.manage_workspaces(access_token: str | None = None, version: str = 'v1', base_url: str = 'https://api.singlestore.com', *, organization_id: str | None = None) WorkspaceManager

Retrieve a SingleStoreDB workspace manager.

Parameters:
diff --git a/docs/generated/singlestoredb.management.region.Region.html b/docs/generated/singlestoredb.management.region.Region.html index 08a44d04..0fbf826b 100644 --- a/docs/generated/singlestoredb.management.region.Region.html +++ b/docs/generated/singlestoredb.management.region.Region.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.region.Region — SingleStoreDB 1.0.4 documentation + singlestoredb.management.region.Region — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -87,10 +87,10 @@
-

singlestoredb.management.region.Region

+

singlestoredb.management.region.Region

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

Cluster region information.

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

@@ -100,7 +100,7 @@

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

Use WorkspaceManager.regions instead.

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html index 4eeee730..e629c84a 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_file.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.download_file — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.download_file — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.download_file

+

singlestoredb.management.workspace.Stage.download_file

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

Download the content of a stage path.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html index 565fbda8..9803a3a9 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.download_folder.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.download_folder — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.download_folder — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.download_folder

+

singlestoredb.management.workspace.Stage.download_folder

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

Download a Stage folder to a local directory.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.exists.html b/docs/generated/singlestoredb.management.workspace.Stage.exists.html index e19f8ee7..674da5a0 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.exists.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.exists.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.exists — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.exists — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.exists

+

singlestoredb.management.workspace.Stage.exists

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

Does the given stage path exist?

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.html b/docs/generated/singlestoredb.management.workspace.Stage.html index fd98e14f..c236dd99 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,16 +102,16 @@
-

singlestoredb.management.workspace.Stage

+

singlestoredb.management.workspace.Stage

-class singlestoredb.management.workspace.Stage(workspace_group: WorkspaceGroup, manager: WorkspaceManager)
+class singlestoredb.management.workspace.Stage(workspace_group: WorkspaceGroup, manager: WorkspaceManager)

Stage manager.

This object is not instantiated directly. It is returned by WorkspaceGroup.stage.

-__init__(workspace_group: WorkspaceGroup, manager: WorkspaceManager)
+__init__(workspace_group: WorkspaceGroup, manager: WorkspaceManager)

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.Stage.info.html b/docs/generated/singlestoredb.management.workspace.Stage.info.html index 64866bef..e826a83f 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.info.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.info.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.info — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.info — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.info

+

singlestoredb.management.workspace.Stage.info

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

Return information about a stage location.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html index c6353078..9a1d1b9f 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_dir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.is_dir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.is_dir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.is_dir

+

singlestoredb.management.workspace.Stage.is_dir

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

Is the given stage path a directory?

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html index 0efef553..26d571eb 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.is_file.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.is_file — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.is_file — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.is_file

+

singlestoredb.management.workspace.Stage.is_file

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

Is the given stage path a file?

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html index 9ee38ad7..bd381e11 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.listdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.listdir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.listdir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.listdir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.listdir

+

singlestoredb.management.workspace.Stage.listdir

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

List the files / folders at the given path.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html index 4fabc40e..de4ac12b 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.mkdir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.mkdir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.mkdir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.mkdir

+

singlestoredb.management.workspace.Stage.mkdir

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

Make a directory in the stage.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.open.html b/docs/generated/singlestoredb.management.workspace.Stage.open.html index f57ed9fd..a16aaa06 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.open.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.open.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.open — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.open — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.open

+

singlestoredb.management.workspace.Stage.open

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

Open a Stage path for reading or writing.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.remove.html b/docs/generated/singlestoredb.management.workspace.Stage.remove.html index c16d0984..50d0b592 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.remove.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.remove.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.remove — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.remove — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.remove

+

singlestoredb.management.workspace.Stage.remove

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

Delete a stage location.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html index 4d7c78d8..048cde56 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.removedirs.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.removedirs — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.removedirs — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.removedirs

+

singlestoredb.management.workspace.Stage.removedirs

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

Delete a stage folder recursively.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rename.html b/docs/generated/singlestoredb.management.workspace.Stage.rename.html index 1141406d..c1891612 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rename.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rename.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.rename — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.rename — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,13 +102,13 @@
-

singlestoredb.management.workspace.Stage.rename

+

singlestoredb.management.workspace.Stage.rename

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

Move the stage file to a new location.

-

Paraemeters

+

Paraemeters

old_pathPath or str

Original location of the path

diff --git a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html index dcddde96..bf2359f2 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.rmdir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.rmdir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.rmdir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.rmdir

+

singlestoredb.management.workspace.Stage.rmdir

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

Delete a stage folder.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html index 84661ca6..08f9ccd7 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_file.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.upload_file — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.upload_file — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.upload_file

+

singlestoredb.management.workspace.Stage.upload_file

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

Upload a local file.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html index ce284f11..436f6a09 100644 --- a/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html +++ b/docs/generated/singlestoredb.management.workspace.Stage.upload_folder.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Stage.upload_folder — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Stage.upload_folder — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -102,10 +102,10 @@
-

singlestoredb.management.workspace.Stage.upload_folder

+

singlestoredb.management.workspace.Stage.upload_folder

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

Upload a folder recursively.

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

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html index e2c85893..7519e7ca 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.abspath.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.abspath — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.abspath — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.abspath

+

singlestoredb.management.workspace.StageObject.abspath

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

Return the full path of the object.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html index e3c42f87..169808ce 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.basename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.basename.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.basename — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.basename — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.basename

+

singlestoredb.management.workspace.StageObject.basename

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

Return the basename of the object.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html index dafc4b64..0917d5bc 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.dirname.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.dirname — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.dirname — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.dirname

+

singlestoredb.management.workspace.StageObject.dirname

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

Return the directory name of the object.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.download.html b/docs/generated/singlestoredb.management.workspace.StageObject.download.html index 25c58a82..335ab3ee 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.download.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.download.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.download — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.download — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.download

+

singlestoredb.management.workspace.StageObject.download

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

Download the content of a stage path.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html index a022d006..cb4de21d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.exists.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.exists.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.exists — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.exists — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.exists

+

singlestoredb.management.workspace.StageObject.exists

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

Does the file / folder exist?

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html index 17efdb7e..75a46daa 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getctime.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.getctime — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.getctime — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.getctime

+

singlestoredb.management.workspace.StageObject.getctime

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

Return the creation datetime as a UNIX timestamp.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html index 9849fd3f..ae6eda59 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.getmtime.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.getmtime — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.getmtime — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.getmtime

+

singlestoredb.management.workspace.StageObject.getmtime

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

Return the last modified datetime as a UNIX timestamp.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.html b/docs/generated/singlestoredb.management.workspace.StageObject.html index 8cf61b09..368f989a 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,16 +101,16 @@
-

singlestoredb.management.workspace.StageObject

+

singlestoredb.management.workspace.StageObject

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

Stage file / folder object.

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

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

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html index 5d149656..3cadfc62 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_dir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.is_dir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.is_dir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.is_dir

+

singlestoredb.management.workspace.StageObject.is_dir

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

Is the stage object a directory?

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html index e8d64850..28ee9f47 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.is_file.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.is_file — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.is_file — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.is_file

+

singlestoredb.management.workspace.StageObject.is_file

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

Is the stage object a file?

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.open.html b/docs/generated/singlestoredb.management.workspace.StageObject.open.html index 02f8e923..33aa9b43 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.open.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.open.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.open — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.open — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.open

+

singlestoredb.management.workspace.StageObject.open

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

Open a Stage path for reading or writing.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html index f737a08e..934a339a 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.remove.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.remove.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.remove — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.remove — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.remove

+

singlestoredb.management.workspace.StageObject.remove

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

Delete the stage file.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html index ebf7aec7..8c497c43 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.removedirs.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.removedirs — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.removedirs — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.removedirs

+

singlestoredb.management.workspace.StageObject.removedirs

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

Delete the stage directory recursively.

diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html index 2654afb0..b7aaa94d 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rename.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rename.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.rename — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.rename — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.rename

+

singlestoredb.management.workspace.StageObject.rename

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

Move the stage file to a new location.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html index 7ec9264a..19e022f2 100644 --- a/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html +++ b/docs/generated/singlestoredb.management.workspace.StageObject.rmdir.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.StageObject.rmdir — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.StageObject.rmdir — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -101,10 +101,10 @@
-

singlestoredb.management.workspace.StageObject.rmdir

+

singlestoredb.management.workspace.StageObject.rmdir

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

Delete the empty stage directory.

diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html index 80597a48..60c44448 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.connect.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.connect.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Workspace.connect — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Workspace.connect — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -91,10 +91,10 @@
-

singlestoredb.management.workspace.Workspace.connect

+

singlestoredb.management.workspace.Workspace.connect

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

Create a connection to the database server for this workspace.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.html b/docs/generated/singlestoredb.management.workspace.Workspace.html index 7295dfad..db94c1b7 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Workspace — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Workspace — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -91,10 +91,10 @@
-

singlestoredb.management.workspace.Workspace

+

singlestoredb.management.workspace.Workspace

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

SingleStoreDB workspace definition.

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

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

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html index 591689ec..1f9adec6 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.refresh.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Workspace.refresh — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Workspace.refresh — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -91,10 +91,10 @@
-

singlestoredb.management.workspace.Workspace.refresh

+

singlestoredb.management.workspace.Workspace.refresh

-Workspace.refresh() Workspace
+Workspace.refresh() Workspace

Update the object to the current state.

diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html index 8b272bb9..9fbba3ac 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.terminate.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Workspace.terminate — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Workspace.terminate — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -91,10 +91,10 @@
-

singlestoredb.management.workspace.Workspace.terminate

+

singlestoredb.management.workspace.Workspace.terminate

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

Terminate the workspace.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.Workspace.update.html b/docs/generated/singlestoredb.management.workspace.Workspace.update.html index e5ae1385..ce03da5a 100644 --- a/docs/generated/singlestoredb.management.workspace.Workspace.update.html +++ b/docs/generated/singlestoredb.management.workspace.Workspace.update.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.Workspace.update — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.Workspace.update — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -91,10 +91,10 @@
-

singlestoredb.management.workspace.Workspace.update

+

singlestoredb.management.workspace.Workspace.update

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

Update the workspace definition.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html index 44eed788..2a002262 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.create_workspace.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.create_workspace — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.create_workspace — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.create_workspace

+

singlestoredb.management.workspace.WorkspaceGroup.create_workspace

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

Create a new workspace.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html index 21b15fa2..dc36a40e 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup

+

singlestoredb.management.workspace.WorkspaceGroup

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

SingleStoreDB workspace group definition.

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

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

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html index 8bf263e6..42ebe37f 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.refresh.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.refresh — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.refresh — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.refresh

+

singlestoredb.management.workspace.WorkspaceGroup.refresh

-WorkspaceGroup.refresh() WorkspaceGroup
+WorkspaceGroup.refresh() WorkspaceGroup

Update the object to the current state.

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html index b84f1f9f..c5085845 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.stage.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.stage — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.stage — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.stage

+

singlestoredb.management.workspace.WorkspaceGroup.stage

-property WorkspaceGroup.stage: Stage
+property WorkspaceGroup.stage: Stage

Stage manager.

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html index 50537423..ca855572 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.terminate.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.terminate — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.terminate — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.terminate

+

singlestoredb.management.workspace.WorkspaceGroup.terminate

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

Terminate the workspace group.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html index e90ea8f7..aab5af36 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.update.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.update — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.update — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.update

+

singlestoredb.management.workspace.WorkspaceGroup.update

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

Update the workspace group definition.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html index 9422a5ec..2753fecc 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceGroup.workspaces.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceGroup.workspaces — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceGroup.workspaces — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -93,10 +93,10 @@
-

singlestoredb.management.workspace.WorkspaceGroup.workspaces

+

singlestoredb.management.workspace.WorkspaceGroup.workspaces

-property WorkspaceGroup.workspaces: NamedList[Workspace]
+property WorkspaceGroup.workspaces: NamedList[Workspace]

Return a list of available workspaces.

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html index 971b6094..e55c4797 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.create_workspace — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.create_workspace — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.create_workspace

+

singlestoredb.management.workspace.WorkspaceManager.create_workspace

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

Create a new workspace.

Parameters:
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 6b33fda9..f6d697a9 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.create_workspace_group.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.create_workspace_group — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.create_workspace_group — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.create_workspace_group

+

singlestoredb.management.workspace.WorkspaceManager.create_workspace_group

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

Create a new workspace group.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html index 56815444..1c777880 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.get_workspace — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.get_workspace — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.get_workspace

+

singlestoredb.management.workspace.WorkspaceManager.get_workspace

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

Retrieve a workspace definition.

Parameters:
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 d235ebf3..e893daf5 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.get_workspace_group.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.get_workspace_group — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.get_workspace_group — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.get_workspace_group

+

singlestoredb.management.workspace.WorkspaceManager.get_workspace_group

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

Retrieve a workspace group definition.

Parameters:
diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html index 1ffc72a7..3dc03f6a 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager

+

singlestoredb.management.workspace.WorkspaceManager

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

SingleStoreDB workspace manager.

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

@@ -115,7 +115,7 @@

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

Methods

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html index bb1087cc..f9c8ab02 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.organization.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.organization — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.organization — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.organization

+

singlestoredb.management.workspace.WorkspaceManager.organization

-property WorkspaceManager.organization: Organization
+property WorkspaceManager.organization: Organization

Return the current organization.

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html index 84fac7e0..9fecf653 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.regions.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.regions — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.regions — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.regions

+

singlestoredb.management.workspace.WorkspaceManager.regions

-WorkspaceManager.regions()
+WorkspaceManager.regions()

Return a list of available regions.

diff --git a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html index 29245d28..8a67ad68 100644 --- a/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html +++ b/docs/generated/singlestoredb.management.workspace.WorkspaceManager.workspace_groups.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.management.workspace.WorkspaceManager.workspace_groups — SingleStoreDB 1.0.4 documentation + singlestoredb.management.workspace.WorkspaceManager.workspace_groups — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -94,10 +94,10 @@
-

singlestoredb.management.workspace.WorkspaceManager.workspace_groups

+

singlestoredb.management.workspace.WorkspaceManager.workspace_groups

-property WorkspaceManager.workspace_groups: NamedList[WorkspaceGroup]
+property WorkspaceManager.workspace_groups: NamedList[WorkspaceGroup]

Return a list of available workspace groups.

diff --git a/docs/generated/singlestoredb.set_option.html b/docs/generated/singlestoredb.set_option.html index 194a332c..86b2eecf 100644 --- a/docs/generated/singlestoredb.set_option.html +++ b/docs/generated/singlestoredb.set_option.html @@ -1,18 +1,18 @@ - + - + - singlestoredb.set_option — SingleStoreDB 1.0.4 documentation + singlestoredb.set_option — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -83,10 +83,10 @@
-

singlestoredb.set_option

+

singlestoredb.set_option

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

Set the value of an option.

Parameters:
diff --git a/docs/genindex.html b/docs/genindex.html index 061d8909..050fcda8 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -1,18 +1,18 @@ - + - Index — SingleStoreDB 1.0.4 documentation + Index — SingleStoreDB 1.1.0 documentation - - - + + + @@ -26,7 +26,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
diff --git a/docs/getting-started.html b/docs/getting-started.html index 2333775b..ddfdec35 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -1,18 +1,18 @@ - + - + - Getting Started — SingleStoreDB 1.0.4 documentation + Getting Started — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
- 1.0.4 + 1.1.0
@@ -90,11 +90,11 @@
-

Getting Started

+

Getting Started

Database connections can be made using either keyword parameters or a URL as described in the following sections.

-

Connect using DB-API Parameters

+

Connect using DB-API Parameters

Connections to SingleStoreDB can be made using the parameters described in the Python DB-API. The host= parameter can be either a hostname or IP address (it can also be a @@ -113,7 +113,7 @@

Connect using DB-API Parameters -

Connect using a URL

+

Connect using a URL

In addition, you can user a URL like in the SQLAlchemy package.

In [3]: conn = s2.connect('user:password@host:port/database')
 
@@ -125,7 +125,7 @@

Connect using a URL -

Specifying Additional Connection Parameters

+

Specifying Additional Connection Parameters

Connection parameters can be set either in the URL or as parameters. Here local_infile= is set as a URL parameter.

In [5]: conn = s2.connect('https://user:password@host:port/database?local_infile=True')
@@ -140,7 +140,7 @@ 

Specifying Additional Connection Parameters -

Executing Queries

+

Executing Queries

Once you have a connection established, you can query the database. As defined in the DB-API, a cursor is used to execute queries and fetch the results.

@@ -159,7 +159,7 @@

Executing Queries -

Parameter Substitution

+

Parameter Substitution

If your queries require parameter substitutions, they can be specified in one of two formats: named (%(name)s) or positional (%s).

@@ -170,7 +170,7 @@

Parameter Substitution

-

Named Substitution

+

Named Substitution

When named parameters are used, the data structure passed to the Cursor.execute() method must be a dictionary, where the keys map to the names given in the substitutions @@ -193,7 +193,7 @@

Named Substitution -

Positional Substitution

+

Positional Substitution

If positional parameters are used, the data structure passed to the Cursor.execute() method must be a list or tuple with the same number of elements as there are %s values in the query string.

@@ -217,7 +217,7 @@

Positional Substitution

-

Fetching Results

+

Fetching Results

Fetching results can be done in a number of ways. The DB-API specifies three methods that can be used to fetch results: Cursor.fetchone(), Cursor.fetchall(), and Cursor.fetchmany().

@@ -246,13 +246,13 @@

Fetching Results -

Result Type

+

Result Type

In addition to being able to specify the amount of data to be retrieved, you can also specify the data structure that the results are returned in. By default, each row of data is a tuple with one element per column from the query. However, it is also possible to get results back as named tuples or dicts.

-

Tuples (Default)

+

Tuples (Default)

In [11]: with s2.connect(results_type='tuples') as conn:
    ....:     with conn.cursor() as cur:
    ....:         cur.execute('show variables like "auto%"')
@@ -270,7 +270,7 @@ 

Tuples (Default) -

Named Tuples

+

Named Tuples

In [12]: with s2.connect(results_type='namedtuples') as conn:
    ....:     with conn.cursor() as cur:
    ....:         cur.execute('show variables like "auto%"')
@@ -288,7 +288,7 @@ 

Named Tuples -

Dictionaries

+

Dictionaries

In [13]: with s2.connect(results_type='dicts') as conn:
    ....:     with conn.cursor() as cur:
    ....:         cur.execute('show variables like "auto%"')
diff --git a/docs/index.html b/docs/index.html
index 993bcf82..4a3d79cb 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,18 +1,18 @@
 
-
+
 
-  
+  
   
-  SingleStoreDB Python SDK — SingleStoreDB 1.0.4 documentation
+  SingleStoreDB Python SDK — SingleStoreDB 1.1.0 documentation
       
       
       
   
-        
-        
-        
+        
+        
+        
     
     
     
@@ -27,7 +27,7 @@
             SingleStoreDB
           
               
- 1.0.4 + 1.1.0
@@ -68,7 +68,7 @@
_images/singlestore-logo.png
-

SingleStoreDB Python SDK

+

SingleStoreDB Python SDK


The SingleStoreDB Python SDK is a Python DB-API compliant database connector for use with the SingleStore database. It also includes objects for interfacing with SingleStoreDB Cloud’s management API.

@@ -77,6 +77,7 @@

SingleStoreDB Python SDKInstallation
  • What’s New
      +
    • v1.1.0 - April, 18 2024
    • v1.0.4 - April, 3 2024
    • v1.0.3 - April, 2 2024
    • v1.0.2 - March, 8 2024
    • diff --git a/docs/install.html b/docs/install.html index ed7738b6..14fee3e3 100644 --- a/docs/install.html +++ b/docs/install.html @@ -1,18 +1,18 @@ - + - + - Installation — SingleStoreDB 1.0.4 documentation + Installation — SingleStoreDB 1.1.0 documentation - - - + + + @@ -28,7 +28,7 @@ SingleStoreDB
      - 1.0.4 + 1.1.0
      @@ -68,7 +68,7 @@
      -

      Installation

      +

      Installation

      The SingleStoreDB Python client can be installed using pip:

      pip install singlestoredb
       
      diff --git a/docs/license.html b/docs/license.html index 7ce1bb70..ce3894df 100644 --- a/docs/license.html +++ b/docs/license.html @@ -1,18 +1,18 @@ - + - + - License — SingleStoreDB 1.0.4 documentation + License — SingleStoreDB 1.1.0 documentation - - - + + + @@ -27,7 +27,7 @@ SingleStoreDB
      - 1.0.4 + 1.1.0
      @@ -67,7 +67,7 @@
      -

      License

      +

      License

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

          What’s New

          +

          What’s New

          This document outlines features and improvements from each release.

          Note

          @@ -124,88 +125,95 @@

          What’s New +

          v1.1.0 - April, 18 2024

          +
            +
          • Added new result types: numpy, pandas, polars, arrow

          • +
          • Added SHOW FUSION HELP command and doc to Fusion SQL handlers

          • +
          +

          -

          v1.0.4 - April, 3 2024

          +

          v1.0.4 - April, 3 2024

          • Management API updates

          -

          v1.0.3 - April, 2 2024

          +

          v1.0.3 - April, 2 2024

          • Updates to external function application API

          • Add configuration parameter for Management API base URL

          -

          v1.0.2 - March, 8 2024

          +

          v1.0.2 - March, 8 2024

          • Add singlestoredb.management.get_secret function

          • Add add_endpoint_to_firewall_ranges= parameter to create_workspace

          -

          v1.0.1 - February, 16 2024

          +

          v1.0.1 - February, 16 2024

          • Fix issues in Fusion SQL Stage commands

          • Add call function to UDF app

          -

          v1.0.0 - February, 12 2024

          +

          v1.0.0 - February, 12 2024

          • Update Stage API

          • Fixes for deferred connections

          -

          v0.10.7 - January 31, 2024

          +

          v0.10.7 - January 31, 2024

          • Add secrets managemnt to Management API

          • Refactor UDF data converters

          -

          v0.10.6 - January 26, 2024

          +

          v0.10.6 - January 26, 2024

          • Add Fusion SQL handlers for suspend and resume

          • Various Fusion SQL handler fixes

          -

          v0.10.5 - January 23, 2024

          +

          v0.10.5 - January 23, 2024

          • Add pytest plugin

          -

          v0.10.4 - January 18, 2024

          +

          v0.10.4 - January 18, 2024

          • Fix deferred connection URL in HTTP

          -

          v0.10.3 - January 17, 2024

          +

          v0.10.3 - January 17, 2024

          • Change Stage URLs

          • Fix password encoding in deferred connections

          -

          v0.10.2 - December 14, 2023

          +

          v0.10.2 - December 14, 2023

          • Make workspace group optional in Fusion SQL if it is specified in the environment

          -

          v0.10.1 - December 13, 2023

          +

          v0.10.1 - December 13, 2023

          • Cache regions in Management API

          • Add dummy fields to Region objects if the region ID does not point to an existing region

          -

          v0.10.0 - December 12, 2023

          +

          v0.10.0 - December 12, 2023

          • Add JWT authentication support to Fusion

          • Add experimental vector data format support to UDF server

          • @@ -215,91 +223,91 @@

            v0.10.0 - December 12, 2023 -

            v0.9.6 - November 2, 2023

            +

            v0.9.6 - November 2, 2023

            • Fusion fixes and testing

          -

          v0.9.5 - October 31, 2023

          +

          v0.9.5 - October 31, 2023

          • Add defaults for builtin Fusion rules

          -

          v0.9.4 - October 31, 2023

          +

          v0.9.4 - October 31, 2023

          • More Fusion enhancements

          -

          v0.9.3 - October 25, 2023

          +

          v0.9.3 - October 25, 2023

          • Fusion fixes

          -

          v0.9.2 - October 24, 2023

          +

          v0.9.2 - October 24, 2023

          • Experimental Fusion SQL interface

          -

          v0.9.1 - October 17, 2023

          +

          v0.9.1 - October 17, 2023

          • Add name / ID indexing to workspace groups / workspaces / regions

          -

          v0.9.0 - October 16, 2023

          +

          v0.9.0 - October 16, 2023

          • Add Stage to Management API

          -

          v0.8.9 - October 4, 2023

          +

          v0.8.9 - October 4, 2023

          • Add debug option for connections

          -

          v0.8.8 - September 26, 2023

          +

          v0.8.8 - September 26, 2023

          • Fix error propagation issue in C extension

          -

          v0.8.7 - September 19, 2023

          +

          v0.8.7 - September 19, 2023

          • Add encoding_errors= parameter to connection

          -

          v0.8.6 - August 29, 2023

          +

          v0.8.6 - August 29, 2023

          • Fix WITH statements in HTTP

          -

          v0.8.5 - August 29, 2023

          +

          v0.8.5 - August 29, 2023

          • Fix DESCRIBE statements in HTTP

          -

          v0.8.4 - August 28, 2023

          +

          v0.8.4 - August 28, 2023

          • Fix boolean connection options

          -

          v0.8.3 - August 23, 2023

          +

          v0.8.3 - August 23, 2023

          • Fix % escaping in HTTP queries

          -

          v0.8.2 - August 10, 2023

          +

          v0.8.2 - August 10, 2023

          • Add nan_as_null and inf_as_null options for parameter conversion support

          • Separate structsequences and namedtuples for results_type

          • @@ -307,71 +315,71 @@

            v0.8.2 - August 10, 2023

          -

          v0.8.1 - July 12, 2023

          +

          v0.8.1 - July 12, 2023

          • Add create_engine function to return SQLAlchemy engine while supporting environment variable parameter settings and settings in options

          -

          v0.8.0 - July 12, 2023

          +

          v0.8.0 - July 12, 2023

          • ! Python 3.8 is now the minimum required version

          • Add parameter conversion routines to HTTP driver

          -

          v0.7.1 - June 15, 2023

          +

          v0.7.1 - June 15, 2023

          • Add connect_timeout and multi_statements options to connection

          -

          v0.7.0 - June 9, 2023

          +

          v0.7.0 - June 9, 2023

          • Add converters for numpy array to vector blobs, and pygeos / shapely objects to geography data

          -

          v0.6.1 - May 18, 2023

          +

          v0.6.1 - May 18, 2023

          • Fix GSSAPI/Kerberos packet data

          -

          v0.6.0 - May 17, 2023

          +

          v0.6.0 - May 17, 2023

          • Added GSSAPI/Kerberos support

          -

          v0.5.4 - March 15, 2023

          +

          v0.5.4 - March 15, 2023

          • Added expiration to workspaces

          -

          v0.5.3 - January 9, 2023

          +

          v0.5.3 - January 9, 2023

          • Fixed issue with parsing numeric results

          -

          v0.5.2 - December 14, 2022

          +

          v0.5.2 - December 14, 2022

          • Fixed issues with unbuffered reads

          -

          v0.5.1 - December 9, 2022

          +

          v0.5.1 - December 9, 2022

          • Added 32-bit Windows and aarch64 Linux packages

          • Added option to log queries

          -

          v0.5.0 - December 8, 2022 (API CHANGES)

          +

          v0.5.0 - December 8, 2022 (API CHANGES)

          • ! Query parameter syntax has changed from :1 for positional and :key for dictionary keys to %s for positional and %(key)s @@ -383,38 +391,38 @@

            v0.5.0 - December 8, 2022 (API CHANGES) -

            v0.4.0 - October 19, 2022

            +

            v0.4.0 - October 19, 2022

            • Add Python 3.6 support

          -

          v0.3.3 - September 21, 2022

          +

          v0.3.3 - September 21, 2022

          • Add ssl_cipher option to connections

          • Add show accessor for database SHOW commands

          -

          v0.3.2 - September 14, 2022

          +

          v0.3.2 - September 14, 2022

          • Fixes for PyMySQL compatibility

          -

          v0.3.1 - September 9, 2022

          +

          v0.3.1 - September 9, 2022

          • Changed cipher in PyMySQL connection for SingleStoreDB Cloud compatibility

          -

          v0.3.0 - September 9, 2022

          +

          v0.3.0 - September 9, 2022

          • Changed autocommit=True by default

          -

          v0.2.0 - August 5, 2022

          +

          v0.2.0 - August 5, 2022

          • Changed to pure Python driver

          • Add workspace management objects

          • @@ -422,7 +430,7 @@

            v0.2.0 - August 5, 2022

          -

          v0.1.0 - May 6, 2022

          +

          v0.1.0 - May 6, 2022

          • DB-API compliant connections

          • HTTP API support

          • diff --git a/setup.cfg b/setup.cfg index ae79cafb..754130d0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = singlestoredb -version = 1.0.4 +version = 1.1.0 description = Interface to the SingleStoreDB database and workspace management APIs long_description = file: README.md long_description_content_type = text/markdown diff --git a/singlestoredb/__init__.py b/singlestoredb/__init__.py index 41d39e92..f39bf14c 100644 --- a/singlestoredb/__init__.py +++ b/singlestoredb/__init__.py @@ -13,7 +13,7 @@ """ -__version__ = '1.0.4' +__version__ = '1.1.0' from typing import Any