How to crawl Amazon Redshift

Have more questions? Submit a request

Once you have configured the Amazon Redshift access permissions, you can establish a connection between Atlan and Amazon Redshift.

To crawl metadata from Amazon Redshift, complete the following steps.

Select the source

To select Amazon Redshift as your source:

  1. In the top right corner of any screen, navigate to New and then click New Workflow.
  2. From the list of packages, select Redshift Assets, and click Setup Workflow.

Provide credentials

To enter your Amazon Redshift credentials:

  1. For Host Name enter the host name of your Amazon Redshift instance. From your Redshift cluster you can find the host name in the Configuration section as a variable called Endpoint.
  2. For Port enter the port number for your Amazon Redshift instance. You can find this next to the host name in the Configuration section of your Redshift cluster.
  3. For Authentication choose the method you configured when setting up the Amazon Redshift access permissions:
    • For Basic authentication, enter the Username and Password you configured. Also enter the name of the Database to crawl.
    • For IAM User authentication, enter the AWS Access KeyAWS Secret Key, and Username you configured for the database. If you are accessing a private cluster, also enter the Cluster ID. Finally, enter the name of the Database to crawl.
    • For IAM Role authentication, enter the Username you configured for the database. To use role delegation-based authentication set the AWS Role ARN to the ARN of the role you created in your AWS account. (Leave AWS Role ARN blank to use role-based authentication.) If you are accessing a private cluster, also enter the Cluster ID. Finally, enter the name of the Database to crawl.
  4. Click Test Authentication to confirm connectivity to Amazon Redshift using these details.
  5. When successful, at the bottom of the screen click Next.

Configure the connection

To complete the Amazon Redshift connection configuration:

  1. Provide a Connection Name that represents your source environment. For example, you might want to use values like production, development, gold, or analytics.
  2. (Optional) To change the users able to manage this connection, change the users or groups listed under Connection Admins.
    🚨 Careful! If you do not specify any user or group, nobody will be able to manage the connection β€” not even admins.
  3. (Optional) To prevent users from querying any Amazon Redshift data, change Allow SQL Query to No.
  4. (Optional) To prevent users from previewing any Amazon Redshift data, change Allow Data Preview to No.
  5. At the bottom of the screen, click the Next button to proceed.

Configure the crawler

Before running the Amazon Redshift crawler, you can further configure it.

You can override the defaults for any of these options:

  • Select assets you want to include in crawling in the Include Metadata field. (This will default to all assets, if none are specified.)
  • Select assets you want to exclude from crawling in the Exclude Metadata field. (This will default to no assets, if none are specified.)
  • To have the crawler ignore temporary tables based on a naming convention, specify a regular expression in the Temporary table regex field.
  • If you have received a custom crawler configuration from Atlan Support, change Control Config to Custom and enter the value provided.
πŸ’ͺ 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 Amazon Redshift crawler, after completing the steps above:

  • 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 in Atlan's asset page! πŸŽ‰

Related articles

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