Axios is a JavaScript library that allows developers to make HTTP requests to servers from a web browser or Node.js. When paired with CData Connect AI, you get access to live SingleStore data for your web apps. This article shows how to connect to SingleStore and build web apps in Axios with access to live SingleStore data.
Connect to SingleStore from Axios
To work with SingleStore in Axios, we need to connect to SingleStore from Connect AI, provide user access to
the connection, and create a Workspace for the SingleStore data.
Connect to SingleStore from Connect AI
CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.
-
Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection
- Select "SingleStore" from the Add Connection panel
👁 Selecting a data source
-
Enter the necessary authentication properties to connect to SingleStore.
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.
👁 Configuring a connection (Salesforce is shown)
-
Click Save & Test
-
Navigate to the Permissions tab in the Add SingleStore Connection page and update the User-based permissions.
👁 Updating permissions
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
-
Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
-
On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
👁 Creating a new PAT
-
The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
Configure SingleStore Endpoints for Axios
After connecting to SingleStore, create a workspace for your desired table(s).
-
Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
👁 The Workspaces page.
👁 Adding a new Workspace.
-
Click Add to add new assets to the Workspace.
-
Select the SingleStore connection (e.g. SingleStore1) and click Next.
👁 Selecting an Asset (Salesforce is shown).
-
Select the table(s) you wish to work with and click Confirm.
👁 Selecting Tables (Salesforce is shown).
-
Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
With the connection, PAT, and Workspace configured, you are ready to connect to SingleStore data from Axios.
Connect to SingleStore Data in Axios Workflows
To establish a connection from Axios to CData Connect AI using the OData protocol, follow these steps.
- Create a project directory for your web app. For example: ~/connect_cloud/
- Open a terminal, navigate the the project directory and initialize a node project using the command:
npm init -y
- Install the Axios dependency in the project using the following command:
npm install axios
In your project directory, create a file called server.js that contains the following code. Provide your CData Connect AI username (e.g. [email protected]) and PAT (the PAT you created in the prerequisites). You must also provide a query for your data, such as SELECT * FROM SingleStore1.SCHEMA.Orders.
server.js code
const axios = require('axios')
const user = '[email protected]'
const pat = '***********************************';
//Your API endpoint
const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';
//Your data to be sent in the POST request
const data = {
"query":"SELECT * FROM {workspace_name}.SCHEMA.Orders"
};
axios.post(url, data, {
auth: {
username: user,
password: pat
}
})
.then(response => {
const rows = response.data.results[0].rows;
const schema = response.data.results[0].schema;
//Create an array of column names
const columnNames = schema.map(col => col.columnName);
//Loop through each row and log the column name with its value
rows.forEach(row => {
const rowObject = {};
row.forEach((value, index) => {
const columnName = columnNames[index];
rowObject[columnName] = value;
});
console.log(rowObject);
})
})
.catch(error => {
console.error('Error:', error);
});
- In the terminal, execute the following command to run the server:
node server.js
The query results will appear:
{ ID: 1, VALUE: -2 }
{ ID: 2, VALUE: 1 }
{ ID: 11, VALUE: null }
{ ID: 3, VALUE: 2 }
{ ID: 4, VALUE: 5 }
...
Simplified Access to SingleStore Data from Cloud Applications
At this point, you have a direct connection to live SingleStore data from Axios. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Axios, refer to our Connect AI page.
