Setting general connection properties

This section describes how to configure general connection properties. For an explanation of how to configure advanced connection properties, see Setting advanced connection properties.

To define the general connection properties:

1. Click the Manage Endpoint Connections toolbar button.

   The Manage Endpoints Connections dialog box opens.

2. Click the New Endpoint Connection toolbar button.

   The Name, Description, Type and Role fields are displayed on the right.

3. In the Name field, specify a display name for the endpoint.
4. In the Description field, optionally type a description for the Google Cloud Pub/Sub endpoint.
5. Select Target as the endpoint Role.

6. Select Google Cloud Pub/Sub as the endpoint Type.

   The dialog box is divided into General and Advanced tabs.

7. Continue as described below.

Access details

In the Access Details section, the following options can be set:

• Project ID: The project ID, which is available from the Google Cloud console. For example, mypubsub-227813.

• Authentication: Select one of the following as appropriate:

  • Service account key (JSON): Paste the contents of the JSON file (including curly brackets) that was downloaded when you created your service account key.

    For information on creating a service account key, see Create and delete service account keys

  • Application Default Credentials (ADC): Select this option to authenticate using preconfigured settings. For more information, see How Application Default Credentials works

• Regional endpoint: Select the regional endpoint corresponding to the subscribers' region in order to reduce egress (data retrieval) costs. If the endpoint does not appear in the list, select Other and then specify the region code in the Other region (gRPC service) field.

  • Other region (gRPC service): When the regional endpoint is Other, enter the region code. The region code should be formatted as shown in the REST/HTTP endpoint column in the List of regional endpoints, but without the https://.

    Example:

    us-newregion1-pubsub.googleapis.com

Message properties

In the Message Properties section, set the following properties:

• Format: Choose JSON or Avro.
• Compression: Select GZIP (the default) or None.
• Keep message changes in order: When this option is selected, subscribers will get messages in the order they occurred. This is facilitated by a unique "Ordering Key" value being assigned to each message. As this might impact performance, subscribers can also determine the message order using the Transaction Last Event and Transaction Event Counter (which can be included in the message metadata).
• On source update, include before-image: When this option is selected, both pre-update data and post-update data will be included in the message.
• Include metadata: You can include the following metadata In message only, In message attributes only, or In both message data and message attributes.
  • Schema Name - The default is to include this metadata In message attributes only.
  • Table Name - The default is to include this metadata In message attributes only.
  • Operation - The default is to include this metadata In message attributes only.
  • Change Sequence - The default is to include this metadata In message attributes only.
  • Timestamp - The default is to include this metadata In message attributes only.
  • Transaction ID - The default is to include this metadata In message attributes only.
  • Change Mask - The default is Do not include.
  • Transaction Event Counter - The default is Do not include.
  • Transaction Last Event - The default is Do not include.

  For a description of the metadata, see Data messages.

Data message publishing

In the Publish data to field, choose one of the following:

• Specific topic: Select this option to publish the data to a single topic. Then, in the Topic field, either type a topic name or use the browse button to select a topic.

• Separate topic for each table: Select this option to publish the data to multiple topics corresponding to the source table names.

  The target topic name consists of the source schema name and the source table name, separated by a period (e.g. "dbo.Employees").

Metadata message publishing

In the Metadata Message Publishing section, you can configure Schema Registry connection properties and Schema Registry subject properties.

Schema Registry connection properties

• Schema Registry servers: Specify one or more Schema Registry servers using the following format (for high availability):

  server1:port1[,server2[:port2]]

  Example:  

  192.168.1.100:8081,192.168.1.101:8081

  Replicate will connect to the first available host.

• Use SSL: Select this option to encrypt the data between the Replicate machine and the Schema Registry server(s). If the servers re configured to require SSL, then you must select this option.

  • CA path: Specify one of the following:

    • The full path (i.e. including the file name) to a specific CA certificate in PEM format
    • The directory containing certificate files with hash names

• Authentication - Select one of the following Schema Registry authentication options:

  • None - No authentication.

  • Certificate - Select to authenticate using a certificate.

    If you select this option, you also need to provide the following information:

  • Public key file - The full path to the public key file on the Replicate Server machine.
  • Private key file - The full path to the private key file on the Replicate Server machine.
  • Private key password - The password for the private key file.

  • Username and password - Select to authenticate with a username and password.

• Use proxy server - Select to publish to the Schema Registry via a proxy server.

  • Host name - The host name of the proxy server.
  • Port - The port via which to access the proxy server.
  • Scheme - Select which protocol to use to access the server (HTTP or HTTPS). In order to use HTTPS, you must also specify the SSL CA Path.
  • SSL CA Path: The location of the CA file on the Replicate Server machine when HTTPS is the selected Scheme.

Schema Registry subject properties

From the Subject name strategy drop-down list, optionally change the default subject name strategy:

• Schema and Table Name (Default)
• Topic Name

For more information on Confluent's subject name strategies, see https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#subject-name-strategy

From the Subject compatibility mode drop-down list, optionally change the default compatibility mode. The default is Use Schema Registry defaults.

For an explanation of the available modes, see https://docs.confluent.io/platform/current/schema-registry/avro.html#compatibility-types