mirror of
https://github.com/gnustep/libs-sqlclient.git
synced 2025-02-20 18:32:06 +00:00
Update documentation for initial release.
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/sqlclient/trunk@19197 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
CaS
parent
975572c6b7
commit
9ec4b3c3d9
3 changed files with 155 additions and 16 deletions
47
README
47
README
|
|
@ -1,16 +1,43 @@
|
|||
To build this library you must have a basic GNUstep environment set up ...
|
||||
What is the SQLClient library?
|
||||
|
||||
The gnustep-make package must have been built and installed.
|
||||
The gnustep-base package must have been built and installed.
|
||||
The SQLClient library is designed to provide a simple interface to SQL databases for GNUstep applications. It does not attempt the sort of abstraction provided by the much more sophisticated GDL2 library, but rather allows applications to directly execute SQL queries and statements.
|
||||
|
||||
You must hace sourced the GNUstep.sh script (from gnustep-make) to set
|
||||
up environment variables needed for building this.
|
||||
The major features of the SQLClient library are -
|
||||
|
||||
If this environment is in place, all you should need to do is run 'make'
|
||||
to configure and build the library, 'make install' to install it.
|
||||
* Simple API for executing queries and statements... a variable length sequence of comma separated strings and other objects (NSNumber, NSDate, NSData) are concatenated into a single SQL statement and executed.
|
||||
* Support multiple sumultaneous named connections to a database server in a thread-safe manner.
|
||||
* Support multiple simultaneous connections to different database servers with backend driver bundles loaded for different database engines. Clear, simple subclassing of the abstract base class to enable easy implementation of new backend bundles.
|
||||
* Configuration for all connections held in one place and referenced by connection name for ease of configuration control. Changes via NSUserDefaults can even allow reconfiguration of client instances within a running application.
|
||||
* Thread safe operation... The base class supports locking such that a single instance can be shared between multiple threads.
|
||||
|
||||
Then you can run the test programs.
|
||||
What backend bundles are available?
|
||||
|
||||
Your most likely problems are that the configure script may not detect the
|
||||
database libraries you want ...
|
||||
Current backend bundles are -
|
||||
|
||||
* ECPG - a bundle using the embedded SQL interface for postgres.
|
||||
This is based on a similar code which has been in production use for over eighteen months, so it should be reliable.
|
||||
* Postgres - a bundle using the libpq native interface for postgres.
|
||||
This is the preferred backend as it allows 'SELECT FOR UPDATE', which the ECPG backend cannot support due to limitations in the postgres implementation of cursors. The code is however not as well tested as the ECPG interface.
|
||||
* MySQL - a bundle using the mysqlclient library for *recent* MySQL.
|
||||
I don't use MySQL... but the test program ran successfully with a vanilla install of the MySQL packages for recent Debian unstable.
|
||||
* Oracle - a bundle using embedded SQL for Oracle.
|
||||
Completely untested... may even need some work to compile... but this *is* based on code which was working about a year ago.
|
||||
No support for BLOBs yet.
|
||||
|
||||
Where can you get it? How can you install it?
|
||||
|
||||
The SQLClient library is currently only available via CVS from the GNUstep CVS repository.
|
||||
See <https://savannah.gnu.org/cvs/?group=gnustep>
|
||||
You need to check out gnustep/dev-libs/SQLClient
|
||||
|
||||
To build this library you must have a basic GNUstep environment set up...
|
||||
|
||||
* The gnustep-make package must have been built and installed.
|
||||
* The gnustep-base package must have been built and installed.
|
||||
* You must hace sourced the GNUstep.sh script (from gnustep-make) to set up environment variables needed for building this.
|
||||
* If this environment is in place, all you should need to do is run 'make' to configure and build the library, 'make install' to install it.
|
||||
* Then you can run the test programs.
|
||||
* Your most likely problems are that the configure script may not detect the database libraries you want... Please figure out how to modify configure.ac so that it will detect the required headers and libraries on your system, and supply na patch.
|
||||
|
||||
Bug reports, patches, and contributions (eg a backend bundle for a new database) should be entered on the GNUstep project page <http://savannah.gnu.org/support/?group-gnustep>
|
||||
|
||||
|
|
|
|||
46
SQLClient.h
46
SQLClient.h
|
|
@ -24,7 +24,7 @@
|
|||
<chapter>
|
||||
<heading>The SQLClient library</heading>
|
||||
<section>
|
||||
<heading>Overview</heading>
|
||||
<heading>What is the SQLClient library?</heading>
|
||||
<p>
|
||||
The SQLClient library is designed to provide a simple interface to SQL
|
||||
databases for GNUstep applications. It does not attempt the sort of
|
||||
|
|
@ -65,7 +65,7 @@
|
|||
</list>
|
||||
</section>
|
||||
<section>
|
||||
<heading>Backends</heading>
|
||||
<heading>What backend bundles are available?</heading>
|
||||
<p>
|
||||
Current backend bundles are -
|
||||
</p>
|
||||
|
|
@ -95,6 +95,48 @@
|
|||
</item>
|
||||
</list>
|
||||
</section>
|
||||
<section>
|
||||
<heading>Where can you get it? How can you install it?</heading>
|
||||
<p>
|
||||
The SQLClient library is currently only available via CVS from the
|
||||
GNUstep CVS repository.<br />
|
||||
See <https://savannah.gnu.org/cvs/?group=gnustep><br />
|
||||
You need to check out <code>gnustep/dev-libs/SQLClient</code>
|
||||
</p>
|
||||
<p>
|
||||
To build this library you must have a basic GNUstep environment set up ...
|
||||
</p>
|
||||
<list>
|
||||
<item>
|
||||
The gnustep-make package must have been built and installed.
|
||||
</item>
|
||||
<item>
|
||||
The gnustep-base package must have been built and installed.
|
||||
</item>
|
||||
<item>
|
||||
You must hace sourced the GNUstep.sh script (from gnustep-make) to set
|
||||
up environment variables needed for building this.
|
||||
</item>
|
||||
<item>
|
||||
If this environment is in place, all you should need to do is run 'make'
|
||||
to configure and build the library, 'make install' to install it.
|
||||
</item>
|
||||
<item>
|
||||
Then you can run the test programs.
|
||||
</item>
|
||||
<item>
|
||||
Your most likely problems are that the configure script may not
|
||||
detect the database libraries you want ... Please figure out how
|
||||
to modify <code>configure.ac</code> so that it will detect the
|
||||
required headers and libraries on your system, and supply na patch.
|
||||
</item>
|
||||
</list>
|
||||
<p>
|
||||
Bug reports, patches, and contributions (eg a backend bundle for a
|
||||
new database) should be entered on the GNUstep project page
|
||||
<http://savannah.gnu.org/support/?group-gnustep>
|
||||
</p>
|
||||
</section>
|
||||
</chapter>
|
||||
|
||||
$Date$ $Revision$
|
||||
|
|
|
|||
|
|
@ -24,10 +24,13 @@
|
|||
<a href="#001000000000">The SQLClient library</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#001001000000">Overview</a>
|
||||
<a href="#001001000000">What is the SQLClient library?</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#001002000000">Backends</a>
|
||||
<a href="#001002000000">What backend bundles are available?</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#001003000000">Where can you get it? How can you install it?</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#002000000000">Software documentation for the SQLClient class</a>
|
||||
|
|
@ -56,7 +59,7 @@
|
|||
|
||||
<h1><a name="001000000000">The SQLClient library</a></h1>
|
||||
|
||||
<h2><a name="001001000000">Overview</a></h2>
|
||||
<h2><a name="001001000000">What is the SQLClient library?</a></h2>
|
||||
<p>
|
||||
|
||||
The SQLClient library is designed to provide a simple
|
||||
|
|
@ -113,7 +116,9 @@ The major features of the SQLClient library are - </p>
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="001002000000">Backends</a></h2>
|
||||
<h2><a name="001002000000">
|
||||
What backend bundles are available?
|
||||
</a></h2>
|
||||
<p>
|
||||
Current backend bundles are - </p>
|
||||
<ul>
|
||||
|
|
@ -156,6 +161,71 @@ Current backend bundles are - </p>
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h2><a name="001003000000">
|
||||
Where can you get it? How can you install it?
|
||||
</a></h2>
|
||||
<p>
|
||||
|
||||
The SQLClient library is currently only available via CVS
|
||||
from the GNUstep CVS repository. <br /> See
|
||||
<https://savannah.gnu.org/cvs/?group=gnustep>
|
||||
<br /> You need to check out
|
||||
<code>gnustep/dev-libs/SQLClient</code>
|
||||
</p>
|
||||
<p>
|
||||
|
||||
To build this library you must have a basic GNUstep
|
||||
environment set up...
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
The gnustep-make package must have been built and
|
||||
installed.
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
The gnustep-base package must have been built and
|
||||
installed.
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
You must hace sourced the GNUstep.sh script (from
|
||||
gnustep-make) to set up environment variables
|
||||
needed for building this.
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
If this environment is in place, all you should need to
|
||||
do is run 'make' to configure and build the library,
|
||||
'make install' to install it.
|
||||
|
||||
</li>
|
||||
<li>
|
||||
Then you can run the test programs.
|
||||
</li>
|
||||
<li>
|
||||
|
||||
Your most likely problems are that the configure
|
||||
script may not detect the database libraries you
|
||||
want... Please figure out how to modify
|
||||
<code>configure.ac</code> so that it will detect the
|
||||
required headers and libraries on your system, and
|
||||
supply na patch.
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
|
||||
Bug reports, patches, and contributions (eg a backend
|
||||
bundle for a new database) should be entered on the
|
||||
GNUstep project page
|
||||
<http://savannah.gnu.org/support/?group-gnustep>
|
||||
</p>
|
||||
|
||||
<h1><a name="002000000000">
|
||||
Software documentation for the SQLClient class
|
||||
</a></h1>
|
||||
|
|
|
|||
Loading…
Reference in a new issue