Skip to content

Commit

Permalink
0005295: Finalized table group and table group hier sections in user …
Browse files Browse the repository at this point in the history
…guide
  • Loading branch information
evan-miller-jumpmind committed Jun 30, 2022
1 parent b3d03fe commit bc8d653
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 17 deletions.
8 changes: 4 additions & 4 deletions symmetric-assemble/src/asciidoc/configuration.ad
Expand Up @@ -27,16 +27,16 @@ endif::pro[]

include::configuration/groups.ad[]
include::configuration/group-links.ad[]
include::configuration/routers.ad[]
include::configuration/channels.ad[]
include::configuration/table-triggers.ad[]
include::configuration/table-routing.ad[]

ifdef::pro[]
include::configuration/table-groups.ad[]
include::configuration/table-group-hiers.ad[]
endif::pro[]

include::configuration/routers.ad[]
include::configuration/channels.ad[]
include::configuration/table-triggers.ad[]
include::configuration/table-routing.ad[]
include::configuration/file-triggers.ad[]
include::configuration/file-routing.ad[]
include::configuration/conflicts.ad[]
Expand Down
25 changes: 16 additions & 9 deletions symmetric-assemble/src/asciidoc/configuration/table-group-hiers.ad
@@ -1,27 +1,34 @@

== Table Group Hierarchies
Table group hierarchies
=== Table Group Hierarchies
Table group hierarchies define the tables that belong to a table group and their relationships to each other,
with each hierarchy representing a single table. Each table group hierarchy can have a parent, but it is not
necessary for every hierarchy to have a parent. It is possible to configure multiple table group hierarchies
for a single table if the table has multiple parents.

ifdef::pro[]
image::images/table-group-hier.png[]
endif::pro[]

ifdef::pro[]
.Required Fields
endif::pro[]

ID:: Unique identifier for the table group hierarchy.
Table Group ID:: Unique identifier for the table group associated with this table in the hierarchy.
Source Catalog:: Optional name for the catalog the configured table is in.
Source Schema:: Optional name for the schema the configured table is in.
Source Table:: The name of the source table that will be a part of this table group.
Parent ID:: Unique identifier for the parent of this table in the hierarchy.
Relation Type:: When writer type is non-default, this defines the structure of data in hierarchy when writing output: O=object, A=array, R=rows to array, C=columns to array.
Relation Type:: When writer type is non-default, this defines the structure of data in hierarchy when writing output: O=object, A=array.

[cols="<2,<7", options="header"]
|===
|Type
|Description

|Object|

|Array|

|Rows to array|
|Object|The data will be in the form of a single object containing one key/value pair for each column in the source table.

|Columns to array|
|Array|The data will be in the form of an array of objects with each object containing one key/value pair for each column in the source table.

|===

Expand Down
19 changes: 15 additions & 4 deletions symmetric-assemble/src/asciidoc/configuration/table-groups.ad
@@ -1,6 +1,16 @@

== Table Groups
Table groups
=== Table Groups
Table groups are used to define collections of tables that will synchronize their data at the same time. When one
row from a table in a table group is changed on the source, all corresponding rows from other tables in the same
group will also be synchronized to the target.

ifdef::pro[]
image::images/table-group.png[]
endif::pro[]

ifdef::pro[]
.Required Fields
endif::pro[]

ID:: Unique identifier for the table group.
Source Node Group ID:: The node group where data changes are captured.
Expand All @@ -12,13 +22,14 @@ Writer Type:: Type of writer: D=default, J=JSON.
|Type
|Description

|Default|
|Default|The source data will remain relational on the target.

|JSON|
|JSON|The source data will be converted to JSON documents on the target. The target database must be MongoDB, Azure Cosmos DB, or Elasticsearch.

|===

ifdef::pro[]
.Advanced Options
endif::pro[]

Description:: Description of the table group that is available through the console.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bc8d653

Please sign in to comment.