Writing data generation output to a Tonic Ephemeral snapshot

Only available for PostgreSQL, MySQL, and SQL Server.

Not compatible with upsert.

Not compatible with Preserve Destination or Incremental table modes.

If Ephemeral supports your workspace database type, then you can choose to write the destination data to a snapshot in Ephemeral. You can then use the snapshot to start Ephemeral databases.

To write the transformed data to Ephemeral, under Destination Settings, click Ephemeral Database.

Selecting the Ephemeral instance type

Structural can write the data snapshot to either Ephemeral Cloud or to a self-hosted instance of Ephemeral. By default, Structural writes the data snapshot to Ephemeral Cloud.

For Ephemeral Cloud, Structural writes the snapshot to the account for the user who runs the data generation job. If that user has an Ephemeral account on Ephemeral Cloud, then Structural uses that account. If the user does not have an account, then Structural creates a two-week Ephemeral free trial account for the user.

Note that if you are on a self-hosted instance of Ephemeral, then you must always provide an Ephemeral API key.

To write a snapshot to Ephemeral Cloud:

  1. Click Tonic Ephemeral cloud.

  2. If you are on a self-hosted instance of Structural, in the API Key field, provide an Ephemeral API key from your Ephemeral account.

To write the snapshot to a self-hosted instance of Ephemeral:

  1. Click Tonic Ephemeral self-hosted.

  2. In the API Key field, provide an Ephemeral API key from your Ephemeral account. Structural writes the snapshot to the Ephemeral account that is associated with the API key.

  3. In the Tonic Ephemeral URL field, provide the URL to your self-hosted Ephemeral instance.

Displaying advanced settings for the snapshot

If you do not configure any advanced settings, then:

  • The snapshot uses the same name as the workspace, and has no description.

  • The snapshot size allocation is determined by the source data size.

  • Structural discards the temporary Ephemeral database that is created during the data generation.

To change any of these settings, click Advanced settings.

Providing a snapshot name and description

By default, the snapshot name uses the workspace name.

When you run data generation, if a snapshot with the same name already exists in Ephemeral, then Structural overwrites that snapshot with the new snapshot.

Under Advanced settings:

  1. In the Snapshot name field, provide the name of the snapshot. The snapshot name can use the following placeholder values to help identify the snapshot:

    • {workspaceName} - Inserts the name of the workspace.

    • {workspaceId} - Inserts the identifier of the workspace.

    • {jobId} - Inserts the identifier of the data generation job that created the snapshot.

    • {timestamp} - Inserts the timestamp when the snapshot was created.

    Including the job ID or timestamp ensures that a data generation job does not overwrite a previous snapshot.

  2. Optionally, in the Snapshot description field, provide a longer description of the snapshot.

Setting the size allocation for the snapshot

By default, the Ephemeral size allocation for the snapshot is based on the size of the source data.

To instead provide a custom data size allocation, under Advanced settings:

  1. Toggle Custom data size allocation to the on position.

  2. In the field, enter the size allocation in gigabytes.

Indicating whether to keep the temporary Ephemeral database

When Structural creates the Ephemeral snapshot, it creates a temporary Ephemeral database.

By default, Structural deletes that database when the data generation is complete.

To instead keep the database, under Advanced settings, toggle Keep database active in Tonic Ephemeral after data generation to the on position.

Providing a customization file for MySQL

For a MySQL workspace, you can provide a customization file that helps to ensure that the temporary Ephemeral database is configured correctly.

To provide the customization details:

  1. Toggle Use custom configuration to the on position.

  2. In the text area, paste the contents of the customization file.

Last updated