Package com.cockroachlabs.data.cdc.annotation

Annotation Interface CockroachDBCDC

@Target(METHOD) @Retention(RUNTIME) @Documented public @interface CockroachDBCDC

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    endpoint
    Webhook endpoint path relative to the CDC base path.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    CDCOperationType[]
    operations
    Filter which operations this handler processes.
    String[]
    projections
    Column projections.
    String
    table
    Source table name.

  • Element Details

    • endpoint

      String endpoint
      Webhook endpoint path relative to the CDC base path. Example: "/orders" registers at {basePath}/orders.

    • table

      String table
      Source table name. Used by ChangefeedFactory when creating changefeeds. If empty, inferred from the method's entity type via JPA @Table or class name.
      Default:
      ""

    • projections

      String[] projections
      Column projections. When set, only these columns are included in the changefeed. The method's parameter type should be a DTO matching the projected columns.
      Default:
      {}

    • operations

      CDCOperationType[] operations
      Filter which operations this handler processes. Default: all operations (INSERT, UPDATE, DELETE).
      Default:
      {}