Use pandas to Visualize SingleStore Data in Python

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SingleStore Python Connector

Python Connector Libraries for SingleStore Data Connectivity. Integrate SingleStore with popular Python tools like Pandas, SQLAlchemy, Dash & petl.



The CData Python Connector for SingleStore enables you use pandas and other modules to analyze and visualize live SingleStore data in Python.

The rich ecosystem of Python modules lets you get to work quickly and integrate your systems more effectively. With the CData Python Connector for SingleStore, the pandas & Matplotlib modules, and the SQLAlchemy toolkit, you can build SingleStore-connected Python applications and scripts for visualizing SingleStore data. This article shows how to use the pandas, SQLAlchemy, and Matplotlib built-in functions to connect to SingleStore data, execute queries, and visualize the results.

With built-in optimized data processing, the CData Python Connector offers unmatched performance for interacting with live SingleStore data in Python. When you issue complex SQL queries from SingleStore, the driver pushes supported SQL operations, like filters and aggregations, directly to SingleStore and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Connecting to SingleStore Data

Connecting to SingleStore data looks just like connecting to any relational data source. Create a connection string using the required connection properties. For this article, you will pass the connection string as a parameter to the create_engine function.

The following connection properties are required in order to connect to data.

  • Server: The host name or IP of the server hosting the SingleStore database.
  • Port: The port of the server hosting the SingleStore database.
  • Database (Optional): The default database to connect to when connecting to the SingleStore Server. If this is not set, tables from all databases will be returned.

Connect Using Standard Authentication

To authenticate using standard authentication, set the following:

  • User: The user which will be used to authenticate with the SingleStore server.
  • Password: The password which will be used to authenticate with the SingleStore server.

Connect Using Integrated Security

As an alternative to providing the standard username and password, you can set IntegratedSecurity to True to authenticate trusted users to the server via Windows Authentication.

Connect Using SSL Authentication

You can leverage SSL authentication to connect to SingleStore data via a secure session. Configure the following connection properties to connect to data:

  • SSLClientCert: Set this to the name of the certificate store for the client certificate. Used in the case of 2-way SSL, where truststore and keystore are kept on both the client and server machines.
  • SSLClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
  • SSLClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
  • SSLClientCertType: The certificate type of the client store.
  • SSLServerCert: The certificate to be accepted from the server.

Connect Using SSH Authentication

Using SSH, you can securely login to a remote machine. To access SingleStore data via SSH, configure the following connection properties:

  • SSHClientCert: Set this to the name of the certificate store for the client certificate.
  • SSHClientCertPassword: If a client certificate store is password-protected, set this value to the store's password.
  • SSHClientCertSubject: The subject of the TLS/SSL client certificate. Used to locate the certificate in the store.
  • SSHClientCertType: The certificate type of the client store.
  • SSHPassword: The password that you use to authenticate with the SSH server.
  • SSHPort: The port used for SSH operations.
  • SSHServer: The SSH authentication server you are trying to authenticate against.
  • SSHServerFingerPrint: The SSH Server fingerprint used for verification of the host you are connecting to.
  • SSHUser: Set this to the username that you use to authenticate with the SSH server.

Follow the procedure below to install the required modules and start accessing SingleStore through Python objects.

Install Required Modules

Use the pip utility to install the pandas & Matplotlib modules and the SQLAlchemy toolkit:

pip install pandas
pip install matplotlib
pip install sqlalchemy

Be sure to import the module with the following:

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engine

Visualize SingleStore Data in Python

You can now connect with a connection string. Use the create_engine function to create an Engine for working with SingleStore data.

engine = create_engine("singlestore:///?User=myUser&Password=myPassword&Database=NorthWind&Server=myServer&Port=3306")

Execute SQL to SingleStore

Use the read_sql function from pandas to execute any SQL statement and store the resultset in a DataFrame.

df = pandas.read_sql("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'", engine)

Visualize SingleStore Data

With the query results stored in a DataFrame, use the plot function to build a chart to display the SingleStore data. The show method displays the chart in a new window.

df.plot(kind="bar", x="ShipName", y="ShipCity")
plt.show()

Free Trial & More Information

Download a free, 30-day trial of the SingleStore Python Connector to start building Python apps and scripts with connectivity to SingleStore data. Reach out to our Support Team if you have any questions.



Full Source Code

import pandas
import matplotlib.pyplot as plt
from sqlalchemy import create_engin

engine = create_engine("singlestore:///?User=myUser&Password=myPassword&Database=NorthWind&Server=myServer&Port=3306")
df = pandas.read_sql("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'", engine)

df.plot(kind="bar", x="ShipName", y="ShipCity")
plt.show()