Prep for v0.5.0 release

Author: kesmit13

README.md

@@ -3,6 +3,11 @@
 This project contains a [DB-API 2.0](https://www.python.org/dev/peps/pep-0249/)
 compatible Python interface to the SingleStore database and workspace management API.
 
+> **Warning**
+> As of version v0.5.0, the parameter substitution syntax has changed from `:1`, `:2`, etc.
+> for list parameters and `:foo`, `:bar`, etc. for dictionary parameters to `%s` and `%(foo)s`,
+> `%(bar)s` etc., respectively.
+
 ## Install
 
 This package can be install from PyPI using `pip`:

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: 2d812b3f5b715195a634ae9a9912a133
+config: 5a4ce12e77323db0db1fc2a946257ac9
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/api.rst.txt

@@ -24,7 +24,7 @@ or a connection string in the form of a URL.
 Connection
 ..........
 
-Connection objects are created by the :func:`connect` function. They are
+Connection objects are created by the :func:`singlestoredb.connect` function. They are
 used to create :class:`Cursor` objects for querying the database.
 
 .. currentmodule:: singlestoredb.connection
@@ -43,6 +43,59 @@ used to create :class:`Cursor` objects for querying the database.
    Connection.disable_data_api
 
 
+The :attr:`Connection.show` attribute of the connection objects allow you to access various
+information about the server. The available operations are shown below.
+
+.. currentmodule:: singlestoredb.connection
+
+.. autosummary::
+   :toctree: generated/
+
+   ShowAccessor.aggregates
+   ShowAccessor.columns
+   ShowAccessor.create_aggregate
+   ShowAccessor.create_function
+   ShowAccessor.create_pipeline
+   ShowAccessor.create_table
+   ShowAccessor.create_view
+   ShowAccessor.databases
+   ShowAccessor.database_status
+   ShowAccessor.errors
+   ShowAccessor.functions
+   ShowAccessor.global_status
+   ShowAccessor.indexes
+   ShowAccessor.partitions
+   ShowAccessor.pipelines
+   ShowAccessor.plan
+   ShowAccessor.plancache
+   ShowAccessor.procedures
+   ShowAccessor.processlist
+   ShowAccessor.reproduction
+   ShowAccessor.schemas
+   ShowAccessor.session_status
+   ShowAccessor.status
+   ShowAccessor.table_status
+   ShowAccessor.tables
+   ShowAccessor.warnings
+
+
+ShowResult
+^^^^^^^^^^
+
+The results of the above methods and attributes are in the form of a
+:class:`ShowResult` object. This object is primarily used to display
+information to the screen or web browser, but columns from the output
+can also be accessed using dictionary-like key access syntax or
+attributes.
+
+.. currentmodule:: singlestoredb.connection
+
+.. autosummary::
+   :toctree: generated/
+
+   ShowResult
+
+
 Cursor
 ......
 
@@ -186,15 +239,15 @@ values.
 
    import singlestoredb as s2
 
-   s2.describe_option('results.format')
+   s2.describe_option('local_infile')
 
-   s2.options.results.format
+   s2.options.local_infile
 
-   s2.options.results.format = 'namedtuple'
+   s2.options.local_infile = True
 
-   s2.describe_option('results.format')
+   s2.describe_option('local_infile')
 
 .. ipython:: python
    :suppress:
 
-   s2.options.results.format = 'tuple'
+   s2.options.local_infile = False

docs/_sources/generated/singlestoredb.connection.Connection.rst.txt

@@ -17,6 +17,7 @@
       ~Connection.autocommit
       ~Connection.close
       ~Connection.commit
+      ~Connection.connect
       ~Connection.cursor
       ~Connection.disable_data_api
       ~Connection.disable_http_api
@@ -33,9 +34,10 @@
 
    .. autosummary::
 
+      ~Connection.driver
       ~Connection.messages
+      ~Connection.paramstyle
       ~Connection.show
-      ~Connection.results_format
       ~Connection.encoding
       ~Connection.globals
       ~Connection.locals

docs/_sources/generated/singlestoredb.connection.Cursor.rst.txt

@@ -37,9 +37,9 @@
    .. autosummary::
 
       ~Cursor.connection
-      ~Cursor.rownumber
       ~Cursor.description
+      ~Cursor.messages
+      ~Cursor.rownumber
       ~Cursor.arraysize
       ~Cursor.rowcount
-      ~Cursor.messages
       ~Cursor.lastrowid

docs/_sources/generated/singlestoredb.connection.ShowAccessor.aggregates.rst.txt

@@ -0,0 +1,6 @@
+singlestoredb.connection.ShowAccessor.aggregates
+================================================
+
+.. currentmodule:: singlestoredb.connection
+
+.. automethod:: ShowAccessor.aggregates

docs/_sources/generated/singlestoredb.connection.ShowAccessor.columns.rst.txt

@@ -0,0 +1,6 @@
+singlestoredb.connection.ShowAccessor.columns
+=============================================
+
+.. currentmodule:: singlestoredb.connection
+
+.. automethod:: ShowAccessor.columns

docs/_sources/generated/singlestoredb.connection.ShowAccessor.create_aggregate.rst.txt

@@ -0,0 +1,6 @@
+singlestoredb.connection.ShowAccessor.create\_aggregate
+=======================================================
+
+.. currentmodule:: singlestoredb.connection
+
+.. automethod:: ShowAccessor.create_aggregate

docs/_sources/generated/singlestoredb.connection.ShowAccessor.create_function.rst.txt

@@ -0,0 +1,6 @@
+singlestoredb.connection.ShowAccessor.create\_function
+======================================================
+
+.. currentmodule:: singlestoredb.connection
+
+.. automethod:: ShowAccessor.create_function

docs/_sources/generated/singlestoredb.connection.ShowAccessor.create_pipeline.rst.txt

@@ -0,0 +1,6 @@
+singlestoredb.connection.ShowAccessor.create\_pipeline
+======================================================
+
+.. currentmodule:: singlestoredb.connection
+
+.. automethod:: ShowAccessor.create_pipeline