Uploaded image for project: 'Debezium'
  1. Debezium
  2. DBZ-8090

Documentation for signals provides incorrect data-collection format for some connectors

XMLWordPrintable

      The documentation for data-collections for signals does not seem to be accurate, as it often refers to using the format schema.table; however, several connectors expect this to be database.schema.table instead.

      The documentation for data-collections for signals does not accurately reflect the formats the each database uses to specify the fully-qualified name of a table. Specifically, the Signaling and Incremental snapshots documentation refer to a single format that is used by only a subset of connectors. To improve accuracy, the documentation must be updated to specify different formats for different connectors. The following list shows the correct formats to use to specify table names for each connector:  

      • schema.table
        • Db2
        • PostgreSQL 
      • database.schema.table
        • Oracle
        • SQL Server 
      • database.table
        • MariaDB
        • MySQL

      Currently, most examples in use only the schema.table format to specify the fully-qualified names of tables.

      The following references require updates:

      • signalling.adoc
        • L228 execute-snapshot example
          • Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.table1", "schema1.table2"], "type": "INCREMENTAL"}}`
        • L661 blocking snapshot example, data field

      "type": "blocking", "data-collections": ["schema1.table1", "schema1.table2"], "additional-conditions": [

      {"data-collection": "schema1.table1", "filter": "SELECT * FROM [schema1].[table1] WHERE column1 = 0 ORDER BY column2 DESC"}

      ,

      {"data-collection": "schema1.table2", "filter": "SELECT * FROM [schema1].[table2] WHERE column2 > 0"}

      ]

      • proc-triggering-an-incremental-snapshot-kafka.adoc
        • L42 Kafka execute-snapshot example:
          • Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.table1", "schema1.table2"], "type": "INCREMENTAL"}}`
        • L61 additional-conditions example
          • Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-conditions": [ \{"data-collection": "schema1.products" ,"filter":"color='blue'"}

            ]}}`

        • L70 Multiple columns additional-conditions example:
          •  Value = `{"type":"execute-snapshot","data": {"data-collections": ["schema1.products"], "type": "INCREMENTAL", "additional-conditions": [ \{"data-collection": "schema1.products" ,"filter":"color='blue' AND brand='MyBrand'"}

            ]}}`

       
      Check the following additional files for references to schema.table format:

      • proc-triggering-an-incremental-snapshot-sql.adoc
      • proc-stopping-an-incremental-snapshot
      • proc-stopping-an-incremental-snapshot-sql.adoc

      Other changes that are required:

      • Add MariaDB (TP) to the list in signalling.adoc.
      • In the table that describes the SQL command for sending incremental snapshot signals, update the description in the entry for the data-collections field to explicitly provide the format for regular expressions in the array, rather than using a cross-reference to the signal.data.collection property.
      • Apply consistent formatting and order to configuration properties sections across connector docs

            broldan@redhat.com Robert Roldan
            ccranfor@redhat.com Chris Cranford
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: