Skip to content

Commit

Permalink
fix author. fix appendix. add data model definition table for node.
Browse files Browse the repository at this point in the history
  • Loading branch information
@erilong
erilong committed Oct 31, 2007
1 parent e2bb4be commit ae46fc3
Showing 1 changed file with 145 additions and 50 deletions.
195 changes: 145 additions & 50 deletions symmetric/src/docbook/user-guide.xml
View file
Expand Up @@ -17,8 +17,7 @@
<edition>Version 1.0 for SymmetricDS v1.0.0</edition>
<copyright>
<year>2007</year>
<holder>Eric Long</holder>
<holder>Chris Henson</holder>
<holder>Eric Long and Chris Henson</holder>
</copyright>
<legalnotice>
<para>
Expand All @@ -45,7 +44,8 @@
<chapter>
<title>Introduction</title>
<section>
<title>The Problem of Synchronization</title>
<title>The Problem of Synchronization</title>
<para></para>
</section>
<section>
<title>SymmetricDS Feature Overview</title>
Expand Down Expand Up @@ -515,14 +515,71 @@
<title>Concepts</title>
<section>
<title>Data Model</title>
<para></para>
</section>
<section>
<title>Node</title>
<para>
An instance of SymmetricDS that synchronizes data with one or more nodes. Each node
has a unique identifier (nodeID) that is used when communicating, as well as a
has a unique identifier (nodeId) that is used when communicating, as well as a
domain-specific identifier (externalId) that provides context within the local
system.
</para>
<para>
<table>
<title>Node</title>
<tgroup cols="3">
<thead>
<row>
<entry>Column Name</entry><entry>Type</entry>
<entry>Null</entry><entry>Key</entry><entry>Default</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>node_id</entry><entry>varchar(50)</entry><entry>N</entry>
<entry>PK</entry><entry></entry><entry>Unique identifier for a node</entry>
</row>
<row>
<entry>node_group_id</entry><entry>varchar(50)</entry><entry>N</entry>
<entry>FK</entry><entry></entry><entry>The node group that this node belongs to, such as "store"</entry>
</row>
<row>
<entry>external_id</entry><entry>varchar(50)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>A domain-specific identifier for context within the local system. For example, the retail store number. </entry>
</row>
<row>
<entry>sync_enabled</entry><entry>booleanint</entry><entry>N</entry>
<entry></entry><entry>0</entry><entry>Indicates whether this node should be sent synchronization. Disabled nodes are ignored by the triggers, so no entries are made in DataEvent for the node.</entry>
</row>
<row>
<entry>sync_url</entry><entry>varchar(2000)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The URL to contact the node for synchronization.</entry>
</row>
<row>
<entry>schema_version</entry><entry>varchar(50)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The version of the database schema this node manages. Useful for specifying synchronization by version.</entry>
</row>
<row>
<entry>symmetric_version</entry><entry>varchar(50)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The version of SymmetricDS running at this node.</entry>
</row>
<row>
<entry>database_type</entry><entry>varchar(50)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The database product name at this node as reported by JDBC.</entry>
</row>
<row>
<entry>database_version</entry><entry>varchar(50)</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The database product version at this node as reported by JDBC.</entry>
</row>
<row>
<entry>heartbeat_time</entry><entry>timestamp</entry><entry>N</entry>
<entry></entry><entry></entry><entry>The last timestamp when the node sent a heartbeat, which is attempted every ten minutes by default.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
<section>
Expand Down Expand Up @@ -567,42 +624,52 @@
<title>Architecture</title>
<section>
<title>Software Components</title>
<para></para>
</section>
<section>
<title>Deployment Options</title>
<para></para>
</section>
</chapter>
<chapter>
<title>Basic Configuration</title>
<section>
<title>Nodes</title>
<para></para>
</section>
</chapter>
<chapter>
<title>Advanced Configuration</title>
<section>
<title>Dead Triggers</title>
<para></para>
</section>
<section>
<title>Auto Creation</title>
<para></para>
</section>
<section>
<title>Secure Transport</title>
<para></para>
</section>
</chapter>
<chapter>
<title>Administration</title>
<section>
<title>Rebuilding Triggers</title>
<para></para>
</section>
<section>
<title>Opening Registration</title>
<para></para>
</section>
<section>
<title>Enabling and Disabling Synchronization</title>
<para></para>
</section>
<section>
<title>Viewing Batches</title>
<para></para>
</section>
</chapter>
<appendix>
Expand All @@ -621,52 +688,80 @@
The first field of each line gives the directive for the line. The following directives
are used:

<itemizedlist spacing="compact">
<listitem>
<para>
<command>version {major},{minor},{patch}</command>
</para>
Indicates the version of the file format
</listitem>
<listitem>
<para>
<command>table {table name}</command>
</para>
Sets the context of which table to operate on
</listitem>
<listitem>
<para>
<command>keys {column name...}</command>
</para>
Lists the column names that are used as the primary key for the table. Only
needs to occur after the first occurrence of the table.
</listitem>
<listitem>
<para>
<command>columns {column name...}</command>
</para>
Lists all the column names of the table. Only needs to occur after the first
occurrence of the table.
</listitem>
<listitem>
<para>
<command>insert {column value...}</command>
</para>
Insert into the table with the values that correspond with the columns
</listitem>
<listitem>
<para>
<command>update {old key value...},{new column value...}</command>
</para>
Update the table using the old key values to set the new column values
</listitem>
<listitem>
<para>
<command>delete {old key value...}</command>
</para>
Delete from the table using the old key values
</listitem>
</itemizedlist>
<variablelist>
<varlistentry>
<term>
<command>version {major},{minor},{patch}</command>
</term>
<listitem>
<para>
Indicates the version of the file format
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>table {table name}</command>
</term>
<listitem>
<para>
Sets the context of which table to operate on
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>keys {column name...}</command>
</term>
<listitem>
<para>
Lists the column names that are used as the primary key for the table. Only
needs to occur after the first occurrence of the table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>columns {column name...}</command>
</term>
<listitem>
<para>
Lists all the column names of the table. Only needs to occur after the first
occurrence of the table.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>insert {column value...}</command>
</term>
<listitem>
<para>
Insert into the table with the values that correspond with the columns
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>update {old key value...},{new column value...}</command>
</term>
<listitem>
<para>
Update the table using the old key values to set the new column values
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>delete {old key value...}</command>
</term>
<listitem>
<para>
Delete from the table using the old key values
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<example>
<title>Data Format Stream</title>
Expand Down

0 comments on commit ae46fc3

Please sign in to comment.