Skip to main content

DB-API connector for SQream DB

Project description

  • Version: 1.0.14

  • Supported SQream DB versions: >= Blue cloud

The Python connector for SQream DB is a Python DB API 2.0-compliant interface for developing Python applications with SQream DB.

The SQream Python connector provides an interface for creating and running Python applications that can connect to a SQream DB database. It provides a lighter-weight alternative to working through native C++ or Java bindings, including JDBC and ODBC drivers.

pysqream conforms to Python DB-API specifications PEP-249

pysqream_blue is native and pure Python, with minimal requirements. It can be installed with pip on any operating system, including Linux, Windows, and macOS.


  • Python 3.6.5+, with 3.7+ highly recommended

Installing the Python connector


1. Python

The connector requires Python 3.6.5 or newer. To verify your version of Python:

$ python --version
Python 3.7.3

Note: If both Python 2.x and 3.x are installed, you can run python3 and pip3 instead of python and pip respectively for the rest of this guide

2. PIP

The Python connector is installed via pip, the Python package manager and installer.

We recommend upgrading to the latest version of pip before installing. To verify that you are on the latest version, run the following command:

$ python -m pip install --upgrade pip
Collecting pip
   Downloading (1.4MB)
     |████████████████████████████████| 1.4MB 1.6MB/s
Installing collected packages: pip
  Found existing installation: pip 19.1.1
    Uninstalling pip-19.1.1:
      Successfully uninstalled pip-19.1.1
Successfully installed pip-19.3.1

Install via pip

The Python connector is available via PyPi.

Install the connector with pip:

$ pip install pysqream-blue

pip will automatically installs all necessary libraries and modules.

Validate the installation

Create a file called (make sure to replace the parameters in the connection with the respective parameters for your SQream DB installation):

#!/usr/bin/env python

import pysqream_blue

Connection parameters include:
* IP/Hostname
* Port
* database name
* username
* password
* Connect through load balancer, or direct to worker (Default: false - direct to worker)
* use SSL connection (default: false)
* Optional service queue (default: 'sqream')

# Create a connection object

con = pysqream_blue.connect(host='', port='80',
                            database='master', username='sqream', password='sqream')

# Create a new cursor
cur = con.cursor()

# Prepare and execute a query
cur.execute('select 1')

result = cur.fetchall() # `fetchall` gets the entire data set

print(f"Result: {result}")

# This should print the SQream DB version. For example ``Version: v2020.1``.

# close statement

# Finally, close the connection


To enable logging, pass a path to a log file in the connection string as follows:

con = pysqream_blue.connect('', '80', log = '/path/to/logfile.xx')

Or pass True to save to ‘/tmp/sqream_dbapi.log’:

con = pysqream_blue.connect('', '80', log =True)

TODO (when server support):

  • use ssl connection.

  • send the token recived in authentication in every following request as call credentials (compile, execute, etc).

  • parametered queries / network insert. the existing code related to those points is a preparation and not reliable.

Differences from V1 pysqream (from user view):

  • The parameters to connect function are different (some were removed and some were added).

  • SSL connection not supported.

  • executemany() (- network insert) not supported.

Design decisions:

  • The grpc chunnel and stubs are opened and closed by __init__ and __del__ methods (which call _connect_to_server() and _disconnect_server() where the implementation itself is). The authentication with sqream and receipt a token made by connect_database() method (while close() close it). User can call close() and then connect_database() for swiching between databases on the same server. It may make sense to decide to close the chunnel as well in close() method (which is a part of DB API).

  • The same chunnel and stubs used for all cursors of a connection but every cursor open his own token. it may make sense to decide to use different stubs or chunnel for every cursor or to use the same token for all.

  • Fetch methods return list of list and not list of tuple

License-File: LICENSE


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

pysqream-blue-1.0.14.tar.gz (17.9 kB view hashes)

Uploaded source

Built Distribution

pysqream_blue-1.0.14-py3-none-any.whl (21.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page