How to Generate SQL Command Schemas for the CData BizTalk Adapter for SingleStore

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SingleStore BizTalk Adapter

Powerful BizTalk Adapters that allow you to easily connect BizTalk Server with live SingleStore data through standard orchestrations.

Use the SingleStore Adapters to synchronize with SingleStore. Perfect for data synchronization, local back-ups, workflow automation, and more!



The CData BizTalk Adapter makes it easy to process SingleStore data in BizTalk by returning the data as XML. You can use this data in a BizTalk orchestration by creating an XML schema file for the table you want to access in BizTalk.

This article will show how to generate a schema to process SingleStore data retrieved using the CData BizTalk Adapter. You will generate a schema for a SELECT command.

This guide shows how to use the CData BizTalk Adapter for SingleStore to execute SQL commands to SingleStore.

Add the Adapter for SingleStore to Your Project

Follow the steps below to add the adapter to a BizTalk Server project.

  1. If you have not already done so, create a new BizTalk Server project in Visual Studio.
  2. Right-click on the project in the Solution Explorer and click Add -> Add Generated Items.
  3. Select Add Adapter Metadata in the resulting dialog box.
  4. In the resulting Add Adapter wizard, select the adapter from the list.
  5. In the Port menu, leave the selection blank. You can also select a receive location or send port that has the adapter configured as its transport type.

Generate a Schema for an SQL Command

After you select the adapter in the Add Adapter wizard, the Schema wizard is displayed. Follow the steps below to configure connection properties and retrieve the metadata for the results of the command.

  1. In the Connection String page, enter authentication credentials and other connection properties, if you did not select an adapter that you have already configured in your BizTalk application. Below is a typical connection string: User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;

    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.

  2. In the General Options section on the next page, Schema Information, select Send Port or Receive Location, depending on the adapter configuration.
  3. If you want to generate the schema for the entire result set, select the Single Message option in the Message Mode menu. If you want to generate one schema for each row in the result set, select the Message Per Row option and confirm that the root element of the message is 'row'.
  4. In the Command Type menu, select SQL Command.
  5. In the SQL Command Text box on the Statement Information page, enter an SQL command. (If you have configured a receive location or send port, the SQL command you configured is entered in the box.) This example uses the query below:

    SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'

  6. Confirm the settings in the summary displayed by the wizard and click Finish to generate the schema.xsd file.

Processing Schemas

To use schemas in a simple BizTalk application, see the tutorial.