Realtime Compute for Apache Flink:Manage custom catalogs

Considerations

• Custom catalog type names must be unique.

  If a custom catalog type has the same name as a built-in catalog type, the custom catalog type takes precedence.

• Deleting a custom catalog type also deletes all catalogs of that type.

Create and use a custom catalog

1. Go to the Catalogs page.

   1. Log on to the Realtime Compute for Apache Flink console.

   2. In the Actions column for the target workspace, click Console.

   3. In the left-side navigation pane, click Catalogs.

2. Click Create Catalog. On the Custom Catalog tab, click Add Catalog Type.

3. In the Create catalog type dialog box, configure the custom catalog type.

   Method	Description
   Upload File	Click Select File to choose your custom catalog type file. For more information about how to develop a custom catalog type, see catalogs.
   External URL	Enter the External URL. You can use this method to retrieve a JAR file from another service. Note Two types of external URLs are supported: The OSS bucket associated with your Flink workspace. View the bucket details on the Workspace Details page in the Management Portal. A URL for an external storage system that Realtime Compute for Apache Flink has access to (public-read or with granted permission).

4. Click Next.

5. Confirm the properties and click OK.

   In the Parameter Configuration step, if you set Catalog Type to hologres-new, the system automatically populates the Properties list. This list includes properties such as poolsize (default: 10), async (default: false), password (required), jdbcretrysleeptime (default: 1000), and jdbcscanfetchsize (default: 256). You can add properties by clicking Add Property or remove them by clicking the delete icon.

6. On the Custom Catalog tab, click the custom catalog type that you just created, and then click Next.

7. Enter the catalog code and parameter values, and then click OK to create the catalog.

   The following code provides an example. You can modify it based on your requirements.

   CREATE CATALOG `catalogname` --The name of the catalog to be created.
   WITH (
   'type' = 'hologres-custom',  --The name of the catalog type from Step 5.
   'endpoint' = 'yourEndpoint',  --Parameters marked as required in Step 5 must be included in the WITH clause, and the same applies to the following parameters.
   'username' = 'yourUsername',
   'password' = 'yourPassword',
   'dbname' = 'yourDbname'
   );

   Note

   Enclose the catalog name in grave accents (). Otherwise, an error occurs if the name contains special characters, such as a period (.).

View or delete a custom catalog type

1. On the Catalogs page, click Create Catalog.

2. Click the Custom Catalog tab to view or delete a custom catalog type.

   • View: Hover over a custom catalog type to view its details, such as the JAR package path, catalog type, creation time, and creator.

   • Delete: Click the icon next to the target custom catalog type, and then click OK.

Related topics

• Realtime Compute for Apache Flink provides various built-in catalog types. For more information, see catalogs.

• For a list of supported connectors, see Supported connectors.