Skip to content

Commit

Permalink
0005302: Updated docs to reflect Connect Database Wizard and batch sc…
Browse files Browse the repository at this point in the history
…reen changes and ran spotlessApply
  • Loading branch information
evan-miller-jumpmind committed Jul 13, 2022
1 parent 535090f commit 47967c0
Show file tree
Hide file tree
Showing 61 changed files with 30 additions and 33 deletions.
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/S3.ad
Expand Up @@ -11,7 +11,7 @@ Use `symadmin module install S3` to install driver files, or copy your own files

Send changes from your relational database to S3 as a CSV file. An S3 node can be setup as a <<Load Only Node>> to receive changes from another node that is capturing changes.

Setup the S3 node by using the <<Add Node,Add Database>> wizard and selecting Amazon S3 as the type. User and password are not needed (or used).
Setup the S3 node by using the <<Add Node,Connect Database>> wizard and selecting Amazon S3 as the type. User and password are not needed (or used).

After hitting next you can setup the bucket in S3 that the files go to as well as the directory path desired within that bucket. This will also be where you specify the user credentials that have access to your Amazon S3 instance.

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/bigquery.ad
Expand Up @@ -13,7 +13,7 @@ Send changes from your relational database to Google's BigQuery.
BigQuery is only supported as a load only node in SymmetricDS. See <<Load Only Node>> for details on setting up a load only node in SymmetricDS.

ifdef::pro[]
Setup the BigQuery node by using the <<Add Node,Add Database>> wizard and selecting BigQuery as the type.
Setup the BigQuery node by using the <<Add Node,Connect Database>> wizard and selecting BigQuery as the type.

image::images/appendix/bigquery-database-settings.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/elasticsearch.ad
Expand Up @@ -11,7 +11,7 @@ Use `symadmin module install elasticsearch` to install driver files, or copy you

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

Setup the Elasticsearch node by using the <<Add Node,Add Database>> wizard and selecting Elasticsearch as the type. The URL will be the connection point to Elasticsearch. If your Elasticsearch database has security enabled, please enter your username and password. When selecting an Elasticsearch User, make sure that the minimum permissions given to the user are all of the Index level permissions. This can be done by creating a custom role with those permissions, and assigning that role to the user.
Setup the Elasticsearch node by using the <<Add Node,Connect Database>> wizard and selecting Elasticsearch as the type. The URL will be the connection point to Elasticsearch. If your Elasticsearch database has security enabled, please enter your username and password. When selecting an Elasticsearch User, make sure that the minimum permissions given to the user are all of the Index level permissions. This can be done by creating a custom role with those permissions, and assigning that role to the user.

image::images/appendix/elasticsearch-node-setup.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/kafka.ad
Expand Up @@ -6,7 +6,7 @@ Use `symadmin module install kafka` to install driver files, or copy your own fi
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[]
Setup the Kafka node by using the <<Add Node,Add Database>> wizard and selecting Kafka as the type. The URL will be the connection point to Kafka. User and password are not needed (or used).
Setup the Kafka node by using the <<Add Node,Connect Database>> wizard and selecting Kafka as the type. The URL will be the connection point to Kafka. User and password are not needed (or used).

image::images/appendix/kafka-node-setup.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/mssqlserver.ad
Expand Up @@ -124,4 +124,4 @@ endif::pro[]

==== Loading Data

When registering a SQL Server database with SymmetricDS, bulk loading will be be checked by default. In order to make use of bulk loading, the user must provide a path to a bcp executable (installation for this executable is linked in the Add Database Wizard when asked about bulk loading).
When registering a SQL Server database with SymmetricDS, bulk loading will be be checked by default. In order to make use of bulk loading, the user must provide a path to a bcp executable (installation for this executable is linked in the Connect Database Wizard when asked about bulk loading).
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/opensearch.ad
Expand Up @@ -11,7 +11,7 @@ Use `symadmin module install opensearch` to install driver files, or copy your o

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

Setup the OpenSearch node by using the <<Add Node,Add Database>> wizard and selecting OpenSearch as the type. The URL will be the connection point to OpenSearch. User and password are not needed (or used).
Setup the OpenSearch node by using the <<Add Node,Connect Database>> wizard and selecting OpenSearch as the type. The URL will be the connection point to OpenSearch. User and password are not needed (or used).

