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

Formatting characters render literally in docs

XMLWordPrintable

      Incorrect formatting results in list continuation character (plus sign) and other formatting characters being displayed in the output in the following locations:

      Db2

      Table of settings for snapshot.mode connector configuration property DONE

      • recovery description:

      + WARNING: Do not use this mode to perform a snapshot if schema changes were committed to the database after the last connector shutdown.

      MongoDB DONE

      Descriptions of MongoDB connector data events > Change streams capture mode

      • Table of descriptions of update event value fields
        Row 3 description:

       

       Contains the JSON string representation of the actual MongoDB document before change. + An update ...

      • Table of delete events
        Same as above

       

      MySQL DONE

      Descriptions of Debezium MySQL connector data change events

      Table of descriptions of truncate event value fields:

      • Row 3 description

      + In the source object, `ts_ms` indicates the time that the change was made in the database.

      PostgreSQL DONE

      How Debezium PostgreSQL connectors work

      Table of descriptions of update event value fields

      • Row 1 description:

      + For an update event to contain the previous values of all columns in the row, you would have to change the customers table by running ALTER TABLE customers REPLICA IDENTITY FULL.

      * snapshot.locking.mode
      Description list formatting (double colon) and list continuation character render in output:

      shared :: The connector holds a table lock ...
      none:: The connector avoids locks entirely.

      +

      SQL Server

      Advanced SQL Server connector configuration properties

      • heartbeat.action.query description DONE

      + This is useful for keeping offsets from becoming stale when capturing changes from a low-traffic database. Create a heartbeat table in the low-traffic database, and set this property to a statement that inserts records into that table, for example:
      + INSERT INTO test_heartbeat_table (text) VALUES ('test_heartbeat')
      + This allows the connector to receive changes from the low-traffic database and acknowledge their LSNs, which prevents offsets from become stale.

      Fix this by removing 4 redundant + signs after “heartbeat message”, and on the lines that precede INSERT INTO …, and “This allows…”

      Table of settings for snapshot.mode connector configuration property DONE

      • recovery description:

      + WARNING: Do not use this mode to perform a snapshot if …​

      MongoDB Outbox event router

      Table of descriptions of the outbox event router SMT configuration options

      • route.topic.regex DONE

       

      + The default behavior is that the SMT replaces the default
      route.topic.replacement:
      + To change the topic name, you can:

      • route.topic.replacement DONE

       

      the topic name is outbox.event.customers.

      + To change the topic name, you can:

      Post processors DONE

      Reselect columns post processor configuration options 

      • reselect.columns.include.list:

       

      Comma-separated list of column names to reselect from the source database. Use the following format to specify column names: + <schema>.<table>:<column>

      * reselect.columns.exclude.list:

       

       

      Comma-separated list of column names in the source database to exclude from reselection. Use the following format to specify column names: + <schema>.<table>:<column>

      proc-triggering-an-incremental-snapshot (shared file) DONE

      Step 1 of the procedure, Using a source signaling channel to trigger an incremental snapshot renders multiple list continuation characters:

      + The values of the id,type, and data parameters in the command correspond to the fields of the signaling table.

      + The following table describes the parameters in the example:

      + .Descriptions of fields in a SQL command for sending an incremental snapshot signal to the signaling table

      These lines are preceded by an include directive on L35, which pulls in a plain code block example from the tagged region snapshot-signal-example in the snippets file /partials/{context}-frag-signaling-fq-table-formats.adoc.
      I suspect that the continuation characters are not processed, because the included block is formatted as a simple code block, rather than as an example block.

            broldan@redhat.com Robert Roldan
            broldan@redhat.com Robert Roldan
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: