Skip to main content

CustomRetriever

Retriever component whose behavior is derived from a custom code implementation of the connector. One instance reads every partition of the stream and its read_records runs in several threads at once, so per-read state must live in local variables, not on the instance.

  • type: object
  • required: ["type","class_name"]

type​

  • Required: Yes
  • type: string
  • enum: ["CustomRetriever"]

class_name​

Fully-qualified name of the class that will be implementing the custom retriever strategy. The format is source_<name>.<package>.<class_name>.

  • Required: Yes
  • type: string

Examples:

source_railz.components.MyCustomRetriever

$parameters​

  • Required: No
  • type: object
Was this page helpful?