image::images/appendix/opensearch-node-setup.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/oracle.ad
Expand Up @@ -71,7 +71,7 @@ GRANT CREATE ANY TRIGGER TO yourusername;
GRANT EXECUTE ON UTL_RAW To yourusername;
----

Register your Oracle database with Symmetric using the user you've just created. Once you have done that, when you get to the Bulk Loading screen on the Add Database Wizard you will need to provide a path to your SQL Loader installation. If you do not have SQL Loader installed, there is a link provided in the Add Database Wizard where you can go to get this installed.
Register your Oracle database with Symmetric using the user you've just created. Once you have done that, when you get to the Bulk Loading screen on the Connect Database Wizard you will need to provide a path to your SQL Loader installation. If you do not have SQL Loader installed, there is a link provided in the Connect Database Wizard where you can go to get this installed.

Once you have your database registered, to utilize Oracle Bulk loading versus straight JDBC insert, specify the Oracle Bulk Loader ("bulk") in the data_loader_type column of sym_channel table.

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/appendix/snowflake.ad
Expand Up @@ -9,7 +9,7 @@ Snowflake can also be set up to capture changes using log-mining.


ifdef::pro[]
Setup the Snowflake node by using the <<Add Node,Add Database>> wizard and selecting Snowflake as the type.
Setup the Snowflake node by using the <<Add Node,Connect Database>> wizard and selecting Snowflake as the type.

image::images/appendix/snowflake-database-settings.png[]

Expand Down
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.
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.
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.
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.
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.
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.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified symmetric-assemble/src/asciidoc/images/import-wizard-profile.png
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.
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.
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.
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.
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.
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.
Binary file modified symmetric-assemble/src/asciidoc/images/wizard-node-setup.png
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/manage.ad
Expand Up @@ -26,7 +26,7 @@ endif::pro[]

ifdef::pro[]

Add nodes to your synchronization scenario by using the Add Database Wizard. This wizard is automatically shown when less the 2 nodes are configured.
Add nodes to your synchronization scenario by using the Connect Database Wizard. This wizard is automatically shown when less the 2 nodes are configured.
It can also be accessed from the Manage Nodes screen by clicking the *Add* button.

image::images/wizard-connect/wizard-connect-menu.png[]
Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/manage/incoming-batches.ad
Expand Up @@ -86,7 +86,7 @@ Batches in Error can be viewed when the *Status* is set to _<Not Ok>_ or _Error_

image::images/manage/manage-incoming-batches-error.png[]

The error message can be viewed by clicking the *Magnifying Glass* link in the details column.
The error message can be viewed by clicking the *Bar Chart* link in the details column.

image::images/manage/manage-incoming-batches-error-show.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/manage/outgoing-batches.ad
Expand Up @@ -67,7 +67,7 @@ To show only batches in error, select the status of _Error_:

image::images/manage/manage-outgoing-batches-error.png[]

In order to view the error message, click the *magnifying glass* link in the details column of the outgoing batch row of interest.
In order to view the error message, click the *bar chart* link in the details column of the outgoing batch row of interest.

image::images/manage/manage-outgoing-batches-error-show.png[]

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/setup/engine-properties.ad
@@ -1,6 +1,6 @@
=== Node Properties File
ifdef::pro[]
The add database wizard generates a properties file that contains all the information a node needs to bootstrap itself.
The connect database wizard generates a properties file that contains all the information a node needs to bootstrap itself.
endif::pro[]

Each node that is deployed to a server is represented by a properties file that allows it to connect to a database and
Expand Down
6 changes: 3 additions & 3 deletions symmetric-assemble/src/asciidoc/setup/load-only-setup.ad
Expand Up @@ -21,11 +21,11 @@ ifdef::pro[]
* To setup a load only node, begin by adding a new node to your configuration (See <<Add Node>> for details on adding a new node).

===== Setup Load Only Node For Supported Databases
* On the database setup screen of the add database wizard, select load only after selecting your database type.
* On the database setup screen of the connect database wizard, select load only after selecting your database type.

image::images/manage/manage-load-only.png[]

* The remaining steps in the add database wizard are the same as if adding a full node so continue through the remainder of the add database wizard to complete the configuration.
* The remaining steps in the connect database wizard are the same as if adding a full node so continue through the remainder of the connect database wizard to complete the configuration.

===== Setup Load Only Node For Unsupported Databases

Expand All @@ -49,7 +49,7 @@ An exmaple jdbc connection url for this driver so that when it is selected in th

* Click Save and the database setup screen will now be populated with your new driver information.

