Bigtable

The Bigtable connector lets you perform insert, delete, update, and read operations on Bigtable data.

Supported versions

This connector supports Google Bigtable version 2.

Before you begin

Before you use the Bigtable connector, do the following in your Google Cloud project:

• Ensure that network connectivity is set up. For information about network patterns, seeNetwork connectivity.
• Grant theroles/connectors.admin IAM role to the user configuring the connector.
• Grant theroles/secretmanager.viewer androles/secretmanager.secretAccessor IAM roles to theservice account that you want to use for the connector.
• Enable the following services:
  • secretmanager.googleapis.com (Secret Manager API)
  • connectors.googleapis.com (Connectors API)

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

Configure the connector

A connection is specific to a data source. Itmeans that if you have many data sources, you must create a separate connectionfor each data source. To create a connection, do the following:

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

   Go to the Connections page

2. Click+ CREATE NEW to open theCreate Connection page.
3. In theLocation 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, seeLocations.

   2. ClickNEXT.
4. In theConnection Details section, complete the following:
   1. Connector: SelectBigtable 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 theConnection 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 aDescription for the connection instance.
   5. Optionally, enableCloud logging, and then select a log level. By default, the log level is set toError.
   6. Service Account: Select a service account that has therequired roles.
   7. Project ID: The ID of the project that contains the Bigtable instance.
   8. Instance ID: The Bigtable instance ID.
   9. Connection Pool Size: The Bigtableconnection pool size.
   10. Optionally, configure theConnection 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.
   11. Optionally, click+ ADD LABEL to add a label to the Connection in the form of a key/value pair.
   12. ClickNEXT.
5. In theAuthentication section, enter the authentication details.
   1. Select anAuthentication type and enter the relevant details.

      The following authentication types are supported by the Bigtable connection:

      • Service Account Authentication
      • OAuth 2.0 - Authorization code

   To understand how to configure these authentication types, seeConfigure authentication.

   2. ClickNEXT.
6. Review: Review your connection and authentication details.
7. ClickCreate.

Configure authentication

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

• Service Account Authentication: Ensure that the service account has the required roles.

• OAuth 2.0 - Authorization code
  • Client ID: The client ID provided by the application.
  • Scopes: List of desired scopes
  • Client Secret: Secret Manager Secret containing the client secret for the application.
  • Secret Version: Secret version for the secret selected above.

Connection configuration samples

This section lists the sample values for the variousfields that you configure when creating the connection.

Service account authentication connection type

Field name	Details
Location	asia-east1
Version	1
Connector	bigtable
Connector version	1
Connection Name	googlecloud-bigtable-service-authontication
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Project Id	PROJECT_ID
Instance ID	gcloud-bigtable-instance
Connection Pool Size	1
Minimum number of nodes	2
Maximum number of nodes	50
Client Secret	bigtable-client-secret
Secret Version	1

OAuth 2.0 - Authorization code connection type

Field name	Details
Location	asia-east1
Version	1
Connector	bigtable
Connector version	1
Connection Name	bigtable-oauth
Service Account	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Project Id	PROJECT_ID
Instance ID	googlecloud-bigtable-instance
Connection Pool Size	1
Minimum number of nodes	2
Maximum number of nodes	50
Client Secret	bigtable-client-secret
Secret Version	1

System limitations

The Bigtable connector can process a maximum of 16 transactions per second, pernode, andthrottles 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, seeLimits.

Note: The number ofIntegration 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.

Use the Bigtable connection in an integration

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

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

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects ofthe 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 theConnectors task.

• Entity:An entity can be thought of as an object, or a collection of properties, in theconnected 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 theEntities list will be empty.

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

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

• Action:An action is a first class function that is made available to the integrationthrough 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 theActions 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 parameternames, and its corresponding data type. The schema (metadata) for entities and actions is fetched by the connection atruntime 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 refreshthe schema for a connection, open theConnection details page of the connection, and then clickRefresh connection schema.

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - Get a record from a table

1. In theConfigure connector task dialog, clickEntities.
2. SelectTable from theEntitylist.
3. Select theGet operation, and then clickDone.
4. Set the entity ID to Get Operation. To set the entity ID, in theData Mapper section of theData Mapping, clickOpen Data Mapping Editor and then enterrow99 in theInput Value field and choose the EntityId as Local variable.

Example - List all records from a table

1. In theConfigure connector task dialog, clickEntities.
2. SelectTable from theEntitylist.
3. Select theList operation, and then clickDone.

Example - Create a record in a table

1. In theConfigure connector task dialog, clickEntities and select Table2.
2. Select theCreate operation, and then clickDone.
3. Set the RowKey to Create operation. To set the RowKey, in theData Mapper section of theData Mapping, clickOpen Data Mapping Editor andthen enter in theInput Value field and provide the RowKey and Payload for column family as Local variable.

Example - Update a record in a table

1. In theConfigure connector task dialog, clickEntities and select Table.
2. Select theUpdate operation, and then clickDone.
3. Set the entity ID to Update operation. To set the entity ID, in theData Mapper section of theData Mapping, clickOpen Data Mapping Editor and then enter in theInput Value field and provide RowKey and payload for column family as Local variable.

Example - Delete a record from a table

1. In theConfigure connector task dialog, clickEntities and select Table2.
2. Select theDelete operation, and then clickDone.
3. Set the entity ID to Delete opearation. To set the entity ID, in theData Mapper section of theData Mapping, clickOpen Data Mapping Editor andthen enterrow99 in theInput Value field and choose the EntityId as Local variable.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloudcommunity atCloud Forums.

What's next

• Understand how tosuspend and resume a connection.
• Understand how tomonitor connector usage.
• Understand how toview connector logs.