Skip to content

Commit

Permalink
0004279: doc symadmin module install
Browse files Browse the repository at this point in the history
  • Loading branch information
erilong committed Feb 18, 2020
1 parent c611abe commit cff2b85
Show file tree
Hide file tree
Showing 20 changed files with 47 additions and 1 deletion.
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/bigquery.ad
@@ -1,5 +1,7 @@
=== Google Big Query

Use `symadmin module install bigquery` to install driver files, or copy your own files into the `lib` sub-directory.

Send changes from your relational database to Google's Big Query.

==== Setup
Expand Down
6 changes: 6 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/db2.ad
@@ -1,5 +1,8 @@

=== DB2

Use `symadmin module install db2` to install driver files, or copy your own files into the `lib` sub-directory.

The IBM DB2 Dialect uses global variables to enable and disable node and trigger synchronization.
These variables are created automatically during the first startup. The DB2 JDBC driver should be placed in the "lib" folder.

Expand Down Expand Up @@ -55,6 +58,9 @@ db2.capture.transaction.id=false
----

=== DB2 for IBM i

Use `symadmin module install db2` to install driver files, or copy your own files into the `lib` sub-directory.

The DB2 for IBM i dialect can connect to a database on IBM iSeries (AS/400) machines. It was tested with the
http://jt400.sourceforge.net/[jt400 JDBC driver], which is already included in the SymmetricDS download.
Here is an example JDBC URL:
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/derby.ad
@@ -1,6 +1,8 @@

=== Derby

Use `symadmin module install derby` to install driver files, or copy your own files into the `lib` sub-directory.

The Apache Derby database can be run as an embedded database that is accessed by an application or
a standalone server that can be accessed from the network. This dialect implementation creates
database triggers that make method calls into Java classes. This means that the supporting JAR
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/firebird.ad
@@ -1,6 +1,8 @@

=== Firebird

Use `symadmin module install firebird` to install driver files, or copy your own files into the `lib` sub-directory.

The Firebird Dialect may require the installation of a User Defined Function (UDF) library in order to provide functionality
needed by the database triggers. SymmetricDS includes the required UDF library, called SYM_UDF, in both source form (as a C program)
and as pre-compiled libraries for both Windows and Linux. For Firebird 2.0 and earlier, the UDF is needed for capturing character
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/hbase.ad
@@ -1,6 +1,8 @@

=== HBase

Use `symadmin module install hbase` to install driver files, or copy your own files into the `lib` sub-directory.

==== Empty HBase

If you are setting up replication to HBase and the tables are not already present in Hbase SymmetricDS can create them through the phoenix JDBC driver. This driver maintains some additional meta data about the tables so that they can be accessed using SQL through the JDBC driver.
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/hsqldb.ad
@@ -1,6 +1,8 @@

=== HSQLDB

Use `symadmin module install hsqldb` to install driver files, or copy your own files into the `lib` sub-directory.

HSQLDB was implemented with the intention that the database be run embedded in the same JVM process as SymmetricDS.
Instead of dynamically generating static SQL-based triggers like the other databases, HSQLDB triggers are Java classes
that re-use existing SymmetricDS services to read the configuration and insert data events accordingly.
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/ignite.ad
@@ -1,6 +1,8 @@

=== Apache Ignite

Use `symadmin module install ignite` to install driver files, or copy your own files into the `lib` sub-directory.

Since SymmetricDS is trigger based and there are not triggers in Apache Ignite, data can only be loaded to an Apache Ignite instance. The runtime SymmetricDS tables will also need to be installed in a full relational database to support integration with Apache Ignite.

TIP: See <<Load Only Node>> for more details on the general concepts of a load only node.
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/informix.ad
@@ -1,6 +1,8 @@

=== Informix

Use `symadmin module install informix` to install driver files, or copy your own files into the `lib` sub-directory.

The Informix Dialect was tested against Informix Dynamic Server 11.50, but older versions may also work. You need to download the Informix
JDBC Driver (from the IBM Download Site) and put the ifxjdbc.jar and ifxlang.jar files in the SymmetricDS lib folder.

Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/interbase.ad
@@ -1,6 +1,8 @@

=== Interbase

Use `symadmin module install interbase` to install driver files, or copy your own files into the `lib` sub-directory.