* The remaining steps in the add database wizard are the same as if adding a full node so continue through the remainder of the add database wizard to complete the configuration.
* The remaining steps in the connect database wizard are the same as if adding a full node so continue through the remainder of the connect database wizard to complete the configuration.

NOTE: Uploading a jar file is only available in the standalone installation of SymmetricDS, NOT with the deployed war file setup. For a web container (war) based deployment you would need to add the driver jar to the web servers classpath and restart. Then provide the driver class and url manually as explained in steps 4 and 5 below.

Expand Down
2 changes: 1 addition & 1 deletion symmetric-assemble/src/asciidoc/setup/pro-node-select.ad
Expand Up @@ -2,7 +2,7 @@
=== Node Type

When opening the web console, if there are no nodes defined within the running instance,
the *Add Database Wizard* will be displayed to guide you through the process of creating one. There are two types of nodes:
the *Connect Database Wizard* will be displayed to guide you through the process of creating one. There are two types of nodes:

. *Setup New Replication* - The primary node is typically the first node set up when creating a new replication scenario, and it
serves as the central place where configuration is done. All configuration is stored in the database that this node is attached to.
Expand Down
@@ -1,6 +1,6 @@

=== Node Setup

Once configuration is complete SymmetricDS will automatically pop up an Add Database Wizard if there is only one node currently setup in your network.
Once configuration is complete SymmetricDS will automatically pop up a Connect Database Wizard if there is only one node currently setup in your network.

See <<Add Node>> for more information.
4 changes: 2 additions & 2 deletions symmetric-assemble/src/asciidoc/tutorials/quick-start.ad
Expand Up @@ -174,7 +174,7 @@ endif::pro[]
ifdef::pro[]
image::images/wizard-node-setup.png[]

. Select "Master Node" from the add database wizard
. Select "Master Node" from the connect database wizard
. Provide JDBC connection information for your source database, hit next
. Select "Standard 2 Tier" profile, hit next
. Use the default sync url, hit next
Expand Down Expand Up @@ -292,7 +292,7 @@ TIP: For complete instructions creating the target node click link:user-guide.ht
endif::pro[]

ifdef::pro[]
The Add Database Wizard will be displayed by default when only one node has been configured. If it is closed or not visible it can be opened by hitting the "Add" button on the Nodes screen of the Manage tab.
The Connect Database Wizard will be displayed by default when only one node has been configured. If it is closed or not visible it can be opened by hitting the "Add" button on the Nodes screen of the Manage tab.

image::images/wizard-connect/wizard-connect-menu.png[]

Expand Down
Expand Up @@ -189,16 +189,13 @@ public PermissionResult getLogMinePermission() {
missingGrants.append(name);
}
}

String logMode = getSqlTemplate().queryForString("SELECT LOG_MODE FROM V$DATABASE");
if (!logMode.equals("ARCHIVELOG")) {
if (missingGrants.length() > 0) {
missingGrants.append(", ");
}
missingGrants.append("DATABASE MUST BE IN ARCHIVE LOG MODE");
}


String logMode = getSqlTemplate().queryForString("SELECT LOG_MODE FROM V$DATABASE");
if (!logMode.equals("ARCHIVELOG")) {
if (missingGrants.length() > 0) {
missingGrants.append(", ");
}
missingGrants.append("DATABASE MUST BE IN ARCHIVE LOG MODE");
}
if (missingGrants.length() > 0) {
log.error("Missing privileges: {}", missingGrants.toString());
result.setSolution("Grant " + missingGrants.toString());
Expand All @@ -225,10 +222,10 @@ public PermissionResult getLogMinePermission() {
private boolean hasSystemPrivilege(String name) {
return getSqlTemplate().queryForInt("select count(*) from user_sys_privs where privilege = ?", name) > 0;
}
/*
private boolean hasDbaSystemPrivilege(String name) {
return getSqlTemplate().queryForInt("select count(*) from dba_sys_privs where privilege = ?", name) > 0;
}*/
/*
* private boolean hasDbaSystemPrivilege(String name) { return getSqlTemplate().queryForInt("select count(*) from dba_sys_privs where privilege = ?", name)
* > 0; }
*/

private boolean hasPrivilege(String name) {
return getSqlTemplate().queryForInt("select count(*) from user_role_privs where granted_role = ?", name) > 0;
Expand Down

0 comments on commit 47967c0

Please sign in to comment.