You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: connectors/mysql/README.md
+72-9Lines changed: 72 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,8 +61,8 @@ Before using the MySQL connector (redis-connect-mysql) to capture the changes co
61
61
* 1G Network
62
62
* JRE 8+ (JRE 11 is preferred)
63
63
64
-
**NOTE**
65
-
64
+
|:memo:|
65
+
|---------------|
66
66
The current [release](https://github.com/RedisLabs-Field-Engineering/redis-connect-dist/releases) has been built with JDK 11 and tested with JRE 11 and above. Please have JRE 11+ installed prior to running this connector.
67
67
68
68
---
@@ -83,13 +83,76 @@ Copy the _sample_ directory and it's contents i.e. _yml_ files, _mappers_ and te
For [*nixOS](https://en.wikipedia.org/wiki/Unix-like)
92
+
93
+
### Configuration file for the startup script located under redis-connect-mysql/bin/redisconnect.conf
94
+
95
+
```bash
96
+
set -o allexport
97
+
98
+
REDISCONNECT_MIN_JAVA_VERSION="8"
99
+
REDISCONNECT_HOME="${pwd}.."
100
+
REDISCONNECT_CONFIG="$REDISCONNECT_HOME/config/samples"#prepend the correct path to loader or cdc config folder e.g. "$REDISCONNECT_HOME/config/samples/mysql" or "$REDISCONNECT_HOME/config/samples/loader" or path of your choice
101
+
REDISCONNECT_LOGBACK_CONFIG="$REDISCONNECT_HOME/config/logback.xml"#Location of the pre-packaged logback config
102
+
REDISCONNECT_BANNER_MODE="off"
103
+
REDISCONNECT_JAVA_OPTIONS="-XX:+HeapDumpOnOutOfMemoryError -Xms256m -Xmx1g"#edit or pass any JVM options here. Default is ok in most cases.
104
+
REDISCONNECT_EXTLIB_DIR="$REDISCONNECT_HOME/extlib"#All external libraries e.g. custom transformation jars, client jar etc can go here.
REDISCONNECT_REST_API_ENABLED="false"#This is to enable embedded REST_API support
107
+
REDISCONNECT_REST_API_PORT="8282"#update REST_API port to an available port if 8282 is taken.
108
+
REDISCONNECT_SOURCE_USERNAME=""#Source username can be set here or directly in the env.yml or it can also come from environment variable / system properties
109
+
REDISCONNECT_SOURCE_PASSWORD=""#Source password can be set here or directly in the env.yml or it can also come from environment variable / system properties
110
+
REDISCONNECT_TARGET_USERNAME=""#Target username can be set here or directly in the env.yml or it can also come from environment variable / system properties
111
+
REDISCONNECT_TARGET_PASSWORD=""#Target password can be set here or directly in the env.yml or it can also come from environment variable / system properties
112
+
REDISCONNECT_SECRET="secret"#This is used for encrypting any passwords using the CLI and can be left blank after the encryption
113
+
114
+
set +o allexport
115
+
```
116
+
117
+
|:memo:|
118
+
|---------------|
119
+
For [WindowsOS](https://en.wikipedia.org/wiki/Microsoft_Windows)
120
+
121
+
### Configuration file for the startup script located under redis-connect-mysql/bin/redisconnect.cmd
122
+
123
+
```bat
124
+
set REDISCONNECT_HOME=%cd%\..
125
+
set REDISCONNECT_CONFIG=%REDISCONNECT_HOME%\config\samples
126
+
set REDISCONNECT_LOGBACK_CONFIG=%REDISCONNECT_HOME%\config\logback.xml
127
+
set REDISCONNECT_BANNER_MODE="off"
128
+
set REDISCONNECT_JAVA_OPTIONS=-XX:+HeapDumpOnOutOfMemoryError -Xms256m -Xmx1g
129
+
set REDISCONNECT_EXTLIB_DIR=%REDISCONNECT_HOME%\extlib
130
+
set REDISCONNECT_LIB_DIR=%REDISCONNECT_HOME%\lib\*;%REDISCONNECT_EXTLIB_DIR%\*
131
+
set CLASSPATH=.
132
+
set CLASSPATH="%CLASSPATH%;%REDISCONNECT_LIB_DIR%"
url: redis://${REDISCONNECT_TARGET_USERNAME}:${REDISCONNECT_TARGET_PASSWORD}@127.0.0.1:14001#if no value is passed to the username and/or password then "" is assumed. You can also parameterize the whole url e.g. ${REDISCONNECT_JOBCONFIG_REDIS_URL} and set the value in the redisconnect.conf file or through environment variable / system property
url: redis://${REDISCONNECT_TARGET_USERNAME}:${REDISCONNECT_TARGET_PASSWORD}@127.0.0.1:14000#if no value is passed to the username and/or password then "" is assumed. You can also parameterize the whole url e.g. ${REDISCONNECT_TARGET_REDIS_URL} and set the value in the redisconnect.conf file or through environment variable / system property
url: redis://${REDISCONNECT_TARGET_USERNAME}:${REDISCONNECT_TARGET_PASSWORD}@127.0.0.1:14001#if no value is passed to the username and/or password then "" is assumed. You can also parameterize the whole url e.g. ${REDISCONNECT_METRICS_REDIS_URL} and set the value in the redisconnect.conf file or through environment variable / system property
url: "jdbc:mysql://127.0.0.1:3306/RedisConnect?useInformationSchema=true"#You can also parameterize the whole url e.g. ${REDISCONNECT_SOURCE_URL} and set the value in the redisconnect.conf file or through environment variable / system property
289
+
host: 127.0.0.1#You can also parameterize the host e.g. ${REDISCONNECT_SOURCE_HOST} and set the value in the redisconnect.conf file or through environment variable / system property
290
+
port: 3306#You can also parameterize the port e.g. ${REDISCONNECT_SOURCE_PORT} and set the value in the redisconnect.conf file or through environment variable / system property
The above script will create a 1-node Redis Enterprise cluster in a docker container, [Create a target database with RediSearch module](https://docs.redislabs.com/latest/modules/add-module-to-database/), [Create a job management and metrics database with RedisTimeSeries module](https://docs.redislabs.com/latest/modules/add-module-to-database/), [Create a RediSearch index for emp Hash](https://redislabs.com/blog/getting-started-with-redisearch-2-0/) and [Start an instance of RedisInsight](https://docs.redislabs.com/latest/ri/installing/install-docker/).
0 commit comments