The Interbase Dialect requires the installation of a User Defined Function (UDF) library in order to
provide functionality needed by the database triggers. SymmetricDS includes the required UDF library,
called SYM_UDF, in both source form (as a C program) and as pre-compiled libraries for both Windows and Linux.
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/kafka.ad
@@ -1,6 +1,8 @@

=== Kafka

Use `symadmin module install kafka` to install driver files, or copy your own files into the `lib` sub-directory.

Send changes from your relational database to Kafka in a variety of formats. A Kafka node can be setup as a <<Load Only Node>> to receive changes from another node that is capturing changes.

ifdef::pro[]
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/mariadb.ad
@@ -1,6 +1,8 @@

=== MariaDB

Use `symadmin module install mariadb` to install driver files, or copy your own files into the `lib` sub-directory.

See MySQL notes. You can use either the MySQL or MariaDB driver for this dialect.

.Supported Data Types
Expand Down
4 changes: 3 additions & 1 deletion symmetric-assemble/src/asciidoc/appendix/mongodb.ad
@@ -1,6 +1,8 @@

=== MongoDB


Use `symadmin module install mongodb` to install driver files, or copy your own files into the `lib` sub-directory.

Since SymmetricDS is trigger based and there are not triggers in MongoDB data can only synchronized to a MongoDB instance. The runtime SymmetricDS
tables will also need to be installed in a full relational database to support integration with MongoDB.

Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/nuodb.ad
@@ -1,6 +1,8 @@

=== NuoDB

Use `symadmin module install nuodb` to install driver files, or copy your own files into the `lib` sub-directory.

SymmetricDS supports NuoDB, but it does not currently sync BLOB data or prevent update loops (when loading data from a remote node,
if a table is configured in sym_trigger with the sync_on_incoming flag enabled, then data is captured and will be synced back to the same node).

Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/redshift.ad
@@ -1,6 +1,8 @@

=== Redshift

Use `symadmin module install redshift` to install driver files, or copy your own files into the `lib` sub-directory.

Redshift is a managed data warehouse in the cloud from Amazon. Version 1.0 of Redshift is based on PostgreSQL 8.0,
with some features modified or removed. SymmetricDS supports Redshift as a target platform where data can be loaded,
but it does not support data capture. However, the initial load and reload functions are implemented, so it is
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/snowflake.ad
@@ -1,5 +1,7 @@
=== Snowflake

Use `symadmin module install snowflake` to install driver files, or copy your own files into the `lib` sub-directory.

Send changes from your relational database to Snowflake.

==== Setup
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/sqlite.ad
@@ -1,6 +1,8 @@

=== SQLite

Use `symadmin module install sqlite` to install driver files, or copy your own files into the `lib` sub-directory.

For SQLite, the implementation of sync-on-incoming back and the population of a source node if in the sym data rows relies on use of a
context table (by default, called sym_context) to hold a boolean and node id in place of the more common methods of using temp tables
(which are inaccessible from triggers) or functions (which are not available).
Expand Down
2 changes: 2 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/sybase-ase.ad
@@ -1,6 +1,8 @@

=== Sybase ASE

Use `symadmin module install sybase` to install driver files, or copy your own files into the `lib` sub-directory.

Sybase Adaptive Server Enterprise (ASE) was tested using the jConnect 7 JDBC driver. The jConnect 7 JDBC driver should be placed in the "lib" folder.

----
Expand Down
@@ -1,5 +1,7 @@

=== SQL Anywhere

Use `symadmin module install sybase` to install driver files, or copy your own files into the `lib` sub-directory.

SQL Anywhere and Sybase Adaptive Server Anywhere (ASA) were tested using the jConnect JDBC driver.
The jConnect JDBC driver should be placed in the "lib" folder.
3 changes: 3 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/teradata.ad
@@ -1,5 +1,8 @@

=== Teradata

Use `symadmin module install teradata` to install driver files, or copy your own files into the `lib` sub-directory.

NOTE: Teradata is only supported as a <<Load Only Node>>. It can only be used as a target to load data into from other dialects.

==== Drivers
Expand Down
3 changes: 3 additions & 0 deletions symmetric-assemble/src/asciidoc/appendix/tibero.ad
@@ -1,5 +1,8 @@

=== Tibero

Use `symadmin module install tibero` to install driver files, or copy your own files into the `lib` sub-directory.

This section describes Tibero specific SymmetricDS details.

==== Database Permissions
Expand Down

0 comments on commit cff2b85

Please sign in to comment.