Query SingleStore Data in ColdFusion



Write standard ColdFusion data access code to connect to SingleStore data.

The CData JDBC driver for SingleStore seamlessly integrates connectivity to SingleStore data with the rapid development tools in ColdFusion. This article shows how to connect to SingleStore data in ColdFusion and query SingleStore tables.

Create a JDBC Data Source for SingleStore in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:singlestore: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the SingleStore JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.singlestore.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.singlestore.SingleStoreDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData SingleStore data source in the Actions column. After reporting a status of OK, the SingleStore data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to SingleStore, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

<cfquery name="SingleStoreQuery" dataSource="CDataSingleStore"> SELECT * FROM Orders WHERE ShipCountry = <cfqueryparam value="#ShipCountry#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#SingleStoreQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Orders WHERE ShipCountry = ?", 
  [
    { value="USA", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataSingleStore" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?ShipCountry=USA

Ready to get started?

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

 Download Now

Learn more:

SingleStore Icon SingleStore JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SingleStore.