All Products
Search

This Product

    Realtime Compute for Apache Flink:Manage custom catalogs

    Document Center

    Realtime Compute for Apache Flink:Manage custom catalogs

    Last Updated:Mar 26, 2026

    When built-in catalog types cannot meet your business requirements, register a custom catalog type by uploading a JAR file. This topic explains how to register a custom catalog type, create a catalog from it, and manage registered types.

    Usage notes

    • Custom catalog type names must be unique across all custom catalog types in your workspace.

    • If a custom catalog type shares a name with a built-in catalog, the custom catalog type takes priority.

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

    Prerequisites

    Before you begin, ensure that you have:

    • A JAR file for your custom catalog type. For development guidance, see Catalogs in the Apache Flink documentation.

    • (If using an external URL) An accessible JAR file hosted on an Object Storage Service (OSS) bucket or an external storage system that Realtime Compute for Apache Flink can access.

    Register a custom catalog type and create a catalog

    Step 1: Go to the Catalog List page

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

    2. Find the workspace to manage and click Console in the Actions column.

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

    Step 2: Register a custom catalog type

    1. On the Catalog List page, click Create Catalog.

    2. In the Create Catalog dialog box, click the Custom Catalog tab, then click Add Catalog Type.

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

      image

      MethodDescription
      Upload FileClick Click to Select and upload the JAR file for your custom catalog type.
      Use External URLEnter the URL of a hosted JAR file. Only two URL types are supported: the endpoint of the OSS bucket you specified when purchasing your workspace (viewable in Workspace Details in the management console), or the endpoint of an external storage system that Realtime Compute for Apache Flink can access with public-read access control list (ACL) or explicit access permissions.

    4. Click Next.

    5. Review the properties and click OK.

      image

    Step 3: Create a catalog

    1. On the Custom Catalog tab, click the name of the catalog type you just registered, then click Next.

    2. Enter the catalog code and parameter values, then click OK. The following example uses a Hologres custom catalog type. Modify the parameters based on your catalog type.

      CREATE CATALOG `catalogname` --catalogname indicates the name of the catalog that you create.
WITH (
'type'='hologres-custom',  --The catalog type name that you specify in Step 5.
'endpoint' = 'yourEndpoint',  --The parameters that are selected in the Required column in Step 5 must be configured in the WITH clause.
'username' = 'yourUsername',
'password' = 'yourPassword',
'dbname' = 'yourDbname'
);
      Note

      Enclose the catalog name in grave accents (`). Without them, catalog names containing periods (.) may cause errors.

    View or delete a custom catalog type

    1. On the Catalog List page, click Create Catalog.

    2. In the Create Catalog dialog box, click the Custom Catalog tab.

      • View: Hover over a catalog type name to see its JAR file path, catalog type, creation time, and creator.

      • Delete: Click the image icon next to the catalog type name, then click Confirm.

    Next steps