Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 85 lines (71 sloc) 2.325 kB
d46ac0b @myabc Added README.markdown to repo root
myabc authored
1 DataObjects README
2 ==================
3
4 DataObjects.rb is an attempt to rewrite existing Ruby database drivers to
5 conform to one, standard interface.
6
a285153 @myabc List available drivers and platform in top-level README
myabc authored
7 At present the following drivers are available:
8
9 <table>
10 <tr>
11 <th>Database Vendor</th>
12 <th>MRI (1.8.6/7) / 1.9</th>
13 <th>JRuby</th>
14 </tr>
15 <tr>
16 <td>MySQL</td>
17 <td>x</td>
18 <td>x</td></tr>
19 <tr>
20 <td>Oracle</td>
21 <td>x</td>
22 <td>x</td></tr>
23 <tr>
24 <td>PostgreSQL</td>
25 <td>x</td>
26 <td>x</td></tr>
27 <tr>
28 <td>SQLite3</td>
29 <td>x</td>
30 <td>x</td></tr>
31 <tr>
32 <td>Derby</td>
33 <td>-</td>
34 <td>x</td></tr>
35 <tr>
36 <td>H2</td>
37 <td>-</td>
38 <td>x</td></tr>
39 <tr>
40 <td>HSQLDB</td>
41 <td>-</td>
42 <td>x</td></tr>
43 <tr>
44 <td>SQL Server</td>
45 <td><em>pending</em></td>
46 <td><em>pending</em></td></tr>
47 </table>
48
49 There is experimental support for [Rubinius][rubinius].
50
d46ac0b @myabc Added README.markdown to repo root
myabc authored
51 At present, PostgreSQL, MySQL and SQLite drivers are available. More drivers are
52 currently under development. If you feel like living on the edge, install and
53 test drivers directly from this repository.
54
55 Introduction
56 ------------
57
bd5ad8f @myabc Update README with accurate description and installation instructions
myabc authored
58 To connect to and query the database, DataObjects relies on native extensions.
a285153 @myabc List available drivers and platform in top-level README
myabc authored
59 Native extensions have been written in both C (for Ruby 1.8.6/7 (MRI), Ruby
60 1.9.x (YARV) and Rubinius platform) and Java (for the JRuby platform).
61 Individual drivers may include extensions for both Ruby MRI and JRuby, or one
62 or the other.
d46ac0b @myabc Added README.markdown to repo root
myabc authored
63
64 C extensions have been written using according to each vendor API. Java drivers
65 use the standard JDBC API. Although there are dialectical differences between
66 the Java drivers, the JDBC API ensures a reasonable amount of commonality. As
bd5ad8f @myabc Update README with accurate description and installation instructions
myabc authored
67 such, the Java extensions rely on a common do\_jdbc gem, which wraps code that
68 is common to all of the Java extensions.
d46ac0b @myabc Added README.markdown to repo root
myabc authored
69
70 Installation
71 ------------
72
73 To install a driver from the repository `cd` into the driver directory and use
74 the provided `rake install` task to install for the default platform.
75
76 Copyright and Licensing
77 -----------------------
78
a285153 @myabc List available drivers and platform in top-level README
myabc authored
79 Please see the copyright notices in each individual driver README.markdown or
80 LICENSE file. Java-based drivers bundle JDBC driver JAR files, which may be
81 provided under a license that is more restrictive than the MIT License used by the
d46ac0b @myabc Added README.markdown to repo root
myabc authored
82 data\_objects gem itself.
a285153 @myabc List available drivers and platform in top-level README
myabc authored
83
84 [rubinius]:http://rubini.us/
Something went wrong with that request. Please try again.