File: main.html

package info (click to toggle)
simpledb 1.5-1.4
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k, lenny, squeeze
  • size: 888 kB
  • ctags: 238
  • sloc: cpp: 529; makefile: 127; perl: 23; sh: 9
file content (39 lines) | stat: -rw-r--r-- 4,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Simple&amp;nbsp;C++&amp;nbsp;ODBC&amp;nbsp;Database&amp;nbsp;API: Main Page</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.2 -->
<div class="qindex"><a class="qindexHL" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>Simple&nbsp;C++&nbsp;ODBC&nbsp;Database&nbsp;API Documentation</h1>
<p>
The API has been tested to work with both MySql and PostGreSQL on a Debian Linux platform.<p>
<dl compact><dt><b>Version:</b></dt><dd>__BEGIN_VERSION 1.5 __END_VERSION</dd></dl>
<dl compact><dt><b>Date</b></dt><dd>2006/01/05 00:31:15 </dd></dl>
<p>
<h2>Download</h2>
<p>
The API can be downloaded from our <a href="http://sourceforge.net/projects/simpledb/" target="sourceforge">sourceforge project page</a>.<p>
<h2>API Description</h2>
<p>
The <a class="el" href="namespaceSimpleDB.html">SimpleDB</a> API is a C++ API designed to encapsulate the ODBC API functionality in an object oriented manner.<p>
The API was created due to an absence of any other such API that was database independent. The database independence is achieved using the ODBC (Open DataBase Connectivity) API.<p>
The API provides a Database object that can be used to create instances of Query objects. The Query objects are used to query a database and allow columns to be bound for the query.<p>
The flowing column objects are currently available (as of Jan 2005): a boolean column, a long column and a string column. The string column makes use of the libstdc++ string class so you don't have to mess around with malloc.<p>
The Database object also has some convenience member functions that allow queries that return a single integer or string to be executed without having to create a query object or bind columns.<p>
The API has been tested to work with both MySql and PostGreSQL on a Debian Linux platform.<p>
Example usage: see simple.cpp<p>
<h2>Further Info</h2>
<p>
Have a look at the <a class="el" href="faq.html">Frequently Asked Questions</a>. For any queries or to contact the developers, please go to our <a href="http://sourceforge.net/projects/simpledb/">project page</a>.<p>
<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Make the query object inherit from stringstream so queries can be streamed into a query. <p>
Make the query.execute() thread safe to ensure that threads with the same database handle cannot execute queries simultaneously (ODBC querying is NOT thread safe).</dd></dl>
When the query is executed, it will execute it's internal string. The stream could have io stream modifiers which tell the stream to escape what comes after.(e.g instead of calling db-&gt;escapeString()) Additionally you could make the stream convert boolean values to the right ones for a given database. Almost a locale for database, could use facets on the stream.<p>
Investigate where the mutex needs to happen. Look at fetchRow() - it calls the ODBC world for its information (but this may have a unique Id which is thread safe<ul>
<li>as in the data is stored in ODBC world and other queries can be executed around it). </li></ul>
<hr>
<div align="right"><small>
Copyright (C) 2005 <a target="top" href="http://www.eminence.com.au">Eminence Technology Pty Ltd</a>.<br>
Documentation pages generated by doxygen.</small><br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=129109&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
</div>