Data products #

Starburst Galaxy data products provide a collection of curated, high-quality related datasets and relevant metadata.

Data products increase the discoverability of your data, and are assigned to the data domains that define your business.

You can use data products to accomplish a number of goals. For example, you can expose curated datasets to data consumers, providing high visibility to important data within your organization from a single interface.

Additionally, data products let you supply more detailed business context to users of your datasets with the data products details view. For example, you may decide to include syntax to execute a particular SQL statement that returns useful information, or attach images and links that support the dataset.

View data products #

View and use curated datasets from your organization on the Data products pane in Starburst Galaxy.

If your account has no data products to view, this pane provides the steps to create one. To create a data product, your active role set must include a role with the MANAGE_SECURITY account privilege.

Accounts with data products to view can use the Search data products text field to find data products by name or by the contents of their summaries.

Your list of data products can be displayed in a grid or a table. To view your data products in a grid, click . To switch to table format, click .

In grid mode, data products are listed as cards with the name, summary, and contacts displayed:

In table mode, data products are listed in a table with columns for name, summary, and contacts:

Click View details to navigate to the data product’s details pane. Alternatively, click the name of the data product to view the details pane when using table mode.

Click the options menu to execute various tasks related to the data product:

• Query data: Opens the underlying schema in the query editor.
• View data details: Opens the underlying schema in the catalog explorer.
• Get connections: Opens the connection information dialog for connecting to clients.
• Edit data product: Opens the Edit data product pane.
• Delete data product: Opens a confirmation dialog to delete the data product. Click Yes, delete to delete the data product, or No, do not delete to cancel. Deleting a data product cannot be undone. Deleting the data product does not affect the underlying schema.

Data product details #

The data products details pane lets you view detailed information for your data product including the Markdown description, metadata, and the underlying schema details:

Click View schema to navigate to the the underlying schema in the catalog explorer. To query the underlying schema in the query editor, click Query data.

In addition to the name, summary, and description of your data product, you can view various properties of the data product with the details elements on the right:

• Default cluster: Lists the default cluster for the data product.
• Supporting information: Lists relevant web links defined at creation of the data product, or imported from the underlying schema.
• Contacts: Lists users assigned as contacts defined at creation of the data product, or imported from the underlying schema.
• Schema tags: Lists tags assigned to the underlying schema. Tags in data products are read-only.
• Promoted schema details: Lists information about the underlying schema:
  • Promoted schema: The name of the underlying schema with the name of its catalog preceding it.
  • Owner: The owning role for the underlying schema.
• Data products details: Lists information about the data product:
  • Created on: The timestamp of the date of creation.
  • Created by: The user who created the data product.
  • Last updated on: The timestamp for when the data product was last updated.
  • Last updated by: The user who last updated the data product.

Create a data product from a schema #

You can create a data product from an existing schema by promoting it.

To promote a schema to a data product:

1. Locate the schema you would like to promote to a data product in the schemas level of the catalog explorer.

2. Click Promote to data product:

    

3. In the dialog, select the schema metadata you would like to import. You can import the schema description, relevant web links, and users assigned as contacts. Click Skip to import no metadata, or Import to import selected metadata.
4. In the Promote to data product pane, enter a name, summary, and description for your data product:
   • Name: A descriptive name for your data product.
   • Summary: An informative and condensed summary of your data product. The summary field is populated by the description of your schema if you chose to import the description metadata.
   • Description: A more detailed description of your data product. The description text field lets you provide pertinent information about the data product, such as intended use. Markdown is supported in this field. Click Preview description to view your description rendered with Markdown styling.
5. Select a cluster from the Default cluster menu.
6. Click + Add link in the Supporting information section to add web links that are relevant to the data product. Links are imported from the schema if you chose to import link metadata.
7. Select users to add as contacts in the Contacts menu. Contacts are imported from the schema if you chose to import contact metadata.
8. Click Promote data product. to finish creating your data product.

Create a data product from a query #

You can create a data product directly from the query editor.

To create a data product from a query:

1. Click Create a data product in the results pane after running a query.

   

2. In the Create data product dialog, select Add to existing data product and choose an existing data product from the drop-down menu, or select Create new data product from query to create a new one.

   

3. Click Next to continue adding to an existing data product, or creating a new one.

Add to existing data product #

The Define dataset pane lets you make edits to the SQL query that you are adding to the existing data product. The CREATE clause is automatically added at time of dataset creation.

Click Preview dataset to view a sample of the dataset, up to 10 rows. You must preview and run the dataset if changes are made to the SQL query.

To finish adding the query to an existing data product, choose the Dataset type, either Table, View, or Materialized View, enter a name in the Dataset name field, and click Add to data product.

If selecting Materialized View as the dataset type, use the Select storage schema menu to specify the storage table location for the materialized view. Use a different schema than the data product schema.

Create a new data product from query #

The Data product location dialog requires you to enter general details for the data product.

Select the catalog location from the Catalog menu, and enter a schema name in the Schema field. Click Save and continue.

In the Define data product dialog, enter a name, summary, and description for your data product:

• Name: A descriptive name for your data product.
• Summary: An informative and condensed summary of your data product.
• Description: A more detailed description of your data product. The description text field lets you provide pertinent information about the data product, such as intended use. Markdown is supported in this field. Click Preview description to view your description rendered with Markdown styling.

In the Supporting information section, click + Add link to add web links that are relevant to the data product, and use the Contacts menu to select users as contacts.

Click Save and continue to navigate to the Dataset pane.

The Dataset pane lets you make edits to the SQL query from which you are creating the data product. The CREATE clause is automatically added at time of dataset creation.

Click Preview dataset to view a sample of the dataset, up to 10 rows. You must preview and run the dataset if changes are made to the SQL query.

To finish creating the data product, choose the Dataset type, either Table, View, or Materialized View, enter a name in the Dataset name field, and click Add to data product.

If selecting Materialized View as the dataset type, use the Select storage schema menu to specify the storage table location for the materialized view. Use a different schema than the data product schema.

Edit a data product #

To edit an existing data product:

1. Click the options menu in the data products pane or the details pane.
2. Select Edit data product.
3. Edit elements of your data product such as name, summary, description, and supporting information.
4. Click Save.

Delete a data product #

There are a number of ways to delete a data product:

From the catalog explorer:

1. Locate the underlying schema in the catalog explorer.

2. Click Delete data product:

   

3. Click Yes, delete in the confirmation dialog.

From the data products pane:

1. Click the options menu.
2. Select Delete data product.
3. Click Yes, delete in the confirmation dialog.

From the data product details pane:

1. Click the options menu.
2. Select Delete data product.
3. Click Yes, delete in the confirmation dialog.

Deleting a data product cannot be undone. Deleting the data product does not affect the underlying schema.