Skip to main content

Interface to the SingleStore database and cluster management APIs

Project description

SingleStoreDB Python Interface

This project contains a DB-API 2.0 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:

pip install singlestoredb

Documentation

https://singlestore-labs.github.io/singlestoredb-python

Usage

Connections to the SingleStore database are made using the DB-API parameters host, port, user, password, etc, but they may also be done using URLs that specify these parameters as well (much like the SQLAlchemy package).

import singlestoredb as s2

# Connect using the default connector
conn = s2.connect('user:password@host:3306/db_name')

# Create a cursor
cur = conn.cursor()

# Execute SQL
cur.execute('select * from foo')

# Fetch the results
print(cur.description)
for item in cur:
    print(item)

# Close the connection
conn.close()

Connecting to the HTTP API is done as follows:

# Use the HTTP API connector
conn = s2.connect('https://user:password@host:8080/db_name')

Performance

While this package is based on PyMySQL which is a pure Python-based MySQL connector, it adds various performance enhancements that make it faster than most other connectors. The performance improvements come from changes to the data conversion functions, cursor implementations, and a C extension that is highly optimized to improve row data reading.

The package can be used both in a pure Python mode and as well as a C accelerated mode. Generally speaking, the C accelerated version of the client can read data 10X faster than PyMySQL, 2X faster than MySQLdb, and 1.5X faster than mysql.connector. All of this is done without having to install any 3rd party MySQL libraries!

Benchmarking was done with a table of 3,533,286 rows each containing a datetime, a float, and eight character columns. The data is the same data set used in this article. The client and server were running on the same machine and queries were made using fetchone, fetchall, fetchmany(1000), and an iterator over the cursor object (e.g., iter(cur)). The results are shown below.

Buffered

PyMySQL MySQLdb mysql.connector SingleStore (pure Python) SingleStore
fetchall 37.0s 8.7s 5.6s 29.0s 3.7s
fetchmany(1000) 37.4s 9.2s 6.2s 29.6s 3.6s
fetchone 38.2s 10.1s 10.2s 30.9s 4.8s
iter(cur) 38.3s 9.1s 10.2s 30.4s 4.4s

Unbuffered

PyMySQL MySQLdb mysql.connector SingleStore (pure Python) SingleStore
fetchall 39.0s 6.5s 5.5s 30.3s 5.5s
fetchmany(1000) 39.4s 7.0s 6.0s 30.4s 4.1s
fetchone 34.5s 8.9s 10.1s 30.8s 6.6s
iter(cur) 39.0s 9.0s 10.2s 31.4s 6.0s

License

This library is licensed under the Apache 2.0 License.

Resources

User agreement

SINGLESTORE, INC. ("SINGLESTORE") AGREES TO GRANT YOU AND YOUR COMPANY ACCESS TO THIS OPEN SOURCE SOFTWARE CONNECTOR ONLY IF (A) YOU AND YOUR COMPANY REPRESENT AND WARRANT THAT YOU, ON BEHALF OF YOUR COMPANY, HAVE THE AUTHORITY TO LEGALLY BIND YOUR COMPANY AND (B) YOU, ON BEHALF OF YOUR COMPANY ACCEPT AND AGREE TO BE BOUND BY ALL OF THE OPEN SOURCE TERMS AND CONDITIONS APPLICABLE TO THIS OPEN SOURCE CONNECTOR AS SET FORTH BELOW (THIS “AGREEMENT”), WHICH SHALL BE DEFINITIVELY EVIDENCED BY ANY ONE OF THE FOLLOWING MEANS: YOU, ON BEHALF OF YOUR COMPANY, CLICKING THE “DOWNLOAD, “ACCEPTANCE” OR “CONTINUE” BUTTON, AS APPLICABLE OR COMPANY’S INSTALLATION, ACCESS OR USE OF THE OPEN SOURCE CONNECTOR AND SHALL BE EFFECTIVE ON THE EARLIER OF THE DATE ON WHICH THE DOWNLOAD, ACCESS, COPY OR INSTALL OF THE CONNECTOR OR USE ANY SERVICES (INCLUDING ANY UPDATES OR UPGRADES) PROVIDED BY SINGLESTORE. BETA SOFTWARE CONNECTOR

Customer Understands and agrees that it is being granted access to pre-release or “beta” versions of SingleStore’s open source software connector (“Beta Software Connector”) for the limited purposes of non-production testing and evaluation of such Beta Software Connector. Customer acknowledges that SingleStore shall have no obligation to release a generally available version of such Beta Software Connector or to provide support or warranty for such versions of the Beta Software Connector for any production or non-evaluation use.

