Connecting to Amazon Keyspaces

This article explains how to connect Dataedo to Amazon Keyspaces database and import metadata - tables & columns.

Importing Metadata in Dataedo Portal

Entry point

To start the Metadata Import flow, make sure you have the Connection Manager role.
Then navigate to:

Connections → Add new connection → Amazon Keyspaces

This will open the import wizard described in the following steps.

Step 1. Connection details

Provide the name of Connection, the required connection details, and an optional description.

info

A Connection in Dataedo represents a saved configuration for accessing a data source.
It can be reused for future imports and scheduling.

Step 2. Credentials

Choose credentials from the list of existing ones available for the selected connector, or add new credentials.

Step 3. Data Sources

info

During one import you can read the metadata of up to 20 data sources. You can reuse the same connection to import more sources later.

• The Portal will display all databases accessible with the provided credentials.
• You can select multiple databases at once and use the search box to narrow down results.
• Each selected database should be given a Title, which will be visible in Dataedo.
• At this step, the Portal also retrieves the number of assets in each source.

Step 4. Objects to import

For each selected database, you can refine which objects to import:

• Select schemas and object types (tables, views, procedures, etc.).

Step 5. Schedule

Configure scheduling options for each source individually:

• Define tasks you want to schedule (Metadata Import).
• Run daily, on selected weekdays, or on specific days of the month.
• Choose an exact time of execution.
• Task state:
  • Active – the task will run as scheduled.
  • Draft – the task is saved but not executed until switched to Active.
• Run immediately – when checked, the task will also be executed right after clicking Create connection.

useful tip

Only one source in a metadata import can have Run immediately selected.

caution

You must configure at least one import task in the schedule section.
If you skip this, an empty database will be created and no metadata will be imported.

Importing Metadata in Dataedo Desktop

Add new connection

To connect to Amazon Keyspaces, create new documentation by clicking Add documentation and choosing Database connection.

On the Add documentation window, choose Amazon Keyspaces:

Connection details

Provide connection details:

• Host - Amazon Keyspaces Service Endpoint address for the region where Keyspaces resides, see Service endpoints for Amazon Keyspaces
• Port - Amazon Keyspaces uses port 9142.
• User - Username which will be used to authenticate and authorize to Keyspaces. It can be either a root user or IAM user.
• Password - Password for the selected user.
• Keyspace - Name of the keyspace to document. You can select it by clicking the [...] button.

How to get the host name in Amazon Keyspaces

Log into AWS Console and go to the Amazon Keyspaces resource. Then you need to find the region name where your Keyspaces resides. You can do it either by looking at the URL or by checking the name of the region in the upper right corner of your console window:

Once you have the region name, go to AWS documentation - Keyspaces Service Endpoints and find the Endpoint address in the Service endpoints table:

In our example (California-US-west-1 region), the address is cassandra.us-west-1.amazonaws.com:

Saving password

You can save the password for later connections by checking the Save password option. Passwords are saved in the repository database.

Importing schema

When the connection is successful, Dataedo will read objects and show a list of objects found. You can choose which objects to import. You can also use advanced filter to narrow down the list of objects.

Confirm the list of objects to import by clicking Next.

The next screen allows you to change the default name of the documentation under which your schema will be visible in the Dataedo repository.

Click Import to start the import.

Outcome

Your database has been imported to new documentation in the repository.