This is an automated email from the ASF dual-hosted git repository.
nizhikov 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 83a87552895 IGNITE-18223 Document same SQL table value_type for CDC
(#10713)
83a87552895 is described below
commit 83a87552895d9467567f8ab2c4bddf87718ee07f
Author: Vladimir Steshin <[email protected]>
AuthorDate: Fri May 12 16:47:53 2023 +0300
IGNITE-18223 Document same SQL table value_type for CDC (#10713)
---
.../extensions-and-integrations/change-data-capture-extensions.adoc | 3 +++
docs/_docs/sql-reference/ddl.adoc | 5 +++--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git
a/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
b/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
index 736f754eb3f..cd444db1f45 100644
--- a/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
+++ b/docs/_docs/extensions-and-integrations/change-data-capture-extensions.adoc
@@ -27,6 +27,9 @@ NOTE: For each cache replicated between clusters
link:https://github.com/apache/
NOTE: All implementations of CDC replication support replication of
link:https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/binary/BinaryType.html[BinaryTypes]
and
link:https://ignite.apache.org/releases/latest/javadoc/org/apache/ignite/cdc/TypeMapping.html[TypeMappings]
+NOTE: To use SQL queries on the destination cluster over CDC-replicated data,
set the same `VALUE_TYPE` in
+link:sql-reference/ddl#create-table[CREATE TABLE] on both source and
destination clusters for each table.
+
== Ignite to Java Thin Client CDC streamer
This streamer starts link:thin-clients/java-thin-client[Java Thin Client]
which connects to destination cluster.
After connection is established, all changes captured by CDC will be
replicated to destination cluster.
diff --git a/docs/_docs/sql-reference/ddl.adoc
b/docs/_docs/sql-reference/ddl.adoc
index 180d7cae5a2..7111b951d9d 100644
--- a/docs/_docs/sql-reference/ddl.adoc
+++ b/docs/_docs/sql-reference/ddl.adoc
@@ -61,9 +61,10 @@ sets the write synchronization mode for the underlying
cache. If neither this no
or the `SQL_{SCHEMA_NAME}_{TABLE}` format will be used if the parameter not
specified.
** `DATA_REGION=<existing data region name>` - name of the
link:memory-configuration/data-regions[data region] where table entries should
be stored. By default, Ignite stores all the data in a default region.
** `PARALLELISM=<number of SQL execution threads>` - SQL queries are executed
by a single thread on each node by default, but certain scenarios can benefit
from multi-threaded execution, see
link:perf-and-troubleshooting/sql-tuning#query-parallelism[Query Parallelism]
for details.
-** `KEY_TYPE=<custom name of the key type>` - sets the name of the custom key
type that is used from the key-value APIs in Ignite. The name should correspond
to a Java, .NET, or C++ class, or it can be a random one if
link:data-modeling/data-modeling#binary-object-format[BinaryObjects] is used
instead of a custom class. The number of fields and their types in the custom
key type has to correspond to the `PRIMARY KEY`. Refer to the <<Description>>
section below for more details.
+** `KEY_TYPE=<custom name of the key type>` - sets the name of the custom key
type that is used from the key-value APIs in Ignite. The name should correspond
to a Java, .NET, or C++ class, or it can be a random one if
link:data-modeling/data-modeling#binary-object-format[BinaryObjects] is used
instead of a custom class. The number of fields and their types in the custom
key type has to correspond to the `PRIMARY KEY`. Refer to the <<Use non-SQL
API>> section below for more details.
** `VALUE_TYPE=<custom name of the value type of the new cache>` - sets the
name of a custom value type that is used from the key-value and other non-SQL
APIs in Ignite. The name should correspond to a Java, .NET, or C++ class, or it
can be a random one if
-link:data-modeling/data-modeling#binary-object-format[BinaryObjects] is used
instead of a custom class. The value type should include all the columns
defined in the CREATE TABLE command except for those listed in the `PRIMARY
KEY` constraint. Refer to the <<Description>> section below for more details.
+link:data-modeling/data-modeling#binary-object-format[BinaryObjects] is used
instead of a custom class. The value type should include all the columns
defined in the CREATE TABLE command except for those listed in the `PRIMARY
KEY` constraint. Refer to the <<Use non-SQL API>> section below for more
details.
+Also, the same `VALUE_TYPE` is required to use SQL queries over data
replicated with
link:extensions-and-integrations/change-data-capture-extensions[CDC].
** `WRAP_KEY=<true | false>` - this flag controls whether a _single column_
`PRIMARY KEY` should be wrapped in the
link:data-modeling/data-modeling#binary-object-format[BinaryObjects] format or
not. By default, this flag is set to false. This flag does not have any effect
on the `PRIMARY KEY` with multiple columns; it always gets wrapped regardless
of the value of the parameter.
** `WRAP_VALUE=<true | false>` - this flag controls whether a single column
value of a primitive type should be wrapped in the
link:data-modeling/data-modeling#binary-object-format[BinaryObjects] format or
not. By default, this flag is set to true. This flag does not have any effect
on the value with multiple columns; it always gets wrapped regardless of the
value of the parameter. Set this parameter to false if you have a single column
value and do not plan to add additional columns to [...]