SingleStore

The SingleStore connector lets you perform insert, delete, update, and read operations on SingleStore database.

Before you begin

Before using the SingleStore connector, do the following tasks:

• In your Google Cloud project:
  • Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
  • Grant the roles/connectors.admin IAM role to the user configuring the connector.
  • Grant the following IAM roles to the service account that you want to use for the connector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.

  • Enable the following services:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    To understand how to enable services, see Enabling services.

  If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

1. In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.

   Go to the Connections page

2. Click + CREATE NEW to open the Create Connection page.
3. In the Location section, choose the location for the connection.
   1. Region: Select a location from the drop-down list.

      For the list of all the supported regions, see Locations.

   2. Click NEXT.
4. In the Connection Details section, complete the following:
   1. Connector: Select SingleStore from the drop down list of available Connectors.
   2. Connector version: Select the Connector version from the drop down list of available versions.
   3. In the Connection Name field, enter a name for the Connection instance.

      Connection names must meet the following criteria:

      • Connection names can use letters, numbers, or hyphens.
      • Letters must be lower-case.
      • Connection names must begin with a letter and end with a letter or number.
      • Connection names cannot exceed 49 characters.
   4. Optionally, enter a Description for the connection instance.
   5. Optionally, enable Cloud logging, and then select a log level. By default, the log level is set to Error.
   6. Service Account: Select a service account that has the required roles.
   7. Optionally, configure the Connection node settings:
      • Minimum number of nodes: Enter the minimum number of connection nodes.
      • Maximum number of nodes: Enter the maximum number of connection nodes.

      A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.

   Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
   8. Database: The name of the SingleStore database.
   9. Allow User Variables: When set to True, user variables (prefixed by an @) can be used in SQL queries.
   10. Characterset: The default client character set used by the provider. For example, 'utf8'.
   11. Zero Dates To Null: Whether or not to return Date and DateTime values consisting of all zeros as NULL.
   12. BrowsableSchemas: This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
   13. Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
   14. Click NEXT.
5. In the Destinations section, enter details of the remote host (backend system) you want to connect to.
   1. Destination Type: Select a Destination Type.
      • Select Host address from the list to specify the hostname or IP address of the destination.
      • If you want to establish a private connection to your backend systems, select Endpoint attachment from the list, and then select the required endpoint attachment from the Endpoint Attachment list.
        Note: To understand how to create an endpoint attachment, see PSC service attachment and endpoint attachment. After you have created the endpoint attachment, it will be visible in the Endpoint Attachment list.

      If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.

      To enter additional destinations, click +ADD DESTINATION.

   2. Click NEXT.
6. In the Authentication section, enter the authentication details.
   1. Select an Authentication type and enter the relevant details.

      The following authentication types are supported by the SingleStore connection:

      • Username and password

   To understand how to configure these authentication types, see Configure authentication.

   2. Click NEXT.
7. Review: Review your connection and authentication details.
8. Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

• Username and password
  • Username: Username for connector
  • Password: Secret Manager Secret containing the password associated with the connector.

SingleStore configuration

To configure authentication for SingleStore, do the following:

• Set up a SingleStore account
• Set up a SingleStore database and destination details
• Set up username and password authentication

Set up SingleStore account

1. Sign up for a free-trial SingleStore account.
2. Login to the SingleStore account.

You can use the gmail, Microsoft or your company email address to login.

Set up SingleStore database and destination details

1. Go to Instances or Databases after logging in.
2. Click on your database instance to view its details. Find the database name associated with your SingleStore instance.

Connect to this database to access your data.

3. Go to Cloud in the navigation menu, click on an existing workspace.
4. On the Overview tab, view the workspace and database in the workspace.

It shows options to create a new workspace or database.

5. Find the server hostname or IP address and the port number associated with your SingleStore database instance in the instance details.

This information is typically provided along with connection details.

For information about creating a SingleStore database, see Create a database.

Set up username and password authentication

1. Enter the username or mail ID used to login to the SingleStore instance.
2. Enter the password used for logging into the SingleStore instance.

   For information about SingleStore workspace and creating a database, see SingleStore documentation.

Connection configuration samples

This section lists the sample values for the various fields that you configure when creating the SingleStore connection.

SingleStore username password connection type

Field name	Details
Location	europe-west1
Connector	Singlestore
Connector version	1
Connection Name	google-cloud-singlestore-conn
Enable Cloud Logging	Yes
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verbosity level	5
Minimum number of nodes	2
Maximum number of nodes	50
SSL Configuration	No
Destinations	If your destination is in a private network, create an endpoint attachment to access it.
Host address	HOST_ADDRESS
Port	PORT
Username	USERNAME
Password	PASSWORD
Secret version	1

