Skip to content

Commit e278470

Browse files
kesmit13kesmit13
committed
Prep for v0.5.0 release
1 parent 0df1507 commit e278470

File tree

127 files changed

+5805
-418
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+5805
-418
lines changed

‎README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
This project contains a [DB-API 2.0](https://www.python.org/dev/peps/pep-0249/)
44
compatible Python interface to the SingleStore database and workspace management API.
55

6+
> **Warning**
7+
> As of version v0.5.0, the parameter substitution syntax has changed from `:1`, `:2`, etc.
8+
> for list parameters and `:foo`, `:bar`, etc. for dictionary parameters to `%s` and `%(foo)s`,
9+
> `%(bar)s` etc., respectively.
10+
611
## Install
712

813
This package can be install from PyPI using `pip`:

‎docs/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2d812b3f5b715195a634ae9a9912a133
3+
config: 5a4ce12e77323db0db1fc2a946257ac9
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/api.rst.txt

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ or a connection string in the form of a URL.
2424
Connection
2525
..........
2626

27-
Connection objects are created by the :func:`connect` function. They are
27+
Connection objects are created by the :func:`singlestoredb.connect` function. They are
2828
used to create :class:`Cursor` objects for querying the database.
2929

3030
.. currentmodule:: singlestoredb.connection
@@ -43,6 +43,59 @@ used to create :class:`Cursor` objects for querying the database.
4343
Connection.disable_data_api
4444

4545

46+
The :attr:`Connection.show` attribute of the connection objects allow you to access various
47+
information about the server. The available operations are shown below.
48+
49+
.. currentmodule:: singlestoredb.connection
50+
51+
.. autosummary::
52+
:toctree: generated/
53+
54+
ShowAccessor.aggregates
55+
ShowAccessor.columns
56+
ShowAccessor.create_aggregate
57+
ShowAccessor.create_function
58+
ShowAccessor.create_pipeline
59+
ShowAccessor.create_table
60+
ShowAccessor.create_view
61+
ShowAccessor.databases
62+
ShowAccessor.database_status
63+
ShowAccessor.errors
64+
ShowAccessor.functions
65+
ShowAccessor.global_status
66+
ShowAccessor.indexes
67+
ShowAccessor.partitions
68+
ShowAccessor.pipelines
69+
ShowAccessor.plan
70+
ShowAccessor.plancache
71+
ShowAccessor.procedures
72+
ShowAccessor.processlist
73+
ShowAccessor.reproduction
74+
ShowAccessor.schemas
75+
ShowAccessor.session_status
76+
ShowAccessor.status
77+
ShowAccessor.table_status
78+
ShowAccessor.tables
79+
ShowAccessor.warnings
80+
81+
82+
ShowResult
83+
^^^^^^^^^^
84+
85+
The results of the above methods and attributes are in the form of a
86+
:class:`ShowResult` object. This object is primarily used to display
87+
information to the screen or web browser, but columns from the output
88+
can also be accessed using dictionary-like key access syntax or
89+
attributes.
90+
91+
.. currentmodule:: singlestoredb.connection
92+
93+
.. autosummary::
94+
:toctree: generated/
95+
96+
ShowResult
97+
98+
4699
Cursor
47100
......
48101

@@ -186,15 +239,15 @@ values.
186239
187240
import singlestoredb as s2
188241
189-
s2.describe_option('results.format')
242+
s2.describe_option('local_infile')
190243
191-
s2.options.results.format
244+
s2.options.local_infile
192245
193-
s2.options.results.format = 'namedtuple'
246+
s2.options.local_infile = True
194247
195-
s2.describe_option('results.format')
248+
s2.describe_option('local_infile')
196249
197250
.. ipython:: python
198251
:suppress:
199252
200-
s2.options.results.format = 'tuple'
253+
s2.options.local_infile = False

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
~Connection.autocommit
1818
~Connection.close
1919
~Connection.commit
20+
~Connection.connect
2021
~Connection.cursor
2122
~Connection.disable_data_api
2223
~Connection.disable_http_api
@@ -33,9 +34,10 @@
3334

3435
.. autosummary::
3536

37+
~Connection.driver
3638
~Connection.messages
39+
~Connection.paramstyle
3740
~Connection.show
38-
~Connection.results_format
3941
~Connection.encoding
4042
~Connection.globals
4143
~Connection.locals

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737
.. autosummary::
3838

3939
~Cursor.connection
40-
~Cursor.rownumber
4140
~Cursor.description
41+
~Cursor.messages
42+
~Cursor.rownumber
4243
~Cursor.arraysize
4344
~Cursor.rowcount
44-
~Cursor.messages
4545
~Cursor.lastrowid

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.aggregates
2+
================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.aggregates

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.columns
2+
=============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.columns

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.create\_aggregate
2+
=======================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.create_aggregate

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.create\_function
2+
======================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.create_function

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.create\_pipeline
2+
======================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.create_pipeline

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.create_table.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.create\_table
2+
===================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.create_table

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.create_view.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.create\_view
2+
==================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.create_view

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.database_status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.database\_status
2+
======================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.database_status

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.databases.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.databases
2+
===============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.databases

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.errors.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.errors
2+
============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.errors

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.functions.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.functions
2+
===============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.functions

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.global_status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.global\_status
2+
====================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.global_status

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.indexes.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.indexes
2+
=============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.indexes

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.partitions.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.partitions
2+
================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.partitions

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.pipelines.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.pipelines
2+
===============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.pipelines

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.plan.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.plan
2+
==========================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.plan

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.plancache.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.plancache
2+
===============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.plancache

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.procedures.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.procedures
2+
================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.procedures

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.processlist.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.processlist
2+
=================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.processlist

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.reproduction.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.reproduction
2+
==================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.reproduction

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.schemas.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.schemas
2+
=============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.schemas

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.session_status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.session\_status
2+
=====================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.session_status

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.status
2+
============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.status

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.table_status.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.table\_status
2+
===================================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.table_status

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.tables.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.tables
2+
============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.tables

‎docs/_sources/generated/singlestoredb.connection.ShowAccessor.warnings.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
singlestoredb.connection.ShowAccessor.warnings
2+
==============================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. automethod:: ShowAccessor.warnings

‎docs/_sources/generated/singlestoredb.connection.ShowResult.rst.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
singlestoredb.connection.ShowResult
2+
===================================
3+
4+
.. currentmodule:: singlestoredb.connection
5+
6+
.. autoclass:: ShowResult
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~ShowResult.__init__
17+
~ShowResult.count
18+
~ShowResult.index

0 commit comments

Comments
 (0)