How to connect

First, you'll need to configure AWS to work with Internal. Then, enter the following information to connect your database to Internal:

  • Name: Give your data source a name for use within Internal.
  • Access Key ID: Enter this in for the IAM user you created for Internal.
  • Secret Access Key: Enter this in for the IAM user you created for Internal.
  • Region: Your AWS region code - see here.



To connect with Internal, your data source must be publicly accessible, with SSL encryption enabled, and configured to accept connections from Internal’s IP addresses.

What happens when you connect

When you connect DynamoDB to Internal, we'll generate the following automatically:

  1. A list, insert, update, and delete function for each table in the database (if the connecting user account has these privileges). List functions read data from your tables and allow you to display that data in components - think of these as prebuilt SQL queries, so you don't have to write queries for everything.



Functions will not be generated if no primary keys are found in the connected database.

Filtering and Sorting

Internal uses the Dynamo Query operation to perform filtering. This allows filtering on Sort Keys only, for both tables and indexes. We do not use the Dynamo Scan operation for use in filtering as each query would require an entire table scan in order to provide accurate results.

To enable filtering on specific columns, you can create a Global Secondary Index with a constant partition key and the field you want to filter on as the sort key. This groups all records into one partition on the index, allowing the sort key to be used for filtering purposes. There are no size restrictions on Partition keys for Global Secondary Indexes.

All operators are supported for the partition key. Only the "=" operator is supported for sort keys.