The ODBC driver for the Amazon DocumentDB managed document database provides an SQL-relational interface for developers and BI tool users.
This project is licensed under the Apache-2.0 License.
ODBC is wrapping the Amazon DocumentDB JDBC Driver with JNI. This will add a translation layer between C++ objects and Java objects. This is a 2-tier approach, where document scanning, metadata discovery, and SQL to MQL translation is performed using Java/JVM on a local machine. The communication from ODBC Adapter to JVM will be using JNI. For performance reasons, a separate (C/C++) client driver connection will be used to query and return results from the DocumentDB database.
graph LR
A(BI Tool) --> B(ODBC Driver Adapter)
subgraph Driver [ODBC Driver]
B --> C(JAVA Adapter)
B --> D(Native Adapter)
end
C --> E[(DocumentDB Server)]
D --> E
- Setup
- Development Envrionment
- Managing Schema
- SQL Compatibility
- Support
Follow the requirements and setup directions to get your environment ready to use the Amazon DocumentDB ODBC driver. Assuming your Amazon DocumentDB cluster is hosted in a private VPC, you'll want to create an SSH tunnel to bridge to your cluster in the VPC. If you're a Tableau or other BI user, follow the directions on how to setup and use BI tools with the driver.
To set up and use the DocumentDB ODBC driver, see Amazon DocumentDB ODBC Driver Setup.
DRIVER={Amazon DocumentDB};[HOSTNAME=<host>:<port>];[DATABASE=<database>];[USER=<user>];[PASSWORD=<password>][;<option>=<value>[;<option>=<value>[...]]];
For more information about connecting to an Amazon DocumentDB database using this ODBC driver, see the dsn configuration for more details.
The Amazon DocumentDB ODBC driver can perform automatic schema discovery and generate an SQL to DocumentDB schema mapping. See the schema discovery documentation for more details of this process.
The SQL to DocumentDB schema mapping can be managed using JDBC command line in the following ways:
- generated
- removed
- listed
- exported
- imported
See the schema management documentation and table schemas JSON format for further information.
Note: A common schema management task is to regenerate or clear the existing schema that has become out of date when your database has changed, for example, when there are new collections or new fields in an existing collection. To regenerate or clear the existing schema, please refer to the Schema Out of Date topic in the troubleshooting guide.
The Amazon DocumentDB ODBC driver has a number of important limitations. See the SQL limitations documentation, Unicode support, and ODBC Support and Limitations.
If you're having an issue using the Amazon DocumentDB ODBC driver, consult the Troubleshooting Guide to see if it has a solution for your issue.