Skip to main content

Referencing Connectors

The name, used to reference a connector plugin in API requests or a pipeline configuration file, is using the following format:

[PLUGIN-TYPE:]PLUGIN-NAME[@VERSION]

  • PLUGIN-TYPE (builtin, standalone or any)
    • Defines if the specified plugin should be builtin or standalone.
    • If any, Conduit will use a standalone plugin if it exists and fall back to a builtin plugin.
    • Default is any.
  • PLUGIN-NAME
    • Defines the name of the plugin as specified in the plugin specifications, it has to be an exact match.
  • VERSION
    • Defines the plugin version as specified in the plugin specifications, it has to be an exact match.
    • If latest, Conduit will use the latest semantic version.
    • Default is latest.

Examples​

  • postgres
    • will use the latest standalone postgres plugin
    • will fallback to the latest builtin postgres plugin if standalone wasn't found
  • [email protected]
    • will use the standalone postgres plugin with version v0.2.0
    • will fallback to a builtin postgres plugin with version v0.2.0 if standalone wasn't found
  • builtin:postgres
    • will use the latest builtin postgres plugin
  • standalone:[email protected]
    • will use the standalone postgres plugin with version v0.3.0 (no fallback to builtin)