https://github.com/mongodb/mongo-odbc-driver
https://github.com/mongodb/mongo-odbc-driver
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mongodb/mongo-odbc-driver
- Owner: mongodb
- License: apache-2.0
- Created: 2021-11-02T21:01:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T19:44:42.000Z (4 months ago)
- Last Synced: 2025-01-29T09:38:10.099Z (3 months ago)
- Language: Rust
- Size: 20.3 MB
- Stars: 23
- Watchers: 11
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MongoDB ODBC Driver
A 64-bit unicode ODBC driver for connecting to Atlas Data Federation using the MongoSQL dialect.
If you're looking for an ODBC driver to use with the [MongoDB
Connector for BI](https://docs.mongodb.com/bi-connector/current/),
please see the
[mongodb/mongo-bi-connector-odbc-driver](https://github.com/mongodb/mongo-bi-connector-odbc-driver)
repository.
## Verify Integrity of MongoDB ODBC Driver Packages
You can download the [MongoDB ODBC Driver](https://www.mongodb.com/try/download/odbc-driver) from MongoDB Download Center.
1. Select the platform and version you want to verify on that page.
2. Click `Copy link` and use the URL while following the instructions to validate MongoDB packages described [here](https://www.mongodb.com/docs/manual/tutorial/verify-mongodb-packages/).
> :warning:
> For this [step](!https://www.mongodb.com/docs/manual/tutorial/verify-mongodb-packages/#download-then-import-the-key-file), download and import the MongoDB ODBC Driver public key using this url : `https://pgp.mongodb.com/atlas-sql-odbc.asc`
## Manually set up the ODBC driver on Windows for local development
Note: users can utilize the built-in driver manager.
1. Update the values of `Driver`, `Pwd`, `Server`, `User`, and `Database` in `setup/setupDSN.reg`. The value of `Driver` should be the absolute path of `mongoodbc.dll`. This file should be located in either the `mongo-odbc-driver/target/debug` directory or in the release directory.
2. For 32-bit architectures, modify the file path `HKEY_LOCAL_MACHINE\SOFTWARE` in `setupDSN.reg` so that it is instead `HKEY_LOCAL_MACHINE\Wow6432Node\SOFTWARE`.
3. Run `reg import "setup/setupDSN.reg"` in order to populate the registry editor with the new entries. Alternatively, simply double click on the `setupDSN.reg` file.
### Validate setup
#### 64-bit
Run `reg query "HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\ODBC Drivers"` to verify that `MongoDB Atlas SQL ODBC Driver` has been installed successfully.
There should be a new entry called `ADF_TEST` under `ODBC/ODBC.INI` with the following subentries:
database:
pwd:
server:
user:
Run `reg query "HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBCINST.INI\MongoDB Atlas SQL ODBC Driver"` to determine if the registry editor was updated successfully. There should also be a new entry called `ADF_ODBC` under `ODBC/ODBCINST.INI` with the following subentries:
Driver:
Setup:
Open the Microsoft ODBC Administrator (64-bit) and verify that "MongoDB Atlas SQL ODBC Driver" appears under "System DSN".
## Unsupported Functions
The driver is a Unicode only driver and does not support ANSI functions.
Additionally, the following ODBC functions are currently not supported by the driver.
| Function |
|----------------------|
| SQLBindParameter |
| SQLBrowseConnectW |
| SQLBulkOperations |
| SQLCancelHandle |
| SQLColumnPrivilegesW |
| SQLCompleteAsync |
| SQLConnectW |
| SQLCopyDesc |
| SQLDescribeParam |
| SQLEndTran |
| SQLGetCursorNameW |
| SQLGetDescFieldW |
| SQLGetDescRecW |
| SQLNativeSqlW |
| SQLNumParams |
| SQLParamData |
| SQLPrepareW |
| SQLProcedureColumnsW |
| SQLProceduresW |
| SQLPutData |
| SQLSetCursorNameW |
| SQLSetDescFieldW |
| SQLSetDescRec |
| SQLSetPos |
| SQLSpecialColumnsW |
| SQLStatisticsW |
| SQLTablePrivilegesW |