NOTWITHSTANDING ANYTHING TO THE CONTRARY IN ANY DOCUMENTATION, AGREEMENT OR IN ANY ORDER DOCUMENT, SINGLESTORE WILL HAVE NO WARRANTY, INDEMNITY, SUPPORT, OR SERVICE LEVEL, OBLIGATIONS WITH RESPECT TO THIS BETA SOFTWARE CONNECTOR (INCLUDING TOOLS AND UTILITIES).

APPLICABLE OPEN SOURCE LICENSE: Apache 2.0

IF YOU OR YOUR COMPANY DO NOT AGREE TO THESE TERMS AND CONDITIONS, DO NOT CHECK THE ACCEPTANCE BOX, AND DO NOT DOWNLOAD, ACCESS, COPY, INSTALL OR USE THE SOFTWARE OR THE SERVICES.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

singlestoredb-0.7.0.tar.gz (156.0 kB view details)

Uploaded Source

Built Distributions

singlestoredb-0.7.0-cp36-abi3-win_amd64.whl (185.7 kB view details)

Uploaded CPython 3.6+ Windows x86-64

singlestoredb-0.7.0-cp36-abi3-win32.whl (185.2 kB view details)

Uploaded CPython 3.6+ Windows x86

singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (216.3 kB view details)

Uploaded CPython 3.6+ manylinux: glibc 2.17+ x86-64

singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (217.0 kB view details)

Uploaded CPython 3.6+ manylinux: glibc 2.17+ ARM64

singlestoredb-0.7.0-cp36-abi3-macosx_10_9_universal2.whl (195.7 kB view details)

Uploaded CPython 3.6+ macOS 10.9+ universal2 (ARM64, x86-64)

File details

Details for the file singlestoredb-0.7.0.tar.gz.

File metadata

  • Download URL: singlestoredb-0.7.0.tar.gz
  • Upload date:
  • Size: 156.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for singlestoredb-0.7.0.tar.gz
Algorithm Hash digest
SHA256 2aa58a21422d2505ec024fe00e8d76695fd08eb19504fe192320c52f99652d2f
MD5 02ee6d47fe5f83fba6884a7d151390e0
BLAKE2b-256 a3908c3b28ca44cae8987d31fb07e2f0c1cc5056fde85d2493f87b7020f66bf2

See more details on using hashes here.

File details

Details for the file singlestoredb-0.7.0-cp36-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for singlestoredb-0.7.0-cp36-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 1ac1477648a27bfa49980ada9bd204ace502a183e8615e213ef51790c954f6a8
MD5 17c5227a2cece594bac19c92e038b86f
BLAKE2b-256 2bb974c8b22995b69aea446176e3b213fe72a76d710621f06c75c09b5082f2a0

See more details on using hashes here.

File details

Details for the file singlestoredb-0.7.0-cp36-abi3-win32.whl.

File metadata

  • Download URL: singlestoredb-0.7.0-cp36-abi3-win32.whl
  • Upload date:
  • Size: 185.2 kB
  • Tags: CPython 3.6+, Windows x86
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for singlestoredb-0.7.0-cp36-abi3-win32.whl
Algorithm Hash digest
SHA256 011e027725c2658ce396aff46eda35919ebcc9067df8852df6d25d74c1dbc183
MD5 caffa0dffec1648c60b18a0e7b9d7f35
BLAKE2b-256 ba08e6bfe07437892f50123afef0515cf1092a20753d2daea9e17bad80d54115

See more details on using hashes here.

File details

Details for the file singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 35e879fb457933961519ea207aee65dc58c42acd27ebcca4ddde05f9188c2956
MD5 dcdfab80566852c23efdfd8f4c1d33f4
BLAKE2b-256 1b180adbc9c1e9cdd6e1b3f55114efa167966774d12d02abed38f8d920bb6365

See more details on using hashes here.

File details

Details for the file singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for singlestoredb-0.7.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 87ac83b345a81cb17f99b49d5ec7a27593a4156ef611430987037d998bbb2f8c
MD5 9323954d6e6898ca1017685ef281e4fe
BLAKE2b-256 dfcd2f3732e722715427dbd5e437dda5f8e4b131b6cc938f714b473a0a0d3e5b

See more details on using hashes here.

File details

Details for the file singlestoredb-0.7.0-cp36-abi3-macosx_10_9_universal2.whl.

File metadata

File hashes

Hashes for singlestoredb-0.7.0-cp36-abi3-macosx_10_9_universal2.whl
Algorithm Hash digest
SHA256 24b388ae8a266adf52fdf32f7f7b8ec1d9bc1c643ae609d9739c1e04404136f4
MD5 aa239ebc754c21a57d94266aa44d8bce
BLAKE2b-256 95feca967167b704b24ca70f735d2ce8d19494d7523e4d72213e25bcf123b415

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page