Build SingleStore-Connected Web Apps in Servoy

Servoy is a rapid application development and deployment platform. When paired with the CData JDBC Driver for SingleStore, users can build SingleStore-connected apps that work with live SingleStore data. This article describes how to connect to SingleStore from Servoy and build a simple web app to display and search SingleStore data.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SingleStore data. When you issue complex SQL queries to 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). Its built-in dynamic metadata querying lets you work with SingleStore data using native data types.

Connect to SingleStore in Servoy Developer

To build SingleStore-connected apps, you need to first create a data provider in Servoy Developer using the CData JDBC Driver for SingleStore.

1. Install the JDBC Driver.
2. Copy the JDBC Driver JAR file. (cdata.jdbc.singlestore.jar) to the /application_server/drivers/ directory in the installation directory for Servoy.
3. Open Servoy Developer.
4. In the Solution Explorer, right-click Database Server (under Resources) and choose "Connect to existing database" -> "empty."
   1. Name the server.
   2. Click to show the advanced server settings.

      • Set the URL, for example: jdbc:singlestore:User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

        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.

        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.
      • Select the Driver class you just copied, for example, cdata.jdbc.singlestore.SingleStoreDriver

Build a SingleStore-Connected Web App

Once you have configured the connection to SingleStore in the Servoy Developer resources, you are ready to build apps with access to live SingleStore data.

Create a New Solution

1. In the Server Explorer, right-click "All solutions" and select "Create new solution."
2. Name the solution.
3. Select the checkbox to include the "search" module.
4. Click "Finish."

Create a New Form

Right-click "Forms" and select "Create new form."

1. Name the form.
2. Select a Datasource.
3. Set the type (e.g., Simple) and click "Finish."

Add a Data Grid to the Form

1. Drag a Data Grid component (from Servoy NG-Grids) onto the form.

2. Drag a column component onto the Data Grid and set the "dataprovider" property for each column component to a column from the SingleStore "table" (e.g., ShipName from the Orders table).

   Continue adding columns as desired.

Add Searching to the App

Note that the "svySearch" extension is required to add search functionality (included by default when you create a new solution). If you did not add the extension when you created the solution or you are modifying an existing solution, you can add the search module by right-clicking Modules (in the solution) and selecting "Add Module." Select "svySearch" and click "OK."

1. Drag a Text Field component onto the Form.
2. Right-click the Form and select "Open in Script Editor."
3. Create a new variable (JavaScript) to hold the search value:

   var searchText = '';
   

4. Back on the Form, in the Text Field properties:
   1. Set the "dataprovider" property to the Form variable you just created.
   2. Double-click to add a method for the onAction event.
   3. Click to create the method in "Form," name the method (e.g., onEnter), and click "Create private."
   4. Click "OK & Show."
5. Add the following JavaScript to the JavaScript file to use the Servoy framework to implement searching bound data based on the text in the Text Field:

   var search = scopes.svySearch.createSimpleSearch(foundset).setSearchText(searchText);
   search.setSearchAllColumns();
   search.loadRecords(foundset);
   

Save and Launch the App

Save the form and JavaScript file, then click Run -> Launch NGClient to start the web app.

Download a free, 30-day trial of the CData JDBC Driver for SingleStore and start building SingleStore-connected apps with Servoy. Reach out to our Support Team if you have any questions.