Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 5.72 KB

README.md

File metadata and controls

94 lines (68 loc) · 5.72 KB
Raw

About the Library

wxDatabase is built on the excellent work of Joseph Blough called DatabaseLayer. You can read its story on history file.

The wxDatabase classes provide a database independent interface similar to JDBC (but only VERY basic functionality). So far, the only database backends supported are SQLite3, MySQL, PostGreSQL, ODBC, and TDS. Other Backends may be supported but they are not tested. We welcome you to help us testing them.

Of course the no brainer part: Have a database server running ;)

Although the C++ interface can be common between database, it should be noted that the SQL understood by the different database backends may vary.

The main interfaces of the component are:

  • wxDatabase
  • wxPreparedStatement
  • wxDatabaseResultSet

Prerequites: wxDatabase is a library that add database support to wxWidgets. So you will need wxWidgets build. wxDatabases works with any wx29 series but you will save yourself a lot of pain by using 3.x instead as we test against that version.

BUILDING To build wxDatabase, you need to have the database development files for the database you want to connect (that is headers and library).

USING ODBC

To succesfully compile with ODBC you need header and libs for your ODBC driver installed. Here are some places to download the files necessary for ODBC

USING TDS

To succesfully compile with TDS you need header and libs for FreeTDS driver installed. wxDatabase has been tested with freetds-1.00.24. Download the files from http://www.freetds.org/ and use CMake to build them.

WINDOWS

LINUX

Since Linux have so many distros, I will use Ubuntu (on which I do my development works) as example. It should not be too hard to make your favorite distro work.

First install the ODBC Manager. The Library is tested again UnixODBC but any other manager should work fine. To install UnixODBC in Ubuntu run sudo apt-get install unixodbc-dev

Then install the driver of your choice

  • PostGreSQL sudo apt-get install odbc-postgresql
  • MySQL/MariaDB sudo apt-get install libmyodbc
  • SQLite3 sudo apt-get install libsqliteodbc
  • FreeTDS sudo apt-get install freetds

NATIVE LIBRARIES

WINDOWS

In Windows, you just need to get development libraries and headers to compile wxDatabase. Here are places you can download the development files:

  1. MYSQL
  2. PostGreSQL
  3. Free TDS
  4. MariaDB

LINUX

  • PostGreSQL sudo apt-get install postgresql-server-dev-9.4
  • MySQL/MariaDB sudo apt-get install libmysqlclient-dev (check MySQL and MariaDB articles on how to setup repositories)
  • SQLite3 sudo apt-get install libsqlite3-dev
  • FreeTDS sudo apt-get install freetds-dev

A NOTE ON SQLite3

SQLite3 comes with wxDatabase distribution. This is the recommended way of bundling the library. However you can use installed SQLite3 library and it should work just fine. However its currently untested and would like to hear from those using the alternative.

BUILDING

  1. Install your compiler tool-set (Library is tested against GCC/MinGW. So reports on other compilers are welcome). Make sure your tool-set bin paths are added to system path.
  2. Install CMake and make sure its added to system path
  3. Change CMakeList.txt to enable/disable libraries as you want
  4. Compile wxWidgets and add the WXWIN environment variable pointing to root folder of wxWidgets to your System environment variables
  5. CD to wxDatabase/build on your terminal/CMD window
  6. Run CMake command to generate your Makefiles (e.g.cmake Verbose=1 -G "MinGW Makefiles" ..).
  7. Run compiler (e.g. mingw32-make). If the build finishes successfully the library and samples should be in build directory
  8. Run (Optional) install command (e.g. mingw32-make install) to install the headers and library to prefix.

EXAMPLES

See the samples folder for demonstration on how to use wxDatabase library.

Building Documentation

wxDatabase documentation is built with Doxygen. Download the latest version and follow the procedure in the next paragraph to build API documentation. You can view documentation on line at mtangoo.github.io.

To build documentation, change your directory to docs subdirectory. Then Issue doxygen DoxyFile command fro terminal/CMD. if successful, it will generate the "html" subdirectory that contains html files for documentation.

The wxDatabase Team

wxDatabase is community driven and have a number of contributors. The following list includes only collaborators. Once we have a list of contributors, we will have special file for acknowledging them.

  • Stefano Mtangoo (@mtangoo)
  • Andrew (@manyleaves)
  • Patrick Geltinger (@patlkli)

wxDatabase LICENCE

wxDatabase Library is released under wxWidgets License. If you are using native libraries be sure to check their respective licenses before using them. Please use issue tracker for bug report, or feature requests. Before you ask, please search the issues and the internet as someone might have asked.

IMPORTANT NOTICE

Please use issue tracker for bugs and feature requests. Questions can be asked at the forum