diff --git a/symmetric/src/docbook/user-guide/ch02-getting-started.xml b/symmetric/src/docbook/user-guide/ch02-getting-started.xml index 57c0167109..db8b6fbea1 100644 --- a/symmetric/src/docbook/user-guide/ch02-getting-started.xml +++ b/symmetric/src/docbook/user-guide/ch02-getting-started.xml @@ -9,8 +9,8 @@ Getting Started This chapter is a hands-on tutorial that demonstrates how to synchronize the sample - database between two running instances of SymmetricDS. The sample database is an example - of a retail business that has a central office database (called "root") and multiple + database between two running instances of SymmetricDS. This example models + a retail business that has a central office database (called "root") and multiple retail store databases (called "client"). The root database sends changes to the client for item data, such as item number, description, and price. The client database sends changes to the root for sale transaction data, such as time of sale and items sold. @@ -23,7 +23,7 @@ of SymmetricDS, called a node, on each database. To link the nodes together, we register the client node with the root node. For this tutorial, the root database is pre-populated with data, while the client database is left empty. To load the data - on the client database, we use the root node to request a reload of the client node. + on the client database, we request the root node sends a "reload" to the client node. With the two databases in sync, we make changes to data in the tables and observe the changes being synchronized. @@ -71,7 +71,7 @@ - Set the following properties in both files to specify how to connect to the database: + Set the following properties in both files to specify how to connect to the database: Database Notes for compatibility with your specific database. - - - Create and load the root node tables with sample data and the synchronization - configuration. Create the tables in the client node database to prepare it. + + + + Create the sample tables in the root node database, load the sample data, + and load the sample configuration. @@ -133,24 +134,19 @@ symmetric.runtime.registration.url=http://localhost:8080/sync]]> - Create the sample tables in both the root and client databases. + Create the sample tables in the root database. ../bin/sym -p root.properties --run-ddl create_sample.xml - - - ../bin/sym -p client.properties --run-ddl create_sample.xml - - Note that the warning messages from the command are safe to ignore. - Create the symmetric tables in the root node database. These tables will + Create the SymmetricDS tables in the root node database. These tables will contain the configuration for synchronization. The following command uses - the auto-creation feature to create all the necessary symmetric system + the auto-creation feature to create all the necessary SymmetricDS system tables. @@ -158,14 +154,58 @@ symmetric.runtime.registration.url=http://localhost:8080/sync]]> - Load sample data and configuration into the root node database. + Load the sample data and configuration into the root node database. ../bin/sym -p root.properties --run-sql insert_sample.sql - - Verify the databases by logging in and listing the tables. - + + + + Create the sample tables in the client node database to prepare it for receiving data. + + + + + Open a command prompt and navigate to the + samples + subdirectory of your SymmetricDS installation. + + + + Create the sample tables in the client database. + + + ../bin/sym -p client.properties --run-ddl create_sample.xml + + + + Note that the warning messages from the command are safe to ignore. + + + + + + Verify both databases by logging in and listing the tables. + + + + + Find the item tables that sync from root to client: + item and item_selling_price. + + + + + Find the sales tables that sync from client to root: + sale_transaction and sale_return_line_item. + + + + + Find the SymmetricDS system tables, which have a prefix of "sym_". + +
@@ -197,7 +237,7 @@ symmetric.runtime.registration.url=http://localhost:8080/sync]]> The client node server starts up and uses the auto-creation feature to - create the symmetric system tables. It begins polling the root node in order + create the SymmetricDS system tables. It begins polling the root node in order to register. Since registration is not yet open, the client node receives an authorization failure (HTTP response of 403).