SymmetricDS User Guide

Authors

Eric Long , Chris Henson

User Guide 1.0

Permission to use, copy, modify, and distribute the SymmetricDS User Guide Version 1.0 for any purpose and without fee is hereby granted in perpetuity, provided that the above copyright notice and this paragraph appear in all copies.

Table of Contents

Preface

1. Introduction

1.1. Introduction

1.1.1. What is SymmetricDS?
1.1.2. Notification Schemes
1.1.3. Two-Way Table Synchronization
1.1.4. Data Channels
1.1.5. Transaction Awareness
1.1.6. Data Filtering and Rerouting
1.1.7. HTTP Transport
1.1.8. Remote Management

1.2. Requirements

1.3. Background

2. Getting Started

2.1. Installing SymmetricDS
2.2. Creating and Populating Your Databases
2.3. Starting SymmetricDS
2.4. Registering a Node
2.5. Sending Initial Load
2.6. Pulling Data
2.7. Pushing Data
2.8. Verifying Outgoing Batches
2.9. Verifying Incoming Batches

3. Concepts

3.1. Configuration Data Model

3.1.1. Node Table
3.1.2. Node Security Table
3.1.3. Node Identity Table
3.1.4. Node Group Table
3.1.5. Node Group Link Table
3.1.6. Channel Table
3.1.7. Node Channel Control Table
3.1.8. Trigger Table
3.1.9. Parameter Table
3.1.10. Registration Redirect Table

3.2. Runtime Data Model

3.2.1. Trigger History Table
3.2.2. Data Table
3.2.3. Data Event Table
3.2.4. Outgoing Batch Table
3.2.5. Outgoing Batch History Table
3.2.6. Incoming Batch Table
3.2.7. Incoming Batch History Table

4. Architecture

4.1. Deployment Options

4.1.1. Web Archive
4.1.2. Standalone
4.1.3. Embedded

5. Basic Configuration

5.1. Basic Properties
5.2. Node Group
5.3. Node Group Link
5.4. Node
5.5. Channel
5.6. Trigger
5.7. Using Sync Conditions
5.8. Using Node Select
5.9. Using Initial Load Select

6. Advanced Configuration

6.1. Multi-Tiered Synchronization

6.2. Bi-Directional Synchronization

6.3. Dead Triggers

6.4. Database Purging

6.5. Extension Points

6.5.1. IParameterFilter
6.5.2. IDataLoaderFilter
6.5.3. ITableColumnFilter
6.5.4. IBatchListener
6.5.5. IAcknowledgeEventListener
6.5.6. IReloadListener
6.5.7. IExtractorFilter
6.5.8. ISyncUrlExtension
6.5.9. INodeIdGenerator
6.5.10. ITriggerCreationListener

6.6. Encrypted Passwords

6.7. Secure Transport

6.7.1. Sym Launcher
6.7.2. Tomcat
6.7.3. Keystores
6.7.4. Generating Keys

7. Administration

7.1. Changing Triggers
7.2. Changing Configuration
7.3. Sync Triggers Job
7.4. Enabling and Disabling Synchronization
7.5. Java Management Extensions
7.6. Opening Registration
7.7. Viewing Batches
7.8. Statistics
7.9. Clustering
7.10. Running as a Windows Service
7.11. Running as a Unix Service

A. Parameters

A.1. Startup Parameters
A.2. Runtime Parameters

B. Database Notes

B.1. Oracle
B.2. MySQL
B.3. PostgreSQL
B.4. MS SQL Server
B.5. HSQLDB
B.6. H2
B.7. Apache Derby
B.8. IBM DB2
B.9. Firebird

C. Data Format

D. Version Numbering