You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by na...@apache.org on 2022/03/11 12:23:14 UTC
[ignite] branch master updated: IGNITE-16246 Fix CDC extension documentation links and titles. (#9883)
This is an automated email from the ASF dual-hosted git repository.
namelchev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new e0038dd IGNITE-16246 Fix CDC extension documentation links and titles. (#9883)
e0038dd is described below
commit e0038dd216ef1a73b4c71f4cc0303e8d4abeeb7a
Author: Nikita Amelchev <ns...@gmail.com>
AuthorDate: Fri Mar 11 15:22:49 2022 +0300
IGNITE-16246 Fix CDC extension documentation links and titles. (#9883)
---
docs/_data/toc.yaml | 2 ++
.../change-data-capture-extensions.adoc | 6 +++---
docs/_docs/persistence/change-data-capture.adoc | 10 +++++-----
3 files changed, 10 insertions(+), 8 deletions(-)
diff --git a/docs/_data/toc.yaml b/docs/_data/toc.yaml
index 29b14ce..0aecd0f 100644
--- a/docs/_data/toc.yaml
+++ b/docs/_data/toc.yaml
@@ -553,6 +553,8 @@
url: extensions-and-integrations/php-pdo
- title: Performance Statistics
url: extensions-and-integrations/performance-statistics
+ - title: Change Data Capture
+ url: extensions-and-integrations/change-data-capture-extensions
- title: Plugins
url: plugins
- title: Performance and Troubleshooting
diff --git a/docs/_docs/persistence/change-data-capture-extensions.adoc b/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
similarity index 99%
rename from docs/_docs/persistence/change-data-capture-extensions.adoc
rename to docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
index c40cae1..1c63bd2 100644
--- a/docs/_docs/persistence/change-data-capture-extensions.adoc
+++ b/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
@@ -153,7 +153,7 @@ link:https://github.com/apache/ignite/blob/master/modules/core/src/main/java/org
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.
-==== Configuration
+=== Configuration
[cols="20%,45%,35%",opts="header"]
|===
@@ -163,7 +163,7 @@ Default link:https://github.com/apache/ignite-extensions/blob/master/modules/cdc
| `conflictResolveField` | Value field to resolve conflict with. Optional. Field values must implement `java.lang.Comparable`. | null
|===
-==== Conflict resolve algorithm
+=== Conflict resolve algorithm
Replicated changes contain some additional data. Specifically, entry version from source cluster supplied with the changed data.
Default conflict resolve algorithm based on entry version and `conflictResolveField`.
@@ -174,7 +174,7 @@ Conflict resolution field should contain user provided monotonically increasing
. If `conflictResolveField` if provided then field values comparison used to determine order.
. Conflict resolution failed. Update will be ignored.
-==== Configuration example
+=== Configuration example
Configuration is done via Ignite node plugin:
```xml
diff --git a/docs/_docs/persistence/change-data-capture.adoc b/docs/_docs/persistence/change-data-capture.adoc
index 7e79831..eff02b7 100644
--- a/docs/_docs/persistence/change-data-capture.adoc
+++ b/docs/_docs/persistence/change-data-capture.adoc
@@ -35,7 +35,7 @@ Below are the CDC application and the Ignite node integrated via WAL archive seg
image:../../assets/images/integrations/CDC-design.svg[]
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.
-The `ignite-cdc.sh` application runs on a different JVM and processes newly archived link:native-persistence.adoc#_write-ahead_log[WAL segments].
+The `ignite-cdc.sh` application runs on a different JVM and processes newly archived link:persistence/native-persistence#_write-ahead_log[WAL segments].
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.
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:
| `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.
| 1000 milliseconds.
| `checkFrequency` | Amount of time application sleeps between subsequent checks when no new files available. | 1000 milliseconds.
-| `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`
+| `keepBinary` | Flag to specify if key and value of changed entries should be provided in link:key-value-api/binary-objects[binary format]. | `true`
| `consumer` | Implementation of `org.apache.ignite.cdc.CdcConsumer` that consumes entries changes. | null
-| `metricExporterSpi` | Array of SPI's to export CDC metrics. See link:../monitoring-metrics/new-metrics-system.adoc#_metric_exporters[metrics] documentation, also. | null
+| `metricExporterSpi` | Array of SPI's to export CDC metrics. See link:monitoring-metrics/new-metrics-system#_metric_exporters[metrics] documentation, also. | null
|===
== API
@@ -84,7 +84,7 @@ Below is a single change of the data reflected by `CdcEvent`.
|Name |Description
| `key()` | Key for the changed entry.
| `value()` | Value for the changed entry. This method will return `null` if the event reflects removal.
-| `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`].
+| `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`].
| `partition()` | Partition of the changed entry.
| `primary()` | Flag to distinguish if operation happens on the primary or a backup node.
| `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
== cdc-ext
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.
-Detailed documentation can be found on link:../change-data-capture-extensions.adoc[page]
\ No newline at end of file
+Detailed documentation can be found on link:extensions-and-integrations/change-data-capture-extensions[page].
\ No newline at end of file