Skip to content

Commit a3c79d4

Browse files
committed
IGNITE-16246 Fix CDC extension documentation links and titles. (#9883)
(cherry picked from commit e0038dd)
1 parent 77fec5b commit a3c79d4

3 files changed

Lines changed: 10 additions & 8 deletions

File tree

docs/_data/toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,8 @@
553553
url: extensions-and-integrations/php-pdo
554554
- title: Performance Statistics
555555
url: extensions-and-integrations/performance-statistics
556+
- title: Change Data Capture
557+
url: extensions-and-integrations/change-data-capture-extensions
556558
- title: Plugins
557559
url: plugins
558560
- title: Performance and Troubleshooting

docs/_docs/persistence/change-data-capture-extensions.adoc renamed to docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ link:https://github.com/apache/ignite/blob/master/modules/core/src/main/java/org
153153

154154
Default link:https://github.com/apache/ignite-extensions/blob/master/modules/cdc-ext/src/main/java/org/apache/ignite/cdc/conflictresolve/CacheVersionConflictResolverImpl.java[implementation] is available in cdc-ext.
155155

156-
==== Configuration
156+
=== Configuration
157157

158158
[cols="20%,45%,35%",opts="header"]
159159
|===
@@ -163,7 +163,7 @@ Default link:https://github.com/apache/ignite-extensions/blob/master/modules/cdc
163163
| `conflictResolveField` | Value field to resolve conflict with. Optional. Field values must implement `java.lang.Comparable`. | null
164164
|===
165165

166-
==== Conflict resolve algorithm
166+
=== Conflict resolve algorithm
167167

168168
Replicated changes contain some additional data. Specifically, entry version from source cluster supplied with the changed data.
169169
Default conflict resolve algorithm based on entry version and `conflictResolveField`.
@@ -174,7 +174,7 @@ Conflict resolution field should contain user provided monotonically increasing
174174
. If `conflictResolveField` if provided then field values comparison used to determine order.
175175
. Conflict resolution failed. Update will be ignored.
176176

177-
==== Configuration example
177+
=== Configuration example
178178
Configuration is done via Ignite node plugin:
179179

180180
```xml

docs/_docs/persistence/change-data-capture.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Below are the CDC application and the Ignite node integrated via WAL archive seg
3535
image:../../assets/images/integrations/CDC-design.svg[]
3636

3737
When CDC is enabled, the Ignite server node creates a hard link to each WAL archive segment in the special `db/cdc/\{consistency_id\}` directory.
38-
The `ignite-cdc.sh` application runs on a different JVM and processes newly archived link:native-persistence.adoc#_write-ahead_log[WAL segments].
38+
The `ignite-cdc.sh` application runs on a different JVM and processes newly archived link:persistence/native-persistence#_write-ahead_log[WAL segments].
3939
When the segment is fully processed by `ignite-cdc.sh`, it is removed. The actual disk space is free when both links (archive and CDC) are removed.
4040

4141
State of consumption is a pointer to the last processed event.
@@ -68,9 +68,9 @@ CDC is configured in the same way as the Ignite node - via the spring XML file:
6868
| `lockTimeout` | Timeout to wait for lock acquiring. CDC locks directory on a startup to ensure there is no concurrent `ignite-cdc.sh` processing the same directory.
6969
| 1000 milliseconds.
7070
| `checkFrequency` | Amount of time application sleeps between subsequent checks when no new files available. | 1000 milliseconds.
71-
| `keepBinary` | Flag to specify if key and value of changed entries should be provided in link:../key-value-api/binary-objects.adoc[binary format]. | `true`
71+
| `keepBinary` | Flag to specify if key and value of changed entries should be provided in link:key-value-api/binary-objects[binary format]. | `true`
7272
| `consumer` | Implementation of `org.apache.ignite.cdc.CdcConsumer` that consumes entries changes. | null
73-
| `metricExporterSpi` | Array of SPI's to export CDC metrics. See link:../monitoring-metrics/new-metrics-system.adoc#_metric_exporters[metrics] documentation, also. | null
73+
| `metricExporterSpi` | Array of SPI's to export CDC metrics. See link:monitoring-metrics/new-metrics-system#_metric_exporters[metrics] documentation, also. | null
7474
|===
7575

7676
== API
@@ -84,7 +84,7 @@ Below is a single change of the data reflected by `CdcEvent`.
8484
|Name |Description
8585
| `key()` | Key for the changed entry.
8686
| `value()` | Value for the changed entry. This method will return `null` if the event reflects removal.
87-
| `cacheId()` | ID of the cache where the change happens. The value is equal to the `CACHE_ID` from link:../monitoring-metrics/system-views.adoc#_CACHES[`SYS.CACHES`].
87+
| `cacheId()` | ID of the cache where the change happens. The value is equal to the `CACHE_ID` from link:monitoring-metrics/system-views#_CACHES[`SYS.CACHES`].
8888
| `partition()` | Partition of the changed entry.
8989
| `primary()` | Flag to distinguish if operation happens on the primary or a backup node.
9090
| `version()` | `Comparable` version of the changed entry. Internally, Ignite maintains ordered versions of each entry so any changes of the same entry can be sorted.
@@ -134,4 +134,4 @@ IMPORTANT: `ignite-cdc.sh` implements the fail-fast approach. It just fails in c
134134
== cdc-ext
135135

136136
Ignite extensions project has link:https://github.com/apache/ignite-extensions/tree/master/modules/cdc-ext[cdc-ext] module which provides two way to setup cross cluster replication based on CDC.
137-
Detailed documentation can be found on link:../change-data-capture-extensions.adoc[page]
137+
Detailed documentation can be found on link:extensions-and-integrations/change-data-capture-extensions[page].

0 commit comments

Comments
 (0)