Learn more
 

Ready to get started?

Download a free trial of the SingleStore ODBC Driver to get started:

 Download Now

Learn more:

SingleStore Icon SingleStore ODBC Driver

The SingleStore ODBC Driver is a powerful tool that allows you to connect with live data from SingleStore, directly from any applications that support ODBC connectivity.

Access SingleStore data like you would a database - read, write, and update SingleStore. through a standard ODBC Driver interface.

In this article

Related articles

Natively Connect to SingleStore Data in PHP


The CData ODBC driver for SingleStore enables you to create PHP applications with connectivity to SingleStore data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for SingleStore into your LAMP or WAMP stack to build SingleStore-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to SingleStore data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Establish a Connection

Open the connection to SingleStore by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC SingleStore Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC SingleStore Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC SingleStore Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?"); $success = odbc_execute($query, array('USA'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC SingleStore Source","user","password"); $query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC SingleStore data Source","user","password"); $query = odbc_exec($conn, "SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'"); while($row = odbc_fetch_array($query)){ echo $row["ShipName"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC SingleStore data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ShipCountry = ?"); $success = odbc_execute($query, array('USA')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are SingleStore-specific adaptations of the PHP community documentation for all ODBC functions.