add debezium protocal (#305)

Author: shiyuhang0

Makefile

@@ -53,7 +53,6 @@ generate-v1beta1-serverless-client: install-openapi-generator ## Generate server
 	@echo "==> Generating serverless audit log client"
 	rm -rf pkg/tidbcloud/v1beta1/serverless/auditlog
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/auditlog.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/auditlog --package-name auditlog -c go/config.yaml
-	cd pkg && go fmt ./tidbcloud/v1beta1/serverless/... && goimports -w .
 	@echo "==> Generating serverless cdc client"
 	rm -rf pkg/tidbcloud/v1beta1/serverless/cdc
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/cdc.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/cdc --package-name cdc -c go/config.yaml

internal/cli/serverless/changefeed/template.go

@@ -48,10 +48,15 @@ const (
         "enableTls": false
     },
     "dataFormat": {
-        // "protocol": "CANAL_JSON", "AVRO", "OPEN_PROTOCOL"
+        // "protocol": "CANAL_JSON", "AVRO", "OPEN_PROTOCOL", "DEBEZIUM"
         "protocol": "CANAL_JSON",
         // available when protocol is CANAL_JSON
         "enableTidbExtension": false,
+        // available when protocol is DEBEZIUM
+        "debeziumConfig": {
+            "disableOutputOldValue": false,
+            "disableSchema": false
+        },
         // available when protocol is AVRO
         "avroConfig": {
             "decimalHandlingMode": "PRECISE",
@@ -122,6 +127,10 @@ const (
     "dataFormat": {
         "protocol": "CANAL_JSON",
         "enableTidbExtension": false,
+        "debeziumConfig": {
+            "disableOutputOldValue": false,
+            "disableSchema": false
+        },
         "avroConfig": {
             "decimalHandlingMode": "PRECISE",
             "bigintUnsignedHandlingMode": "LONG",

pkg/tidbcloud/v1beta1/serverless/cdc.swagger.json

@@ -916,6 +916,19 @@
         "endpoint"
       ]
     },
+    "DebeziumConfig": {
+      "type": "object",
+      "properties": {
+        "disableOutputOldValue": {
+          "type": "boolean",
+          "title": "whether disable output old value, default to false"
+        },
+        "disableSchema": {
+          "type": "boolean",
+          "title": "disable schema in debezium message, default to false"
+        }
+      }
+    },
     "DecimalHandlingMode.Enum": {
       "type": "string",
       "enum": [
@@ -1083,6 +1096,9 @@
         },
         "avroConfig": {
           "$ref": "#/definitions/AvroConfig"
+        },
+        "debeziumConfig": {
+          "$ref": "#/definitions/DebeziumConfig"
         }
       }
     },
@@ -1215,9 +1231,10 @@
       "enum": [
         "CANAL_JSON",
         "OPEN_PROTOCOL",
-        "AVRO"
+        "AVRO",
+        "DEBEZIUM"
       ],
-      "description": " - CANAL_JSON: Canal-JSON protocol.\n - OPEN_PROTOCOL: Open Protocol.\n - AVRO: Avro protocol."
+      "description": " - CANAL_JSON: Canal-JSON protocol.\n - OPEN_PROTOCOL: Open Protocol.\n - AVRO: Avro protocol.\n - DEBEZIUM: Debezium protocol."
     },
     "KafkaType.Enum": {
       "type": "string",

pkg/tidbcloud/v1beta1/serverless/cdc/.openapi-generator/FILES

@@ -23,6 +23,7 @@ model_changefeed_type_enum.go
 model_changefeeds.go
 model_checkpoint.go
 model_confluent_schema_registry.go
+model_debezium_config.go
 model_decimal_handling_mode_enum.go
 model_describe_schema_table_resp.go
 model_event_filter_rule.go

pkg/tidbcloud/v1beta1/serverless/cdc/README.md

@@ -110,6 +110,7 @@ Class | Method | HTTP request | Description
  - [Changefeeds](docs/Changefeeds.md)
  - [Checkpoint](docs/Checkpoint.md)
  - [ConfluentSchemaRegistry](docs/ConfluentSchemaRegistry.md)
+ - [DebeziumConfig](docs/DebeziumConfig.md)
  - [DecimalHandlingModeEnum](docs/DecimalHandlingModeEnum.md)
  - [DescribeSchemaTableResp](docs/DescribeSchemaTableResp.md)
  - [EventFilterRule](docs/EventFilterRule.md)

pkg/tidbcloud/v1beta1/serverless/cdc/api/openapi.yaml

@@ -745,6 +745,15 @@ components:
       required:
       - endpoint
       type: object
+    DebeziumConfig:
+      properties:
+        disableOutputOldValue:
+          title: "whether disable output old value, default to false"
+          type: boolean
+        disableSchema:
+          title: "disable schema in debezium message, default to false"
+          type: boolean
+      type: object
     DecimalHandlingMode.Enum:
       description: |2-
          - PRECISE: Precise handling mode for decimals.
@@ -872,6 +881,8 @@ components:
           type: boolean
         avroConfig:
           $ref: '#/components/schemas/AvroConfig'
+        debeziumConfig:
+          $ref: '#/components/schemas/DebeziumConfig'
       type: object
     Kafka.Network:
       properties:
@@ -969,10 +980,12 @@ components:
          - CANAL_JSON: Canal-JSON protocol.
          - OPEN_PROTOCOL: Open Protocol.
          - AVRO: Avro protocol.
+         - DEBEZIUM: Debezium protocol.
       enum:
       - CANAL_JSON
       - OPEN_PROTOCOL
       - AVRO
+      - DEBEZIUM
       type: string
     KafkaType.Enum:
       description: |2-