Manage custom connectors

Usage notes

• You must develop custom connectors based on the connector standards that are defined by the Apache Flink community. This way, the custom connectors can be recognized and used by fully managed Flink. You must explicitly define connector metadata files and declare factory classes. For more information about how to develop custom connectors, see User-defined Sources & Sinks.
• You can upload one type of connector only once.
• To avoid JAR package dependency conflicts, take note of the following points:
  • Make sure that the version of the Flink image is the same as the Flink version in the Project Object Model (POM) dependencies.
  • Do not upload JAR packages at the runtime layer. This indicates that you need to add <scope>provided</scope> to the dependencies.
  • Use the Shade plug-in to package third-party dependencies. For more information, see Apache Maven Shade plug-in.

Create a custom connector

1. Log on to the Realtime Compute for Apache Flink console.
2. On the Fully Managed Flink tab, find the workspace that you want to manage and click Console in the Actions column.
3. In the left-side navigation pane, click Draft Editor.
4. On the Connectors tab, click the icon next to Connectors.
   
5. Upload a JAR file of a custom connector.
   

   You can use one of the following methods to upload the JAR file of a custom connector:

   • Upload a file: Click Click to Select and select the connector JAR file that you want to upload.
   • External URL: Enter an external URL. If the external URL is the endpoint of an OSS bucket, the JAR file of the custom connector must be stored in the sql-artifacts/namespaces/{namespace} directory.
6. After you upload the file, click Continue.
   The system parses the content of the file that you upload. If file parsing succeeds, you can proceed to the next step. If file parsing fails, you must check whether the code of your custom connector complies with the standards that are defined by the Apache Flink community.
7. Click OK.
   In the Connectors list, the custom connector that you create appears.

Update a custom connector

1. Log on to the Realtime Compute for Apache Flink console.
2. On the Fully Managed Flink tab, find the workspace that you want to manage and click Console in the Actions column.
3. In the left-side navigation pane, click Draft Editor.
4. Click the Connectors tab.
5. In the Connectors list, move the pointer over the name of the custom connector that you want to update and click the icon.
6. Upload the JAR file of the custom connector.
   

   You can use one of the following methods to upload the JAR file of a custom connector:

   • Upload a file: Click Click to Select and select the connector JAR file that you want to upload.
   • External URL: Enter an external URL. If the external URL is the endpoint of an OSS bucket, the JAR file of the custom connector must be stored in the sql-artifacts/namespaces/{namespace} directory.
7. After you upload the file, click Continue.
   The system parses the content of the file that you upload. If file parsing succeeds, you can proceed to the next step. If file parsing fails, you must check whether the code of your custom connector complies with the standards that are defined by the Apache Flink community.
8. Click OK.
   In the Connectors list, the custom connector that you create appears.

Delete a custom connector

If you no longer use a custom connector, perform the following steps to delete it:

1. Log on to the Realtime Compute for Apache Flink console.
2. On the Fully Managed Flink tab, find the workspace that you want to manage and click Console in the Actions column.
3. In the left-side navigation pane, click Draft Editor.
4. Click the Connectors tab.
5. In the Connectors list, move the pointer over the name of the custom connector that you want to delete and click the icon.
6. Click OK.