Package io.debezium.connector.mongodb

Enum MongoDbConnectorConfig.CaptureScope

java.lang.Object
java.lang.Enum<MongoDbConnectorConfig.CaptureScope>
io.debezium.connector.mongodb.MongoDbConnectorConfig.CaptureScope
All Implemented Interfaces:
EnumeratedValue, Serializable, Comparable<MongoDbConnectorConfig.CaptureScope>
Enclosing class:
MongoDbConnectorConfig
public static enum MongoDbConnectorConfig.CaptureScope extends Enum<MongoDbConnectorConfig.CaptureScope> implements EnumeratedValue
The set of predefined CaptureScope options or aliases.

  • Enum Constant Details

    • DEPLOYMENT

      public static final MongoDbConnectorConfig.CaptureScope DEPLOYMENT
      Capture changes from entire MongoDB deployment

      The MongoDB user used by debezium needs the following permissions/roles

      • read role for any database
      • read permissions to the config.shards collection (for sharded clusters with connection.mode=replica_set)

    • DATABASE

      public static final MongoDbConnectorConfig.CaptureScope DATABASE
      Capture changes from database.

      The MongoDB user used by debezium needs the following permissions/roles

      • read role for database specified by MongoDbConnectorConfig.CAPTURE_TARGET
      • write permissions to the signalling collection
      • read permissions to the config.shards collection (for sharded clusters with connection.mode=replica_set)
      Additionally, the signaling collection has to reside under MongoDbConnectorConfig.CAPTURE_TARGET

  • Field Details

    • value

      private final String value

  • Constructor Details

    • CaptureScope

      private CaptureScope(String value)

  • Method Details

    • values

      public static MongoDbConnectorConfig.CaptureScope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static MongoDbConnectorConfig.CaptureScope valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public String getValue()
      Specified by:
      getValue in interface EnumeratedValue

    • parse

      public static MongoDbConnectorConfig.CaptureScope parse(String value)
      Determine if the supplied value is one of the predefined options.
      Parameters:
      value - the configuration property value; may not be null
      Returns:
      the matching option, or null if no match is found

    • parse

      public static MongoDbConnectorConfig.CaptureScope parse(String value, String defaultValue)
      Determine if the supplied value is one of the predefined options.
      Parameters:
      value - the configuration property value; may not be null
      defaultValue - the default value; may be null
      Returns:
      the matching option, or null if no match is found and the non-null default is invalid