A small C++ wrapper for the native C ODBC API. Please see the online documentation for user information, example usage, propaganda, and detailed source level documentation.

Version	Description
`release`	Most recent published version that's deemed "stable". Review the changelog notes to see if this version is right for you.
`latest`	Latest published version; please use this version if CI tests are all passing. See all available versions.
`master`	Contains the latest development code, not yet ready for a published version.
`v2.x.x`	Targets C++14+. All future development will build upon this version.
`v1.x.x`	Supports C++03 and optionally C++11. There is no longer any support for this version.

Building

Nanodbc is intentionally small enough that you can drag and drop the header and implementation files into your project and run with it. For those that want it, I have also provided CMake files which build a library object, or build and run the included unit tests. The CMake files will also support out of source builds.

Unit tests use the Catch test framework, and CMake will automatically fetch the latest version of Catch for you at build time. To build the tests you will also need to have either unixODBC or iODBC installed and discoverable by CMake. This is easy on OS X where you can use Homebrew to install unixODBC with brew install unixodbc, or use the system provided iODBC if you have OS X 10.9 or earlier.

The unit tests attempt to connect to a SQLite database, so you will have to have that and a SQLite ODBC driver installed. At the time of this writing, there happens to be a nice SQLite ODBC driver available from Christian Werner's website, also available via Homebrew as sqliteobdc! The tests expect to find a data source named sqlite on *nix systems and SQLite3 ODBC Driver on Windows systems. For example, your odbcinst.ini file on OS X must have a section like the following.

[sqlite]
Description             = SQLite3 ODBC Driver
Setup                   = /usr/lib/libsqlite3odbc-0.93.dylib
Driver                  = /usr/lib/libsqlite3odbc-0.93.dylib
Threading               = 2

Example Build Process

It's most convenient to create a build directory for an out of source build, but this isn't required. After you've used cmake to generate your Makefiles, make nanodbc will build your shared object. make check will build and run the unit tests. You can also install nanodbc to your system using make install.

If the unit tests fail, please don't hesitate to report it by creating an issue with your detailed test log (prepend your make command with env CTEST_OUTPUT_ON_FAILURE=1 to enable verbose output please).

cd path/to/nanodbc/repository
mkdir build
cd build
cmake [Build Options] ..
make # creates shared library
make nanodbc # creates shared library
make tests # builds the unit tests
make test # runs the unit tests
make check # builds and then runs unit tests
make examples # builds all the example programs
make install # installs nanodbc.h and shared library

Build Options

The following build options are available via CMake. If you are not using CMake to build nanodbc, you will need to set the corresponding -D compile define flags yourself. You will need to configure your build to use boost if you want to use the NANODBC_USE_BOOST_CONVERT option.

CMake Option	Possible Values	Default	Details
`-D NANODBC_USE_UNICODE=...`	`OFF` or `ON`	`OFF`	Enables full unicode support. `nanodbc::string` becomes `std::u16string` or `std::u32string`.
`-D NANODBC_HANDLE_NODATA_BUG=...`	`OFF` or `ON`	`OFF`	Provided to resolve issue #33, details in this commit.
`-D NANODBC_USE_BOOST_CONVERT=...`	`OFF` or `ON`	`OFF`	Provided as workaround to issue #44.
`-D NANODBC_STATIC=...`	`OFF` or `ON`	`OFF`	Enables building a static library, otherwise the build process produces a shared library.
`-D NANODBC_INSTALL=...`	`OFF` or `ON`	`ON`	Enables install target.
`-D NANODBC_EXAMPLES=...`	`OFF` or `ON`	`ON`	Enables building of examples.
`-D NANODBC_TEST=...`	`OFF` or `ON`	`ON`	Enables tests target (alias `check`).
`-D NANODBC_ENABLE_LIBCXX=...`	`OFF` or `ON`	`ON`	Enables usage of libc++ if found on the system.
`-D NANODBC_ODBC_VERSION=...`	`SQL_OV_ODBC3[...]`	See Details	[Optional] Sets the ODBC version macro for nanodbc to use. Default is `SQL_OV_ODBC3_80` if available, otherwise `SQL_OV_ODBC3`.

Note About iODBC

Under Windows sizeof(wchar_t) == sizeof(SQLWCHAR) == 2, yet on Unix systems sizeof(wchar_t) == 4. On unixODBC, sizeof(SQLWCHAR) == 2 while on iODBC, sizeof(SQLWCHAR) == sizeof(wchar_t) == 4. This leads to incompatible ABIs between applications and drivers. If building against iODBC and the build option NANODBC_USE_UNICODE is ON, then nanodbc::string_type will be std::u32string. In ALL other cases it will be std::u16string.

Continuous integration tests run on Travis-CI. The build platform does not make available a Unicode-enabled iODBC driver. As such there is no guarantee that tests will pass in entirety on a system using iODBC. My recommendation is to use unixODBC. If you must use iODBC, consider disabling unicode mode to avoid wchar_t issues.

Contributing

Publish and Release Process

Once your local master branch is ready for publishing (i.e. semantic versioning), use the scripts/publish.sh script. This script bumps the major, minor, or patch version, then updates the repository's VERSION file, adds a "Preparing" commit, and creates git tags appropriately. For example to make a minor update you would run ./scripts/publish.sh minor.

Important: Always update CHANGELOG.md with information about new changes, bug fixes, and features when making a new release. Use the ./scripts/changes.sh script to aid in your composition of this document. The publish script itself will attempt to verify that the changelog file has been properly updated.

To do this manually instead, use the following steps — for example a minor update from 2.9.x to 2.10.0:

echo "2.10.0" > VERSION
git add VERSION
git commit -m "Preparing 2.10.0 release."
git tag -f "v2.10.0"
git push -f origin "v2.10.0"
git push -f origin master:latest

Release Process

Release nanodbc with the scripts/release.sh script. All this script does is push out the master branch to the release branch, indicating that a new "stable" published version of nanodbc exists. To do so manually, execute git push -f origin master:release. Caution: Do this for versions deemed "stable" based on suitable criteria.

Source Level Documentation

Source level documentation provided via GitHub's gh-pages is available at nanodbc.lexicalunit.com. To re-build and update it, preform the following steps from the root directory of the repository:

git clone -b gh-pages [email protected]:lexicalunit/nanodbc.git doc Necessary the first time, not subsequently.
cd doc
make Generates updated documentation locally.
make commit Adds and commits any updated documentation.
git push origin gh-pages Deploys the changes to github.

Building documentation and gh-pages requires the use of Doxygen and jekyll. See the Makefile on the gh-pages branch for more details.

Quick Setup for Testing or Development Environments

To get up and running with nanodbc as fast as possible consider using the provided Dockerfile or Vagrantfile. For example, to spin up a docker container suitable for testing and development of nanodbc:

$ cd /path/to/nanodbc
$ docker build -t nanodbc .
$ docker run -v "$(pwd)":"/opt/$(basename $(pwd))" -it nanodbc /bin/bash
root@hash:/# mkdir -p /opt/nanodbc/build && cd /opt/nanodbc/build
root@hash:/opt/nanodbc/build# cmake ..
root@hash:/opt/nanodbc/build# make nanodbc

Or, to build and ssh into a vagrant VM (using VirtualBox for example) use:

$ cd /path/to/nanodbc
$ vagrant up
$ vagrant ssh
vagrant@vagrant-ubuntu-precise-64:~$ git clone https://github.com/lexicalunit/nanodbc.git
vagrant@vagrant-ubuntu-precise-64:~$ mkdir -p nanodbc/build && cd nanodbc/build
vagrant@vagrant-ubuntu-precise-64:~$ CXX=g++-5 cmake ..
vagrant@vagrant-ubuntu-precise-64:~$ make nanodbc

Future work

Good to Have / Want Someday

Refactor unit tests to follow BDD pattern.
Update codebase to use more C++14 idioms and patterns.
Write more tests with the goal to have much higher code coverage.
More tests for a large variety of drivers. Include performance tests.
Clean up bind_* family of functions, reduce any duplication.
Improve documentation: The main website and API docs should be more responsive.
Provide more examples in documentation, more details, and point out any gotchas.
Refactor code to remove the need for the NANODBC_HANDLE_NODATA_BUG option.
Versioned generated source level API documentation for release and latest. For each major and minor published versions too?
Windows CI tests; use Appveyor? Alternatives?
Add "HOWTO Build" documentation for Windows, OS X, and Linux.

README.md 11 KB Permalink History Raw