2008-12-15 21:45:15 +01:00
|
|
|
= SQLite3/Ruby Interface
|
|
|
|
|
|
2010-06-11 05:42:33 +02:00
|
|
|
* http://github.com/luislavena/sqlite3-ruby
|
|
|
|
|
* http://rubyforge.org/projects/sqlite-ruby
|
|
|
|
|
* http://sqlite-ruby.rubyforge.org
|
2010-07-21 03:36:17 +02:00
|
|
|
* http://groups.google.com/group/sqlite3-ruby
|
2010-06-11 05:42:33 +02:00
|
|
|
|
|
|
|
|
== DESCRIPTION
|
|
|
|
|
|
2008-12-15 21:45:15 +01:00
|
|
|
This module allows Ruby programs to interface with the SQLite3
|
|
|
|
|
database engine (http://www.sqlite.org). You must have the
|
|
|
|
|
SQLite engine installed in order to build this module.
|
|
|
|
|
|
|
|
|
|
Note that this module is NOT compatible with SQLite 2.x.
|
|
|
|
|
|
|
|
|
|
== Compilation and Installation
|
|
|
|
|
|
2010-06-11 05:42:33 +02:00
|
|
|
Install SQLite3, enabling option SQLITE_ENABLE_COLUMN_METADATA (see
|
|
|
|
|
www.sqlite.org/compile.html for details).
|
|
|
|
|
|
|
|
|
|
Then do the following:
|
2008-12-15 21:45:15 +01:00
|
|
|
|
|
|
|
|
ruby setup.rb config
|
|
|
|
|
ruby setup.rb setup
|
|
|
|
|
ruby setup.rb install
|
|
|
|
|
|
|
|
|
|
Alternatively, you can download and install the RubyGem package for
|
|
|
|
|
SQLite3/Ruby (you must have RubyGems and SQLite3 installed, first):
|
|
|
|
|
|
|
|
|
|
gem install sqlite3-ruby
|
|
|
|
|
|
|
|
|
|
If you have sqlite3 installed in a non-standard location, you can specify the location of the include and lib files by doing:
|
|
|
|
|
|
|
|
|
|
gem install sqlite3-ruby -- --with-sqlite3-include=/opt/local/include \
|
|
|
|
|
--with-sqlite3-lib=/opt/local/lib
|
|
|
|
|
|
2010-07-21 03:36:17 +02:00
|
|
|
= SUPPORT!!!
|
|
|
|
|
|
|
|
|
|
== OMG! Something has gone wrong! Where do I get help?
|
|
|
|
|
|
|
|
|
|
The best place to get help is from the
|
|
|
|
|
{sqlite3-ruby mailing list}[http://groups.google.com/group/sqlite3-ruby] which
|
|
|
|
|
can be found here:
|
|
|
|
|
|
|
|
|
|
* http://groups.google.com/group/sqlite3-ruby
|
|
|
|
|
|
|
|
|
|
== I've found a bug! Where do I file it?
|
|
|
|
|
|
|
|
|
|
Uh oh. After contacting the mailing list, you've found that you've actually
|
|
|
|
|
discovered a bug. You can file the bug at the
|
|
|
|
|
{github issues page}[http://github.com/luislavena/sqlite3-ruby/issues]
|
|
|
|
|
which can be found here:
|
|
|
|
|
|
|
|
|
|
* http://github.com/luislavena/sqlite3-ruby/issues
|
|
|
|
|
|
2008-12-15 21:45:15 +01:00
|
|
|
== Usage
|
|
|
|
|
|
|
|
|
|
For help figuring out the SQLite3/Ruby interface, check out the
|
|
|
|
|
FAQ[http://sqlite-ruby.rubyforge.org/sqlite3/faq.html]. It includes examples of
|
|
|
|
|
usage. If you have any questions that you feel should be address in the
|
|
|
|
|
FAQ, please send them to jamis@37signals.com
|
|
|
|
|
|
|
|
|
|
== Source Code
|
|
|
|
|
|
|
|
|
|
The source repository is accessible via git:
|
|
|
|
|
|
2010-06-11 05:42:33 +02:00
|
|
|
git clone git://github.com/luislavena/sqlite3-ruby.git
|
2008-12-15 21:45:15 +01:00
|
|
|
|
|
|
|
|
== Contact Information
|
|
|
|
|
|
|
|
|
|
The project page is http://rubyforge.org/projects/sqlite-ruby. There, you can
|
|
|
|
|
find links to mailing lists and forums that you can use to discuss this
|
|
|
|
|
library. Additionally, there are trackers for submitting bugs and feature
|
|
|
|
|
requests. Feel free to use them!
|
