How to crawl Hive

Once you have configured the Hive permissions, you can establish a connection between Atlan and Hive. (If you are also using a private network for Hive, you will need to set that up first, too.)

To crawl metadata from Hive, review the order of operations and then complete the following steps.

Select the source

To select Hive as your source:

  1. In the top right of any screen in Atlan, navigate to +New and click New Workflow.
  2. From the Marketplace page, click Hive Assets.
  3. In the right panel, click Setup Workflow.

Provide your credentials

Choose your extraction method:

Direct extraction method

To enter your Hive credentials:

  1. For Host Name, enter the host name (or PrivateLink endpoint) for your Hive instance.
  2. For Port, enter the port number for your Hive instance.
  3. For Username, enter the username you created for that instance.
  4. For Password, enter the password for the username.
  5. For Default Schema, enter the default schema name for your Hive instance.
  6. Click the Test Authentication button to confirm connectivity to Hive.
  7. Once authentication is successful, navigate to the bottom of the screen and click Next.

Offline extraction method

Atlan also supports the offline extraction method for fetching metadata from Hive. This method uses Atlan's metadata-extractor tool to fetch metadata. You will need to first extract the metadata yourself and then make it available in S3.

To enter your bucket details:

  1. For Bucket name, enter the name of your S3 bucket. If you are reusing Atlan's bucket, you can leave this blank.
  2. For Bucket prefix, enter the S3 prefix under which all the metadata files exist. These include databases.json, columns-<database>.json, and so on.
  3. For Bucket region, enter the name of the S3 region.
  4. When complete, at the bottom of the screen click Next.

Configure the connection

To complete the Hive connection configuration:

  1. Provide a Connection Name that represents your source environment. For example, you might use values like production,development,gold, or analytics.
  2. (Optional) To change the users who are able to manage this connection, change the users or groups listed under Connection Admins.
    🚨 Careful! If you do not specify any user or group, no one will be able to manage the connection β€” not even admins.
  3. Navigate to the bottom of the screen and click Next to proceed.

Configure the crawler

Before running the Hive crawler, you can further configure it.

On the Metadata page, you can override the defaults for any of these options:

  • To select the Hive assets you want to exclude from crawling, click Exclude Metadata. (This will default to no assets if none are specified.)
  • To select the Hive assets you want to include in crawling, click Include Metadata. (This will default to all assets, if none are specified.)
πŸ’ͺ Did you know? If an asset appears in both the include and exclude filters, the exclude filter takes precedence.

Run the crawler

To run the Hive crawler, after completing the steps above:

  1. To check for any permissions or other configuration issues before running the crawler, click Preflight checks.
  2. You can either:
    • To run the crawler once immediately, at the bottom of the screen, click the Run button.
    • To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the Schedule Run button.

Once the crawler has completed running, you will see the assets on Atlan's asset page! πŸŽ‰

πŸ’ͺ Did you know? Once you have crawled assets from Hive, you can run the Hive Miner to mine query history through S3.

Related articles

Was this article helpful?
0 out of 0 found this helpful