cuberite/SQLiteCpp
1
0
Fork 0
mirror of https://github.com/cuberite/SQLiteCpp.git synced 2025-08-04 17:56:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

README rework and slight update

Browse Source
This commit is contained in:
Sébastien Rombauts 2015-10-10 13:34:43 +02:00
parent 18aa9e4def
commit 7fa11f679e
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -14,19 +14,25 @@ See SQLiteC++ website http://srombauts.github.com/SQLiteCpp on GitHub.
Keywords: sqlite, sqlite3, C, library, wrapper C++ Keywords: sqlite, sqlite3, C, library, wrapper C++
## About SQLiteC++:
### About SQLite: SQLiteC++ offers an encapsulation arround the native C APIs of SQLite,
with a few intuitive and well documented C++ class.
### License:
Copyright (c) 2012-2015 Sébastien Rombauts (sebastien.rombauts@gmail.com)
Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
or copy at http://opensource.org/licenses/MIT)
### About SQLite underlying library:
SQLite is a library that implements a serverless transactional SQL database engine. SQLite is a library that implements a serverless transactional SQL database engine.
It is the most widely deployed SQL database engine in the world. It is the most widely deployed SQL database engine in the world.
The source code for SQLite is in the public domain. The source code for SQLite is in the public domain.
http://www.sqlite.org/about.html http://www.sqlite.org/about.html
### About SQLiteC++:
SQLiteC++ offers an encapsulation arround the native C APIs of sqlite,
with a few intuitive and well documented C++ class.
### The goals of SQLiteC++ are: ### The goals of SQLiteC++ are:
- to offer the best of existing simple C++ SQLite wrappers - to offer the best of existing simple C++ SQLite wrappers
@ -51,13 +57,13 @@ and then is always valid until destroyed.
### Supported platforms: ### Supported platforms:
Developements and tests are done under the following OSs: Developements and tests are done under the following OSs:
- Ubuntu 12.04 (Travis CI) and 14.04
- Debian 7 - Debian 7
- Ubuntu 12.10 - Windows XP/10
- Windows XP/7/8
And following IDEs/Compilers And following IDEs/Compilers
- GCC 4.7.2 with a provided Makefile - GCC 4.7.2 and GCC 4.8.2
- Eclipse CDT under Linux, using the provided Makefile - Eclipse CDT under Linux
- Visual Studio Express 2008/2010/2012/2013 for testing compatibility purpose - Visual Studio Express 2008/2010/2012/2013/2015 for testing compatibility purpose
### Dependencies ### Dependencies
@ -67,6 +73,7 @@ And following IDEs/Compilers
or by adding its source file in your project code base (source code provided in src/sqlite3 for Windows), or by adding its source file in your project code base (source code provided in src/sqlite3 for Windows),
with the SQLITE_ENABLE_COLUMN_METADATA macro defined (see http://www.sqlite.org/compile.html#enable_column_metadata). with the SQLITE_ENABLE_COLUMN_METADATA macro defined (see http://www.sqlite.org/compile.html#enable_column_metadata).
## Getting started
### Installation ### Installation
To use this wrappers, you need to add the 10 SQLiteC++ source files from the src/ directory To use this wrappers, you need to add the 10 SQLiteC++ source files from the src/ directory
@ -172,14 +179,7 @@ But SQLiteC++ does not support the fully thread-safe "Serialized" mode of SQLite
because of the way it shares the underling SQLite precompiled statement because of the way it shares the underling SQLite precompiled statement
in a custom shared pointer (See the inner class "Statement::Ptr"). in a custom shared pointer (See the inner class "Statement::Ptr").
### License ## Examples
Copyright (c) 2012-2015 Sébastien Rombauts (sebastien.rombauts@gmail.com)
Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt
or copy at http://opensource.org/licenses/MIT)
## Getting started
### First sample demonstrates how to query a database and get results: ### First sample demonstrates how to query a database and get results:
```C++ ```C++
@ -237,7 +237,7 @@ catch (std::exception& e)
} }
``` ```
### How to handle in assertion in SQLiteC++: ### How to handle assertion in SQLiteC++:
Exceptions shall not be used in destructors, so SQLiteC++ use SQLITECPP_ASSERT() to check for errors in destructors. Exceptions shall not be used in destructors, so SQLiteC++ use SQLITECPP_ASSERT() to check for errors in destructors.
If you don't want assert() to be called, you have to enable and define an assert handler as shown below, If you don't want assert() to be called, you have to enable and define an assert handler as shown below,
and by setting the flag SQLITECPP_ENABLE_ASSERT_HANDLER when compiling the lib. and by setting the flag SQLITECPP_ENABLE_ASSERT_HANDLER when compiling the lib.