{
  "openapi" : "3.0.3",
  "info" : {
    "title" : "Generated by Debezium OpenAPI Generator"
  },
  "components" : {
    "schemas" : {
      "debezium-sqlserver-1.9.7.Final" : {
        "title" : "Debezium SQLServer Connector",
        "required" : [ "database.server.name", "database.dbname", "database.hostname" ],
        "type" : "object",
        "properties" : {
          "database.server.name" : {
            "title" : "Namespace",
            "description" : "Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector.",
            "type" : "string",
            "nullable" : false,
            "x-name" : "database.server.name",
            "x-category" : "CONNECTION"
          },
          "database.hostname" : {
            "title" : "Hostname",
            "description" : "Resolvable hostname or IP address of the database server.",
            "type" : "string",
            "nullable" : false,
            "x-name" : "database.hostname",
            "x-category" : "CONNECTION"
          },
          "database.port" : {
            "format" : "int32",
            "title" : "Port",
            "description" : "Port of the database server.",
            "default" : 1433,
            "type" : "integer",
            "x-name" : "database.port",
            "x-category" : "CONNECTION"
          },
          "database.user" : {
            "title" : "User",
            "description" : "Name of the database user to be used when connecting to the database.",
            "type" : "string",
            "x-name" : "database.user",
            "x-category" : "CONNECTION"
          },
          "database.password" : {
            "format" : "password",
            "title" : "Password",
            "description" : "Password of the database user to be used when connecting to the database.",
            "type" : "string",
            "x-name" : "database.password",
            "x-category" : "CONNECTION"
          },
          "database.dbname" : {
            "title" : "Database",
            "description" : "The name of the database from which the connector should capture changes",
            "type" : "string",
            "nullable" : false,
            "x-name" : "database.dbname",
            "x-category" : "CONNECTION"
          },
          "database.names" : {
            "format" : "list,regex",
            "title" : "Databases",
            "description" : "The names of the databases from which the connector should capture changes",
            "type" : "string",
            "x-name" : "database.names",
            "x-category" : "CONNECTION"
          },
          "database.instance" : {
            "title" : "Instance name",
            "description" : "The SQL Server instance name",
            "type" : "string",
            "x-name" : "database.instance",
            "x-category" : "CONNECTION"
          },
          "database.history.kafka.bootstrap.servers" : {
            "title" : "Kafka broker addresses",
            "description" : "A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process.",
            "type" : "string",
            "x-name" : "database.history.kafka.bootstrap.servers",
            "x-category" : "CONNECTION"
          },
          "database.history.kafka.topic" : {
            "title" : "Database history topic name",
            "description" : "The name of the topic for the database schema history",
            "type" : "string",
            "x-name" : "database.history.kafka.topic",
            "x-category" : "CONNECTION"
          },
          "database.history.kafka.query.timeout.ms" : {
            "format" : "int64",
            "title" : "Kafka admin client query timeout (ms)",
            "description" : "The number of milliseconds to wait while fetching cluster information using Kafka admin client.",
            "default" : 3000,
            "type" : "integer",
            "x-name" : "database.history.kafka.query.timeout.ms",
            "x-category" : "CONNECTION"
          },
          "table.include.list" : {
            "format" : "list,regex",
            "title" : "Include Tables",
            "description" : "The tables for which changes are to be captured",
            "type" : "string",
            "x-name" : "table.include.list",
            "x-category" : "FILTERS"
          },
          "table.exclude.list" : {
            "format" : "list,regex",
            "title" : "Exclude Tables",
            "description" : "A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring",
            "type" : "string",
            "x-name" : "table.exclude.list",
            "x-category" : "FILTERS"
          },
          "column.include.list" : {
            "format" : "list,regex",
            "title" : "Include Columns",
            "description" : "Regular expressions matching columns to include in change events",
            "type" : "string",
            "x-name" : "column.include.list",
            "x-category" : "FILTERS"
          },
          "column.exclude.list" : {
            "format" : "list,regex",
            "title" : "Exclude Columns",
            "description" : "Regular expressions matching columns to exclude from change events",
            "type" : "string",
            "x-name" : "column.exclude.list",
            "x-category" : "FILTERS"
          },
          "table.ignore.builtin" : {
            "title" : "Ignore system databases",
            "description" : "Flag specifying whether built-in tables should be ignored.",
            "default" : true,
            "type" : "boolean",
            "x-name" : "table.ignore.builtin",
            "x-category" : "FILTERS"
          },
          "snapshot.mode" : {
            "title" : "Snapshot mode",
            "description" : "The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. ",
            "default" : "initial",
            "enum" : [ "initial_only", "initial", "schema_only" ],
            "type" : "string",
            "x-name" : "snapshot.mode",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.isolation.mode" : {
            "title" : "Snapshot isolation mode",
            "description" : "Controls which transaction isolation level is used and how long the connector locks the monitored tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, exclusive locks are taken only during schema snapshot. Using a value of 'exclusive' ensures that the connector holds the exclusive lock (and thus prevents any reads and updates) for all monitored tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency.",
            "default" : "repeatable_read",
            "enum" : [ "read_uncommitted", "exclusive", "repeatable_read", "read_committed", "snapshot" ],
            "type" : "string",
            "x-name" : "snapshot.isolation.mode",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.include.collection.list" : {
            "format" : "list,regex",
            "title" : "Snapshot mode include data collection",
            "description" : "this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector.",
            "type" : "string",
            "x-name" : "snapshot.include.collection.list",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.fetch.size" : {
            "format" : "int32",
            "title" : "Snapshot fetch size",
            "description" : "The maximum number of records that should be loaded into memory while performing a snapshot",
            "type" : "integer",
            "x-name" : "snapshot.fetch.size",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.delay.ms" : {
            "format" : "int64",
            "title" : "Snapshot Delay (milliseconds)",
            "description" : "A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms.",
            "default" : 0,
            "type" : "integer",
            "x-name" : "snapshot.delay.ms",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.lock.timeout.ms" : {
            "format" : "int64",
            "title" : "Snapshot lock timeout (ms)",
            "description" : "The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds",
            "default" : 10000,
            "type" : "integer",
            "x-name" : "snapshot.lock.timeout.ms",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.max.threads" : {
            "format" : "int32",
            "title" : "Snapshot maximum threads",
            "description" : "The maximum number of threads used to perform the snapshot.  Defaults to 1.",
            "default" : 1,
            "type" : "integer",
            "x-name" : "snapshot.max.threads",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "snapshot.select.statement.overrides" : {
            "title" : "List of tables where the default select statement used during snapshotting should be overridden.",
            "description" : " This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.[DB_NAME].[TABLE_NAME]' or 'snapshot.select.statement.overrides.[SCHEMA_NAME].[TABLE_NAME]', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted.",
            "type" : "string",
            "x-name" : "snapshot.select.statement.overrides",
            "x-category" : "CONNECTOR_SNAPSHOT"
          },
          "include.schema.changes" : {
            "title" : "Include database schema changes",
            "description" : "Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history.",
            "default" : true,
            "type" : "boolean",
            "x-name" : "include.schema.changes",
            "x-category" : "CONNECTOR"
          },
          "tombstones.on.delete" : {
            "title" : "Change the behaviour of Debezium with regards to delete operations",
            "description" : "Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted.",
            "default" : true,
            "type" : "boolean",
            "x-name" : "tombstones.on.delete",
            "x-category" : "CONNECTOR"
          },
          "decimal.handling.mode" : {
            "title" : "Decimal Handling",
            "description" : "Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers.",
            "default" : "precise",
            "enum" : [ "string", "double", "precise" ],
            "type" : "string",
            "x-name" : "decimal.handling.mode",
            "x-category" : "CONNECTOR"
          },
          "binary.handling.mode" : {
            "title" : "Binary Handling",
            "description" : "Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string'hex' represents binary data as hex-encoded (base16) string",
            "default" : "bytes",
            "enum" : [ "bytes", "base64", "hex" ],
            "type" : "string",
            "x-name" : "binary.handling.mode",
            "x-category" : "CONNECTOR"
          },
          "time.precision.mode" : {
            "title" : "Time Precision",
            "description" : "Time, date, and timestamps can be represented with different kinds of precisions, including:'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision;'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision .",
            "default" : "adaptive",
            "enum" : [ "adaptive", "adaptive_time_microseconds", "connect" ],
            "type" : "string",
            "x-name" : "time.precision.mode",
            "x-category" : "CONNECTOR"
          },
          "include.schema.comments" : {
            "title" : "Include Table and Column Comments",
            "description" : "Whether the connector parse table and column's comment to metadata object.Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'.",
            "default" : false,
            "type" : "boolean",
            "x-name" : "include.schema.comments",
            "x-category" : "CONNECTOR"
          },
          "schema.name.adjustment.mode" : {
            "title" : "Schema Name Adjustment",
            "description" : "Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including:'avro' replaces the characters that cannot be used in the Avro type name with underscore (default)'none' does not apply any adjustment",
            "default" : "avro",
            "enum" : [ "none", "avro" ],
            "type" : "string",
            "x-name" : "schema.name.adjustment.mode",
            "x-category" : "CONNECTOR"
          },
          "heartbeat.interval.ms" : {
            "format" : "int32",
            "title" : "Connector heartbeat interval (milli-seconds)",
            "description" : "Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default.",
            "default" : 0,
            "type" : "integer",
            "x-name" : "heartbeat.interval.ms",
            "x-category" : "ADVANCED_HEARTBEAT"
          },
          "heartbeat.topics.prefix" : {
            "title" : "A prefix used for naming of heartbeat topics",
            "description" : "The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.",
            "default" : "__debezium-heartbeat",
            "type" : "string",
            "x-name" : "heartbeat.topics.prefix",
            "x-category" : "ADVANCED_HEARTBEAT"
          },
          "heartbeat.action.query" : {
            "title" : "An optional query to execute with every heartbeat",
            "description" : "The query executed with every heartbeat.",
            "type" : "string",
            "x-name" : "heartbeat.action.query",
            "x-category" : "ADVANCED_HEARTBEAT"
          },
          "source.timestamp.mode" : {
            "title" : "Source timestamp mode",
            "description" : "Configures the criteria of the attached timestamp within the source record (ts_ms).Options include:'commit', (default) the source timestamp is set to the instant where the record was committed in the database'processing', (deprecated) the source timestamp is set to the instant where the record was processed by Debezium.",
            "default" : "commit",
            "type" : "string",
            "x-name" : "source.timestamp.mode",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "max.iteration.transactions" : {
            "format" : "int32",
            "title" : "Max transactions per iteration",
            "description" : "This property can be used to reduce the connector memory usage footprint when changes are streamed from multiple tables per database.",
            "default" : 0,
            "type" : "integer",
            "x-name" : "max.iteration.transactions",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "converters" : {
            "title" : "List of prefixes defining custom values converters.",
            "description" : "Optional list of custom converters that would be used instead of default ones. The converters are defined using '<converter.prefix>.type' config option and configured using options '<converter.prefix>.<option>'",
            "type" : "string",
            "x-name" : "converters",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "column.truncate.to.(d+).chars" : {
            "format" : "int32",
            "title" : "Truncate Columns To n Characters",
            "description" : "A comma-separated list of regular expressions matching fully-qualified names of columns that should be truncated to the configured amount of characters.",
            "type" : "integer",
            "x-name" : "column.truncate.to.(d+).chars",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "column.mask.with.(d+).chars" : {
            "title" : "Mask Columns With n Asterisks",
            "description" : "A comma-separated list of regular expressions matching fully-qualified names of columns that should be masked with configured amount of asterisk ('*') characters.",
            "type" : "string",
            "x-name" : "column.mask.with.(d+).chars",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "column.mask.hash.([^.]+).with.salt.(.+)" : {
            "title" : "Mask Columns Using Hash and Salt",
            "description" : "A comma-separated list of regular expressions matching fully-qualified names of columns that should be masked by hashing the input. Using the specified hash algorithms and salt.",
            "type" : "string",
            "x-name" : "column.mask.hash.([^.]+).with.salt.(.+)",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "datatype.propagate.source.type" : {
            "format" : "list,regex",
            "title" : "Propagate Source Types by Data Type",
            "description" : "A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records.",
            "type" : "string",
            "x-name" : "datatype.propagate.source.type",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "column.propagate.source.type" : {
            "format" : "list,regex",
            "title" : "Propagate Source Types by Columns",
            "description" : "A comma-separated list of regular expressions matching fully-qualified names of columns that  adds the column’s original type and original length as parameters to the corresponding field schemas in the emitted change records.",
            "type" : "string",
            "x-name" : "column.propagate.source.type",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "message.key.columns" : {
            "title" : "Columns PK mapping",
            "description" : "A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern '<fully-qualified table name>:<key columns>',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id",
            "type" : "string",
            "x-name" : "message.key.columns",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "provide.transaction.metadata" : {
            "title" : "Store transaction metadata information in a dedicated topic.",
            "description" : "Enables transaction metadata extraction together with event counting",
            "default" : false,
            "type" : "boolean",
            "x-name" : "provide.transaction.metadata",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "sanitize.field.names" : {
            "title" : "Sanitize field names to adhere to Avro naming conventions",
            "description" : "Whether field names will be sanitized to Avro naming conventions",
            "default" : false,
            "type" : "boolean",
            "x-name" : "sanitize.field.names",
            "x-category" : "CONNECTOR_ADVANCED"
          },
          "database.history.kafka.recovery.attempts" : {
            "format" : "int32",
            "title" : "Max attempts to recovery database history",
            "description" : "The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms).",
            "default" : 100,
            "type" : "integer",
            "x-name" : "database.history.kafka.recovery.attempts",
            "x-category" : "ADVANCED"
          },
          "database.history.kafka.recovery.poll.interval.ms" : {
            "format" : "int32",
            "title" : "Poll interval during database history recovery (ms)",
            "description" : "The number of milliseconds to wait while polling for persisted data during recovery.",
            "default" : 100,
            "type" : "integer",
            "x-name" : "database.history.kafka.recovery.poll.interval.ms",
            "x-category" : "ADVANCED"
          },
          "skipped.operations" : {
            "format" : "list,regex",
            "title" : "skipped Operations",
            "description" : "The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, no operations will be skipped.",
            "type" : "string",
            "x-name" : "skipped.operations",
            "x-category" : "ADVANCED"
          },
          "event.processing.failure.handling.mode" : {
            "title" : "Event deserialization failure handling",
            "description" : "Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped.",
            "default" : "fail",
            "enum" : [ "warn", "fail", "ignore", "skip" ],
            "type" : "string",
            "x-name" : "event.processing.failure.handling.mode",
            "x-category" : "ADVANCED"
          },
          "query.fetch.size" : {
            "format" : "int32",
            "title" : "Query fetch size",
            "description" : "The maximum number of records that should be loaded into memory while streaming.  A value of `0` uses the default JDBC fetch size.",
            "default" : 0,
            "type" : "integer",
            "x-name" : "query.fetch.size",
            "x-category" : "ADVANCED"
          },
          "max.batch.size" : {
            "format" : "int32",
            "title" : "Change event batch size",
            "description" : "Maximum size of each batch of source records. Defaults to 2048.",
            "default" : 2048,
            "type" : "integer",
            "x-name" : "max.batch.size",
            "x-category" : "ADVANCED"
          },
          "max.queue.size" : {
            "format" : "int32",
            "title" : "Change event buffer size",
            "description" : "Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size.",
            "default" : 8192,
            "type" : "integer",
            "x-name" : "max.queue.size",
            "x-category" : "ADVANCED"
          },
          "max.queue.size.in.bytes" : {
            "format" : "int64",
            "title" : "Change event buffer size in bytes",
            "description" : "Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled",
            "default" : 0,
            "type" : "integer",
            "x-name" : "max.queue.size.in.bytes",
            "x-category" : "ADVANCED"
          },
          "poll.interval.ms" : {
            "format" : "int64",
            "title" : "Poll interval (ms)",
            "description" : "Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms.",
            "default" : 500,
            "type" : "integer",
            "x-name" : "poll.interval.ms",
            "x-category" : "ADVANCED"
          },
          "retriable.restart.connector.wait.ms" : {
            "format" : "int64",
            "title" : "Retriable restart wait (ms)",
            "description" : "Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms.",
            "default" : 10000,
            "type" : "integer",
            "x-name" : "retriable.restart.connector.wait.ms",
            "x-category" : "ADVANCED"
          },
          "source.struct.version" : {
            "title" : "Source struct maker version",
            "description" : "A version of the format of the publicly visible source part in the message",
            "default" : "v2",
            "enum" : [ "v1", "v2" ],
            "type" : "string",
            "x-name" : "source.struct.version",
            "x-category" : "ADVANCED"
          },
          "signal.data.collection" : {
            "title" : "Signaling data collection",
            "description" : "The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set.",
            "type" : "string",
            "x-name" : "signal.data.collection",
            "x-category" : "ADVANCED"
          },
          "transaction.topic" : {
            "title" : "Transaction topic name",
            "description" : "The name of the transaction metadata topic. The placeholder ${database.server.name} can be used for referring to the connector's logical name; defaults to ${database.server.name}.transaction.",
            "default" : "${database.server.name}.transaction",
            "type" : "string",
            "x-name" : "transaction.topic",
            "x-category" : "ADVANCED"
          },
          "database.server.timezone" : {
            "title" : "Server timezone",
            "description" : "The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId (deprecated, the connector will determine the database server timezone offset automatically)",
            "type" : "string",
            "x-name" : "database.server.timezone",
            "x-category" : "ADVANCED"
          }
        },
        "additionalProperties" : true,
        "x-connector-id" : "sqlserver",
        "x-version" : "1.9.7.Final",
        "x-className" : "io.debezium.connector.sqlserver.SqlServerConnector"
      }
    }
  }
}