132 releases (10 stable)
|new 4.0.1||Nov 29, 2023|
|3.0.1||Nov 5, 2023|
|2.2.0||Oct 8, 2023|
|1.0.2||Sep 25, 2023|
|0.10.3||Nov 21, 2020|
#32 in Database interfaces
33,840 downloads per month
Used in 12 crates (10 directly)
Rust ODBC bindings. ODBC (Open Database Connectivity) is an open standard to connect to a variaty of data sources. Most data sources offer ODBC drivers. There are two typical usage scenarios for ODBC:
- Your appliciation is designed to work with a wide range of Databases without the need of redeploying it.
- There is no native Rust driver in suitable quality available for your Database so you want to use the ODBC driver instead.
See also: Is ODBC the Answer?
This crate is currently tested against:
- Microsoft SQL Server
Current ODBC Version is
This crate is build on top of the
odbc-sys ffi bindings, which provide definitions of the ODBC C Interface, but do not build any kind of abstraction on top of it.
Check the guide for code examples and a tour of the features.
To build this library you need to link against the
odbc library of your systems ODBC driver manager. It should be automatically detected by the build. On Windows systems it is preinstalled. On Linux and OS-X unix-odbc must be installed. To create a Connections to a data source, its ODBC driver must also be installed.
Nothing to do. ODBC driver manager is preinstalled.
sudo apt-get install unixodbc-dev
You can use homebrew to install UnixODBC
brew install unixodbc
OS-X (ARM / MAC M1)
cargo build is not going to pick up
libodbc.so installed via homebrew due to the fact that homebrew on ARM Mac installs into
/opt/homebrew/Cellar as opposed to
You find documentation on what directories are searched during build here: https://doc.rust-lang.org/cargo/reference/environment-variables.html#dynamic-library-paths.
You can also install unixODBC from source:
- copy the unixODBC-2.3.9.tar.gz file somewhere you can create files and directories
- gunzip unixODBC*.tar.gz
- tar xvf unixODBC*.tar
Linux / OS-X via Nix Flakes
Alternatively, if you're familiar with the Nix ecosystem or want to try it out, our wiki has a user contributed example on setting up a dev environment with Nix flakes.
- Connect using Data Source names (DSN)
- Connect using ODBC connection strings
- Connect using prompts (windows)
- Log ODBC diagnostics and warnings (via
- Columnar bulk inserts.
- Columnar bulk queries.
- Rowise bulk inserts.
- Rowise bulk queries.
- Output parameters of stored procedures.
- prepared and 'one shot' queries.
- Pass parameters to queries
- Asynchronous execution of one shot queries
- Asynchronous execution of prepared queries
- Asynchronous connecting to database
- Asynchronous fetching of Metainformation
- Inserting large binary / text data in stream
- Fetching arbitrary large text / binary data in stream
- Connection pooling
- List tables of data sources
- Retrieve multiple result sets