Skip to main content

PrimaryKey

The stream field to be used to distinguish unique records. Can either be a single field, an array of fields representing a composite key, or an array of arrays representing a composite key where the fields are nested fields.

  • default: ``

Examples:

id
- code
- type
  • anyOf:

    The single top-level field to use as the primary key.

    • type: string
  • anyOf:

    An array of top-level fields representing a composite primary key.

    • type: array

    • items:

      • type: string
  • anyOf:

    An array of arrays representing a composite primary key where the fields are nested fields.

    • type: array

    • items:

      Path to the nested field in the record.

      • type: array

      • items:

        • type: string