Link Enrichment Datastore
An enrichment datastore is a database used to enhance your existing data by adding additional, relevant information. This helps you to provide more comprehensive insight into data and improve data accuracy.
You have the option to link an enrichment datastore to your existing source datastore. However, some datastores cannot be linked as enrichment datastores. For example, Oracle, Athena, Dremio, and Timescale cannot be used for this purpose.
Let's get started 🚀
Step 1: Select a source datastore from the side menu for which you would like to configure Link Enrichment.
Step 2: Click on the Settings icon from the top right window and select the Enrichment option from the dropdown menu.
A modal window- Link Enrichment Datastore will appear, providing you with two options to link an enrichment datastore.
| REF. | FIELDS | ACTIONS |
|---|---|---|
| 1. | Prefix | Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore. |
| 2. | Caret Down Button | Click the caret down to select either Use Enrichment Datastore or Add Enrichment Datastore. |
| 3. | Enrichment Datastore | Select an enrichment datastore from the dropdown list. |
Option I: Link New Enrichment
If the toggle Add new connection is turned on, then this will prompt you to link a new enrichment datastore from scratch without using existing connection details.
Note
Connection details can vary from datastore to datastore. For illustration, we have demonstrated linking BigQuery as a new enrichment datastore.
Step 1: Click on the caret button and select Add Enrichment Datastore.
A modal window Link Enrichment Datastore will appear. Enter the following details to create an enrichment datastore with a new connection.
| REF. | FIELDS | ACTIONS |
|---|---|---|
| 1 | Prefix | Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore. |
| 2 | Name | Give a name for the enrichment datastore. |
| 3 | Toggle Button for add new connection | Toggle ON to create a new enrichment from scratch or toggle OFF to reuse credentials from an existing connection. |
| 4 | Connector | Select a datastore connector from the dropdown list. |
Step 2: Add connection details for your selected enrichment datastore connector.
Step 3: After adding the source datastore details, click on the Test Connection button to check and verify its connection.
If the credentials and provided details are verified, a success message will be displayed indicating that the connection has been verified.
Step 4: Click on Save button.
Step 5: After clicking on the Save button a modal window will appear Your Datastore has been successfully updated.
Option II: Link Existing Connection
If the Use an existing enrichment datastore option is selected from the dropdown menu, you will be prompted to link the enrichment datastore using existing connection details.
Step 1: Click on the caret button and select Use Enrichment Datastore.
Step 2: A modal window Link Enrichment Datastore will appear. Add a prefix name and select an existing enrichment datastore from the dropdown list.
| REF. | FIELDS | ACTIONS |
|---|---|---|
| 1. | Prefix | Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore. |
| 2. | Enrichment Datastore | Select an enrichment datastore from the dropdown list. |
Step 3: View and check the connection details of the enrichment and click on the Save button.
Step 4: After clicking on the Save button a modal window will appear Your Datastore has been successfully updated.
When an Enrichment Datastore is linked, you can see a green light showing that the connection between the Datastore and the Enrichment Datastore are stable or red if it's unstable.
Endpoint (Patch)
/api/datastores/{datastore-id}/enrichment/{enrichment-id} (patch)