SingleStore SSL connection type

Field name	Details
Location	Europe-West1
Connector	Singlestore
Connector version	1
Connection Name	google-cloud-singlestore-ssl-conn
Enable Cloud Logging	Yes
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Verbosity level	5
Minimum number of nodes	2
Maximum number of nodes	50
SSL Configuration	Enable SSL
Insecure Connection	Trust all certificates
Client Certificate	CLIENT_CERTIFICATE.
Secret Version	1
Client Private Key	Select a secret containing the client private key in PEM format.
Secret Version	1
Client Private Key Passphrase	CLIENT_PRIVATE_KEY_PASSPHRASE
Secret Version	1
Destinations	If your destination is in a private network, create an endpoint attachment to access it.
Host address	HOST_ADDRESS
Port	PORT
Username	USERNAME
Password	PASSWORD
Secret version	1

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Note: You can view the entities, operations, and actions of a connector in the Connectors task.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Note: All entities and actions will have a schema associated with them. For example, an action schema will have the parameter details such as; the parameter names, and its corresponding data type. The schema (metadata) for entities and actions is fetched by the connection at runtime from your backend. If there are any updates to the schema, such updates won't be automatically reflected in your existing connections; you must manually refresh the schema. To refresh the schema for a connection, open the Connection details page of the connection, and then click Refresh connection schema.

System limitations

The SingleStore connector can process 10 transactions per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

• If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
• If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Entity operation examples

Example - List records of an entity

This example lists the records of the Users entity.

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the List operation, and then click Done.
4. In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.

   For example, setting the filter clause to employeeCode='5100' and startDate='2010-01-01 00:00:00', lists only those records whose employeeCode is 5100 and startDate is 2010-01-01 00:00:00.

Example - Get a single record from an entity

This example fetches a record from the Users entity.

1. In the Configure connector task dialog, click Entities.
2. Select User from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 103032 in the Default Value field.

   Here, 103032 is the primary key value of the Users entity.

Example - Delete a record from an entity

This example deletes a record from the Users entity.

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.

   Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Example - Create a record in an entity

This example creates a record in the Users entity.

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "employeeCode": "5100",
   "startDate": "2010-01-01 00:00:00.0",
   "country": "US"
   }

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the create operation.

Example - Update a record in an entity

This example updates a record in the Users entity.

1. In the Configure connector task dialog, click Entities.
2. Select Users from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "country": "IN"
   }

5. In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.

   Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the update operation.

Actions

This section lists the actions supported by the connector. To understand how to configure the actions, see Action examples.

ExecuteCustomQuery action

This action lets you execute a custom query.

To create a custom query, follow these steps:

1. Follow the detailed instructions to add a connectors task.
2. When you configure the connector task, in the type of action you want to perform, select Actions.
3. In the Action list, select Execute custom query, and then click Done.

   

4. Expand the Task input section, and then do the following:
   1. In the Timeout after field, enter the number of seconds to wait till the query executes.

      Default value: 180 seconds.

   2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.

      Default value: 25.

   3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.

      

   4. In the Script editor dialog, enter the SQL query and click Save.

      You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:

      SELECT * FROM Employees where LastName=?

      Note: Data manipulation language (DML) and data definition language (DDL) statements are supported.
   5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.

      

      To add query parameters, do the following:

      1. From the Type list, select the data type of the parameter.
      2. In the Value field, enter the value of the parameter.
      3. To add multiple parameters, click + Add Query Parameter.

On successful execution, this action returns the status 200 (OK) with a response body that has the query results.

Known issues

Create, read, update, and delete operations will fail on entities that have Bit and Blob type fields.

Action examples

Example - Find the greater value

This example shows how to execute a user-defined function. The find_greater function in this example, compares two integers and returns the integer which is greater.

1. In the Configure connector task dialog, click Actions.
2. Select the find_greater action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "$1": 1.0,
   "$2": 5.0
   }

If the action execution is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
"bignum": 5.0
}]

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
database	STRING	True	The name of the SingleStore database.
allow_user_variables	BOOLEAN	False	When set to True, user variables (prefixed by an @) can be used in SQL queries.
characterset	STRING	False	The default client character set used by the provider. For example, 'utf8'.
zero_dates_to_null	BOOLEAN	False	Whether or not to return Date and DateTime values consisting of all zeros as NULL.
browsable_schemas	STRING	False	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Use the SingleStore connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

• To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
• To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

• Understand how to suspend and resume a connection.
• Understand how to monitor connector usage.
• Understand how to view connector logs.