Configuring Spark SDK workspace data connections

The SDK requires a connection to the Tonic Structural web server. To access the SDK experience from within Tonic, you must create a workspace that connects to a Spark database.

When configuring the SDK, the Structural application requires a connection to a catalog database to retrieve table information and data.

Structural supports Hive or Dremio.

Connecting to a Hive catalog database

Providing the connection details

Under Catalog Database, to connect to a Hive catalog using the SDK:

  1. Under Catalog Type, click Hive.

  2. Under Launch Method, click SDK.

  3. In the Hive Catalog Database field, enter the name of the database.

  4. In the Server field, provide the server where the database is located.

  5. In the Port field, provide the port to use to connect to the database.

  6. In the Username field, provide the username for the account to use to connect to the database.

  7. In the Password field, provide the password for the specified user.

  8. To test the connection to the Hive catalog database, click Test Hive Connection.

Enabling validation of table filters

For Spark workspaces, you can provide where clauses to filter tables. For details, go to Applying a filter to tables.

The Enable partition filter validation setting indicates whether Structural should validate those filters when you create them.

By default, the setting is in the on position, and Structural validates the filters. To disable the validation, toggle Enable partition filter validation to the off position.

Connecting to a Dremio catalog database

To connect to a Dremio catalog using the SDK:

  1. Under Catalog Type, click Dremio.

  2. Under Connection Method, select either Legacy ODBC or Arrow Flight.

  3. In the Server field, provide the name of the server.

  4. In the Port field, provide the port to use to connect to the database.

  5. In the Username field, provide the name of the user to use to connect to the database.

  6. In the Password field, provide the password for the specified user.

  7. By default, the source data contains all of the schemas. To limit the data to specific schemas, in the Schema(s) field, enter the list of schemas.

  8. If you selected Legacy ODBC as the connection method, then in the Delegation Username field, enter the name of the delegation user.

  9. By default, SSL is enabled, and Enable SSL/TLS is in the on position. We strongly recommend that you do not turn off SSL.

  10. To test the connection to the Dremio catalog, click Test Dremio Connection.

Blocking data generation on 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.

Last updated