Fair usage policy
As part of our commitment to provide a high-quality, fast and reliable service, we have a fair usage policy (the Fair Usage Policy) for certain of our Software-as-a-Service offerings, including the Data Adapter.
By using our services, you agree to be bound by this Fair Usage Policy.
Root's Data Adapter provides comprehensive access to all of your organisation's data on the Root platform. We provide SQL access to all entities that can be retrieved over the API. This allows your engineering, Business Intelligence (BI) and Machine Learning (ML) teams to connect their favourite data processing and analytic tools to Root. Build your own dashboards, answer operational queries, automate reporting (eg. sales, financial, regulatory), and more.
The Data Adapter works on snapshots that are created daily at midnight UTC. This means that any updates that occurred after the last snapshot will only reflect in the next snapshot.
Each day at midnight UTC, Root generates a snapshot of your organisation's data. Production data is made available via AWS Athena.
Your engineering team can access AWS Athena via the AWS SDK or CLI tools. You can also execute SQL queries directly by configuring JDBC or ODBC connections.
To fetch the credentials that will allow you to start using the Data Adapter, you need to have the right permissions enabled for your role. Your Root Admin needs to:
- Go to your "Organisation settings" (the building logo at the bottom of the blue menu bar on the left)
- In the grey menu, select "Roles" and click on the role that you would like to edit
- Click "Edit role"
- Select the "Data adapter" checkbox
- Click "Update"
To get your credentials, log into the Root Dashboard and navigate to the " Data Management > Data Adapter".
On this page you will find the information you need to connect to Data Adapter:
- AWS S3 location
- AWS region
- Athena schema
- Athena workgroup
- AWS credentials
- AWS access key ID (username)
- AWS secret access key (password)
If your organisation has an existing key for the current environment, you will be able to view the access key ID, but not the secret access key. The secret access key is only displayed once when generating a new access key pair, and is not stored on the Root platform.
To generate a new access key pair, you can click the "Generate new" button. Make sure you copy the secret access key somewhere safe before closing the modal.
Note: Each organisation is limited to one access key pair per environment. Creating a new access key pair will delete the existing pair for that environment.
Keep your credentials safe
Please keep your credentials safe and only share them with trusted users. If you think your credentials have been compromised, please create a new access key pair and get in touch with the Root support team as soon as possible.
After retrieving your credentials, the next step is to configure your preferred data tool(s) to connect to AWS Athena. Some tools will have built-in support for connecting directly to AWS Athena, while others require installing plugins or configuring JDBC or ODBC drivers.
Configuring JDBC or ODBC drivers
Some tools or services require installing and configuring ODBC or JDBC drivers. You may need assistance from your internal IT department to connect your specific tool, for example configuring a Microsoft SQL Server connector. Please consult the AWS documentation for the latest drivers, and for further guidance.
You can find suggested solutions for common issues the the last section of this guide.
We suggest completing the DBeaver tutorial to familiarise yourself with the setup process and the Root data structures.
Here are setup guides for some popular tools:
|ODBC driver required (and DSN)||Certain tools (like the Amazon Athena Power BI connector) require the ODBC driver to be installed and configured (to create a DSN). You can follow the official AWS guide for ODBC driver installation and configuration. Alternatively, you can follow this video tutorial for installing and configuring the driver on Windows.|
|JDBC driver required||Certain tools require the JDBC driver to connect to AWS Athena. Please refer to your tool's guides. The latest driver can be downloaded from Amazon directly.|
|AWS Athena server address||If your tool requires a server address, you will need to look up the correct Service endpoint, for the |
Typically, it would be the following:
|AWS Athena workgroup||The |
Updated 20 days ago