Transferring data to Firebolt

This guide explains how to transfer data to Firebolt to store and further process information.

You can assign multiple destinations to a datastream. For more information on possible limitations, see Assigning multiple destinations to a datastream.

Prerequisites

Before you complete the procedure in this guide, perform all of the following actions:

  • Create a datastream whose data you want to transfer to Firebolt. For more information on creating a datastream, see Collecting data in Adverity.

  • Find the address of the Firebolt database where you want to transfer data.

  • Set up an Amazon S3 bucket as storage for Firebolt. For more information, see Setting up Storage for data extracts.

  • Find the region code of your S3 bucket. The region code determines which database to enter when setting up an authorization to Firebolt. For more information on finding your S3 bucket region code, see the AWS documentation.

Procedure

To transfer data from a datastream to Firebolt, follow these steps:

  1. Add Firebolt as a destination to the workspace which contains the datastream or to one of its parent workspaces.

  2. Assign the Firebolt destination to the datastream.

  3. Configure transfer settings.

Adding Firebolt as a destination

To add Firebolt as a destination to a workspace, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Destinations.

  2. Click + Add Destination.

  3. Click Firebolt.

  1. In the authorization page, fill in the following fields:

    Database

    Specify the name of the Firebolt database where you want to transfer the data. Make sure the database shares the same region code as the S3 bucket that stores the data.

    Username

    The username of the Firebolt account.

    Password

    The password of the Firebolt account.

  2. Click Authorize.

  3. In the Configuration page, fill in the following fields:

    Name

    (Optional) Rename the destination.

    S3 Storage

    Select the S3 storage that stores the data. Leave this field empty to use the default workspace storage settings.

  1. Click Create.

Assigning Firebolt as a destination

To assign the Firebolt destination to a datastream, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Datastreams.

  2. Open the Connector Name datastream by clicking on its name.

  1. In the Transfer section, below the Store section, click + Assign destination.

  2. Click Assign existing destinations.

  1. Select the Firebolt checkbox in the list.

  2. Click Save.

Configuring transfer settings

To configure transfer settings, follow these steps:

  1. Select the workspace you work with in Adverity and then, in the platform navigation menu, click Datastreams.

  2. Open the Connector Name datastream by clicking on its name.

  1. In the Destinations section, find the Firebolt destination in the list, and click on the right.

  2. Click Destination settings.

  1. Fill in the following fields:

    Table name

    Specify the target table in the destination where to transfer data from the datastream. The name can contain alphanumeric characters and underscores. For example, target_table.

    By default, Adverity saves data from each datastream in a different table named {datastream_type}_{datastream_id} (for example, mailgun_83).

    You can specify the same target table for several datastreams. If a column is shared between datastreams, Adverity performs a full outer join and concatenates values. If a column is not shared between datastreams, Adverity writes null values in the relevant cells.

    Use placeholders to create unique, dynamic table names in the destination. Use the following placeholders:

    Placeholder

    Description

    {app_label}

    The Datastream Type's short name.

    {datastream_id}

    The datastream ID.

    {datastream_type}

    The Datastream Type.

    {extract_id}

    The data extract ID.

    {id}

    The datastream ID.

    {meta[*]}

    Replace * with a metadata placeholder to use metadata in the name. For example, {meta[datastream_URI]} uses the datastream URI as the name. For more information on metadata and placeholders, see Using placeholders.

    {name}

    The automatically generated filename of the data extract.

    {scheduled_day}

    The day when the data fetch was scheduled to run.

    {scheduled_month}

    The month when the data fetch was scheduled to run.

    {scheduled_year}

    The year when the data fetch was scheduled to run.

    {upload_day}

    The day when the data extract is transferred to the Firebolt destination.

    {upload_hour}

    The hour when the data extract is transferred to the Firebolt destination.

    {upload_minute}

    The minute when the data extract is transferred to the Firebolt destination.

    {upload_month}

    The month when the data extract is transferred to the Firebolt destination.

    {upload_second}

    The second when the data extract is transferred to the Firebolt destination.

    {upload_year}

    The year when the data extract is transferred to the Firebolt destination.

    Mode

    Select what Adverity does when a table already exists in the Firebolt destination. Select one of the following options:

    • Select Delete to delete all data in the exiting table in the destination before populating the table with the most recent data extract.

    • Select Protected to make sure the transferred data is not deleted in future data transfers.

    Primary Index

    Enter the primary fields that tells Firebolt how to sort and index the data. By default, the primary field of dt_created is entered. Enter multiple primary indexes separated by commas. For more information on primary indexes, see the Firebolt documentation.

  2. Click Save.