Register a data source for Data Notebook

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.

Important After you register a data source, you can't edit it.
Tip 

The information in this documentation varies depending on the data source you select below.

Data source

Prerequisites

  • You have a global role that has 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 for Data Notebook.

Steps

  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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.
  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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.
  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, change the duration.

  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, change the duration.

  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, change the duration.

  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, change the duration.

  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, 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.
    • You can't use the Snowflake OAuth authentication method when connecting from a virtual private cloud (VPC).
  6. Click Continue.
    The Set up Snowflake OAuth dialog box appears.
  7. Follow the instructions, click Continue, and then enter the OAuth Client ID and OAuth Client Secret.
  8. Click Continue.
    The Choose your data storage option dialog box appears.
  9. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  10. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.
  1. Open the Data Sources page.
    1. On the main toolbar, click Products icon, and then click Data Notebook.
      The Data Notebook homepage opens.
    2. In the left pane, click Settings.
      The Workspace page opens.
    3. In the left pane, click Data Sources.
      The Data Sources page opens.
  2. Click Register data source.
    The Register a Data Source dialog box appears.
  3. Enter the required information.
    FieldDescription
    Edge siteContains a list of healthy Edge sites.
    Data source connection

    Contains a list of supported connections associated with the Edge site you selected.

  4. Click Continue.
    The Choose the Authentication Method dialog box appears.
  5. Select one of the following authentication options.
    OptionDescription
    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. You can, however, change the duration.

  6. Click Continue.
    The Choose your data storage option dialog box appears.
  7. Select one of the following storage options.
    OptionDescription
    Store in Collibra CloudStores the query results in Collibra Data Intelligence Platform.
    Store in your own databaseStores the query results in your organization's database. For more information, go to Set up a 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.

  8. Click Continue.
    A message stating that the data source is registered appears.
Tip 
  • 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.
  • 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.

What's next?

Create a notebook.