Connect to and manage Cassandra in Microsoft Purview (Preview)

This article outlines how to register Cassandra, and how to authenticate and interact with Cassandra in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Access Policy Lineage Data Sharing
Yes Yes No Yes No No Yes No

The supported Cassandra server versions are 3.x or 4.x.

When scanning Cassandra source, Microsoft Purview supports:

  • Extracting technical metadata including:

    • Cluster
    • Keyspaces
    • Tables including the columns and indexes
    • Materialized views including the columns
  • Fetching static lineage on assets relationships among tables and materialized views.

When setting up scan, you can choose to scan an entire Cassandra instance, or scope the scan to a subset of keyspaces matching the given name(s) or name pattern(s).

Prerequisites

Note

If your data store is not publicly accessible (if your data store limits access from on-premises network, private network or specific IPs, etc.), you will need to configure a self hosted integration runtime to connect to it.

Register

This section describes how to register Cassandra in Microsoft Purview using the Microsoft Purview governance portal.

Steps to register

To register a new Cassandra server in your data catalog:

  1. Go to your Microsoft Purview account.

  2. Select Data Map on the left pane.

  3. Select Register.

  4. On the Register sources screen, select Cassandra, and then select Continue:

    Screenshot that shows the Register sources screen.

  5. On the Register sources (Cassandra) screen:

    1. Enter a Name. The data source will use this name in the catalog.
    2. In the Host box, enter the server address where the Cassandra server is running. For example, 20.190.193.10.
    3. In the Port box, enter the port used by the Cassandra server.
    4. Select a collection or create a new one (optional). Screenshot that shows the Register sources (Cassandra) screen.
    5. Select Register.

Scan

Follow the steps below to scan Cassandra to automatically identify assets. For more information about scanning in general, see our introduction to scans and ingestion

Create and run scan

To create and run a new scan:

  1. If your server is publicly accessible, skip to step two. Otherwise, you'll need to make sure your self-hosted integration runtime is configured:

    1. In the Microsoft Purview governance portal, got to the Management Center, and select Integration runtimes.
    2. Make sure a self-hosted integration runtime is available. If one isn't set up, use the steps mentioned here to set up a self-hosted integration runtime.
  2. In the Microsoft Purview governance portal, navigate to Sources.

  3. Select the registered Cassandra server.

  4. Select New scan.

  5. Provide the following details.

    1. Name: Specify a name for the scan.

    2. Connect via integration runtime: Select the Azure auto-resolved integration runtime if your server is publicly accessible, or your configured self-hosted integration runtime if it isn't publicly available.

    3. Credential: When you configure the Cassandra credentials, be sure to:

      • Select Basic Authentication as the authentication method.
      • In the User name box, provide the name of the user you're making the connection for.
      • In the key vault's secret, save the password of the Cassandra user you're making the connection for.

      For more information, see Credentials for source authentication in Microsoft Purview.

    4. Keyspaces: Specify a list of Cassandra keyspaces to import. Multiple keyspaces must be separated with semicolons. For example, keyspace1; keyspace2. When the list is empty, all available keyspaces are imported.

      You can use keyspace name patterns that use SQL LIKE expression syntax, including %.

      For example: A%; %B; %C%; D

      This expression means:

      • Starts with A or
      • Ends with B or
      • Contains C or
      • Equals D

      You can't use NOT or special characters.

    5. Use Secure Sockets Layer(SSL): Select True or False to specify whether to use Secure Sockets Layer (SSL) when connecting to the Cassandra server. By default, this option is set to False.

    6. Maximum memory available (applicable when using self-hosted integration runtime): Specify the maximum memory (in GB) available on your VM to be used for scanning processes. This value depends on the size of Cassandra server to be scanned. scan Cassandra source

  6. Select Test connection (available when using self-hosted integration runtime).

  7. Select Continue.

  8. Select a scan trigger. You can set up a schedule or run the scan once.

  9. Review your scan, and then select Save and Run.

View your scans and scan runs

To view existing scans, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan that has results you want to view.

  4. This page will show you all of the previous scan runs along with the status and metrics for each scan run. It will also display whether your scan was scheduled or manual, how many assets had classifications applied, how many total assets were discovered, the start and end time of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan you would like to manage. You can edit the scan by selecting Edit scan.

  4. You can cancel an in progress scan by selecting Cancel scan run.

  5. You can delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.
  • The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description in the schema tab of Microsoft Purview.

Lineage

After scanning your Cassandra source, you can browse data catalog or search data catalog to view the asset details.

Go to the asset -> lineage tab, you can see the asset relationship when applicable. Refer to the supported capabilities section on the supported Cassandra lineage scenarios. For more information about lineage in general, see data lineage and lineage user guide.

Cassandra lineage view

Next steps

Now that you've registered your source, follow the below guides to learn more about Microsoft Purview and your data.