Register data source
The first step in using Data Notebook is to register a data source, which means creating a link between your Edge data source and Data Notebook. Data Notebook reuses Edge connections.
When registering a data source, you are prompted to choose how you want users to connect to the data source when they run queries, and where you want the query results for the data source to be stored. After you register a data source, you can't edit it.
The information in this documentation varies depending on the data source you select below.
Data source
Note This data source is not supported for Collibra Cloud sites.
Prerequisites
- You have a global role with the following global permissions:
- Product Rights > Data Notebook
- Data Notebook > Manage data sources
- If you want the query results to be stored in your organization's database, set up a database.
- To know the supported drivers for the data source, go to Data sources.
Steps
Amazon Athena (in preview)
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
BigQuery
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
Option Description Service account Users don't need to enter any credentials to connect to the data source, before running queries. Data Notebook will use the service account from the Edge data source connection.
Google OAuth Users are redirected to Google for authentication, before running queries. They inherit permissions from the projects.
Note This option requires you to create a Google OAuth application and obtain the client ID and client secret for such an application. To create this application, you need specific permissions on your Google Cloud console or need help from someone with those permissions. For more information, go to Google documentation. - Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Databricks
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
Option Description Service account Users don't need to enter any credentials to connect to the data source, before running queries. Data Notebook will use the service account from the Edge data source connection.
Personal access token Users need to enter their personal access token that is generated on the Databricks platform, before running queries. For more information, go to Databricks personal access token authentication.
When you select this option, the Credentials expiration field appears. By default, personal access token expires after 1 month. You can, however, change the duration.
Microsoft Entra ID OAuth Users are redirected to Microsoft Entra for authentication, before running queries. For more information, go to Register an application with the Microsoft identity platform.
Note This option requires you to create a new Microsoft Entra ID application from the Azure portal and obtain the directory (tenant) ID, application client ID, and application client secret for the setup. - Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Microsoft SQL Server
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Oracle
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
PostgreSQL
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Redshift
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Snowflake
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
Option Description Service account Users don't need to enter any credentials to connect to the data source, before running queries. Data Notebook will use the service account from the Edge data source connection.
Personal credentials Users need to enter their own credentials, before running queries. They inherit permissions from the data source.
When you select this option, the Credentials expiration field appears. By default, personal credentials expire after 1 month, but you can change the duration.
Snowflake OAuth Users are redirected to Snowflake for authentication, before running queries. They inherit permissions from the data source.
Note This option requires you to have the ACCOUNTADMIN role or a role with the CREATE INTEGRATION privilege in Snowflake to create and manage integrations for OAuth. You need to create an OAuth security integration and obtain the client ID and client secret for the setup.Microsoft Entra ID OAuth Users are redirected to Microsoft Entra for authentication, before running queries. For more information, go to Register an application with the Microsoft identity platform.
Note This option requires you to create a new OAuth server application from the Azure portal and obtain the Azure tenant ID and OAuth application ID URI. You also need to create a new OAuth client application from the Azure portal and obtain the OAuth client ID and OAuth client secret for the setup. - Click Continue.
The Set up Snowflake OAuth dialog box appears. - Follow the instructions, click Continue, and then enter the OAuth Client ID and OAuth Client Secret.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Teradata
- On the Data Notebook landing page, click Settings.Tip Alternatively, on the main toolbar, click
→ Settings, and then, in the Data Notebook section, click Data sources.
The Data Sources page opens.
- Click Register data source.
The Register a Data Source dialog box appears. - Enter the required information.
Field Description Edge site Contains a list of healthy Edge or Collibra Cloud sites. Data source connection Contains a list of supported connections associated with the Edge or Collibra Cloud site you selected.
- Click Continue.
The Choose the Authentication Method dialog box appears. - Select one of the following authentication options.
- Click Continue.
The Link your data source to the Collibra Catalog dialog box appears. - Select one of the following options to link your data source to a System asset in Data Catalog.
Option Description Use Edge connection name Allows Collibra to use the name of the Edge connection to link to a related System asset of the same name in Data Catalog.
Specify a system in Catalog Allows you to select an existing System asset that represents your data source in Data Catalog. Use this option if the name of the Edge connection doesn't match the name of the System asset in Data Catalog.
- Click Continue.
The Choose your data storage option dialog box appears. - Select one of the following storage options.
Option Description Store in Collibra Cloud Stores the query results in Collibra Platform. Store in your own database Stores the query results in your organization's database. For more information, go to Set up database for storing query results. Do not store results Does not store the query results. The results are shown in the user's web browser until their browser is refreshed. They need to run the query each time they want to view the results. Even the asset created when publishing the notebook does not show the query results.
- Click Continue.
A message stating that the data source is registered appears.
- The registration fails if the credentials provided in the Edge data source connection are incorrect or if the data source is unavailable. If it fails multiple times, contact Collibra Support.
- To remove the link between your Edge data source and Data Notebook, click
next to the data source, and then select Remove data source. Users will then no longer be able to run queries against the data source.
Create a notebook.