Configuring Yugabyte workspace data connections
Source and destination databases should be on different clusters.
On the workspace configuration view, under Connection Type, click Yugabyte SQL.
Connecting to the source database
In the Source Settings section, provide the details about connecting to the source database.
To provide the connection details, you can either populate the connection fields or use a connection string.
Populating the connection fields
By default, Use connection string is off, and you provide the connection values in the individual fields:
In the Server field, provide the server where the database is located.
In the Database field, provide the name of the database.
In the Port field, provide the port to use to connect to the database.
In the Username field, provide the username for the account to use to connect to the database.
In the Password field, provide the password for the specified username.
To test the connection to the source database, click Test Source Connection.
Using a connection string
To use a connection string to connect to the source database:
Toggle Use connection string to the on position.
In the Connection String field, provide the connection string.
The connection string uses the following format:
Server=serverIP;Database=databaseName;User Id=userName;Password=<password>
For Password, you set the value to <password>, and then type the actual password in the Password field.
To test the connection to the source database, click Test Source Connection.
Ensuring encryption of source database authentication
The Enable SSL/TLS setting indicates whether to encrypt source database authentication.
By default, the toggle is in the on position. We strongly recommend that you do not turn off SSL.
Trusting the server certificate
To indicate that Structural should trust the server certificate, toggle Trust Server Certificate to the on position.
Connecting through an SSH bastion
For additional security, to connect through an SSH bastion :
Toggle Enable SSH Tunnel to the on position.
In the SSH Host field, provide the host for the SSH bastion.
In the SSH Port field, provide the port for the SSH bastion.
In the SSH User field, provide the name of the user to use to connect to the SSH bastion.
If you do not use a private key, then in the SSH Passphrase field, provide the passphrase to use for authentication.
If you do use a private key, then in the SSH Private Key field, provide the private key. If the private key uses a passphrase, then in the SSH Passphrase field, provide the passphrase for the private key.
Limiting the included schemas
By default, the source database includes all of the schemas. To specify a list of specific schemas to either include or exclude:
Toggle Limit Schemas to the on position.
From the filter option dropdown list, select whether to include or exclude the listed schemas.
In the field, provide the list of schemas to either include or exclude. Use commas or semicolons to separate the schemas.
Do not exclude schemas that are referred to by included schemas, unless you create those schemas manually outside of Structural.
Blocking data generation for all schema changes
By default, data generation is not blocked as long as schema changes do not conflict with your workspace configuration.
To block data generation when there are any schema changes, regardless of whether they conflict with your workspace configuration, toggle Block data generation on schema changes to the on position.
Connecting to the destination database
Under Destination Settings, provide the connection details for the destination database. Structural installs any generally available extensions that are used on the source database. However, you must manually install any custom extensions and plugins.
You can either populate the connection fields or use a connection string.
Populating the connection fields
By default, Use connection string is off, and you provide the connection values in the individual fields:
In the Server field, provide the server where the database is located.
In the Database field, provide the name of the database.
In the Port field, provide the port to use to connect to the database.
In the Username field, provide the username for the account to use to connect to the database.
In the Password field, provide the password for the specified username.
To test the connection to the destination database, click Test Destination Connection.
Using a connection string
To use a connection string to connect to the source database:
Toggle Use connection string to the on position.
In the Connection String field, provide the connection string.
The connection string uses the following format:
Server=serverIP;Database=databaseName;User Id=userName;Password=<password>
For Password, you set the value to <password>, and then type the actual password in the Password field.
To test the connection to the destination database, click Test Destination Connection.
Ensuring encryption of destination database authentication
The Enable SSL/TLS setting indicates whether to encrypt the destination database authentication.
By default, the toggle is in the on position. We strongly recommend that you do not turn off this setting.
Trusting the server certificate
To indicate that Tonic should trust the server certificate, toggle Trust Server Certificate to the on position.
Connecting through an SSH bastion
To connect to an SSH bastion for additional security:
Toggle Enable SSH Tunnel to the on position.
In the SSH Host field, provide the host for the SSH bastion.
In the SSH Port field, provide the port for the SSH bastion.
In the SSH User field, provide the name of the user to use to connect to the SSH bastion.
If you do not use a private key, then in the SSH Passphrase field, provide the passphrase to use for authentication.
If you do use a private key, then in the SSH Private Key field, provide the private key. If the private key uses a passphrase, then in the SSH Passphrase field, provide the passphrase for the private key.
Last updated