~ubuntu-branches/ubuntu/maverick/libdbi/maverick-proposed

« back to all changes in this revision

Viewing changes to doc/programmers-guide.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Goirand
  • Date: 2007-11-26 05:53:13 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071126055313-29bzt00k533rgkg8
Tags: 0.8.2-3
* New maintainer (Closes: #444424)
* Now cleaning everything correctly on the clean target
* Now managing updates of config.sub and config.guess correctly
* Removed useless postinst and postrm from debian folder as they are
  generated by dh_makeshlibs anyway
* Cleaned a bit the debian/rules for readability
* Reviewed the debian/copyright for accuracy

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 
2
 
 
3
<!ENTITY libdbi-reference SYSTEM "libdbi-reference.sgml">
 
4
<!ENTITY libdbi-quickstart SYSTEM "libdbi-quickstart.sgml">
 
5
<!ENTITY example-program SYSTEM "example-program.sgml">
 
6
<!ENTITY freedoc-license SYSTEM "include/copying-fdl.sgml">
 
7
<!ENTITY www '<ULink url="http://libdbi.sourceforge.net">http://libdbi.sourceforge.net</ULink>'>
 
8
 
 
9
]>
 
10
 
 
11
<Book id="programmers-guide">
 
12
 
 
13
  <BookInfo>
 
14
    <Title>Database Independent Abstraction Layer for C</Title>
 
15
    <SubTitle>libdbi Programmer's Guide</SubTitle>
 
16
    <Author>
 
17
      <Firstname>David</Firstname>
 
18
      <Othername>A.</Othername>
 
19
      <Surname>Parker</Surname>
 
20
      <Affiliation>
 
21
        <OrgName>Neon Goat Productions</OrgName>
 
22
        <Address><EMail>david@neongoat.com</EMail></Address>
 
23
      </Affiliation>
 
24
    </Author>
 
25
    <author>
 
26
      <firstname>Markus</firstname>
 
27
      <surname>Hoenicka</surname>
 
28
      <affiliation>
 
29
        <address format="linespecific"><email>markus@mhoenicka.de</email></address>
 
30
      </affiliation>
 
31
    </author>
 
32
    <Edition>Document revision: $Id: programmers-guide.sgml,v 1.12 2006/05/19 21:44:46 mhoenicka Exp $</Edition>
 
33
    <PubDate>$Date: 2006/05/19 21:44:46 $</PubDate>
 
34
    <Copyright>
 
35
      <Year>2001-2006</Year>
 
36
      <Holder>David Parker, Neon Goat Productions</Holder>
 
37
    </Copyright>
 
38
    <LegalNotice>
 
39
      <Para>
 
40
        Permission is granted to copy, distribute and/or modify this
 
41
        document under the terms of the <Link linkend="copying-FDL">
 
42
          <CiteTitle>GNU Free Documentation License</CiteTitle></Link>,
 
43
        Version 1.1 or any later version published by the Free Software
 
44
        Foundation; with no Invariant Sections, with no Front-Cover Texts,
 
45
        and with no Back-Cover Texts.  A copy of the license is included in
 
46
        <XRef linkend="copying-FDL">.
 
47
      </Para>
 
48
    </LegalNotice>
 
49
    <Abstract>
 
50
      <Para>
 
51
        libdbi implements a database-independent abstraction layer in C,
 
52
        similar to the DBI/DBD layer in Perl. Writing one generic set of code,
 
53
        programmers can leverage the power of multiple databases and multiple
 
54
        simultaneous database connections by using this framework.
 
55
      </Para>
 
56
    </Abstract>
 
57
  </BookInfo>
 
58
 
 
59
  <Chapter id="intro"><Title>Introduction</Title>
 
60
    <Section id="description"><Title>Description</Title>
 
61
      <Para>
 
62
        libdbi provides application developers with a database independent abstraction
 
63
        layer for C. It handles the database-specific implementations for each type of
 
64
        database, so that you can use the same exact code with any type of database server
 
65
        that libdbi supports. You can initiate and use multiple database connections
 
66
        simultaneously, regardless of the types of database servers you are connecting to.
 
67
        The driver architecture allows for new database drivers to be easily added
 
68
        dynamically.
 
69
      </Para>
 
70
    </Section>
 
71
    <Section id="terminology"><Title>libdbi Concepts and Terminology</Title>
 
72
      <Para>
 
73
        In this guide, the terms <Quote>user</Quote> and <Quote>programmer</Quote> are used
 
74
        interchangably, since the target audience is the software developer using libdbi in
 
75
        his program. The libdbi architecture provides serveral <Quote>drivers</Quote>, one
 
76
        for each type of database server. All drivers are loaded into memory upon libdbi
 
77
        initiallization and are made available to the programmer. Once a driver is
 
78
        <Emphasis>instantiated</Emphasis>, it represents a distinct database session and is
 
79
        called a <Quote>connection</Quote>. Multiple connections may exist for a single driver, and
 
80
        all will function independently of each other. A star character (*) represents a
 
81
        wildcard matching any letters. For example, <Quote>dbi_conn_*</Quote> would
 
82
        represent all functions beginning with <Quote>dbi_conn_</Quote>.
 
83
      </Para>
 
84
    </Section>
 
85
    <Section id="gnugpl"><Title>Modifications and redistribution of libdbi</Title>
 
86
      <Para>
 
87
        libdbi is Copyright &copy; 2001-2005, David Parker and Mark Tobenkin.
 
88
      </Para>
 
89
      <Para>                    
 
90
        libdbi is free software; you can redistribute it and/or
 
91
        modify it under the terms of the GNU Lesser General Public
 
92
        License as published by the Free Software Foundation; either
 
93
        version 2.1 of the License, or (at your option) any later version.
 
94
      </Para>
 
95
      <Para>
 
96
        This library is distributed in the hope that it will be useful,
 
97
        but WITHOUT ANY WARRANTY; without even the implied warranty of
 
98
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
99
        Lesser General Public License for more details.
 
100
      </Para>
 
101
      <Para>
 
102
        You should have received a copy of the GNU Lesser General Public
 
103
        License along with this library; if not, write to the Free Software
 
104
        Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
105
      </Para>
 
106
    </Section>
 
107
    <Section id="contact"><Title>Contact Info</Title>
 
108
      <Para>
 
109
        Please email us with any bugs, ideas, feature requests, or questions. The libdbi
 
110
        website has the latest version of this documentation and the libdbi software, as
 
111
        well as a central database of third-party drivers.
 
112
      </Para>
 
113
      <ItemizedList>
 
114
        <ListItem><Para>&www;</Para></ListItem>
 
115
        <ListItem><Para>David Parker <EMail>david@neongoat.com</EMail></Para></ListItem>
 
116
        <ListItem><Para>Mark Tobenkin <EMail>mark@brentwoodradio.com</EMail></Para></ListItem>
 
117
        <ListItem><Para>Markus Hoenicka <EMail>markus@mhoenicka.de</EMail></Para></ListItem>
 
118
      </ItemizedList>
 
119
    </Section>
 
120
  </Chapter>
 
121
 
 
122
  <Chapter id="quickstart"><Title>libdbi in a Nutshell (Quickstart Guide)</Title>
 
123
    <!-- this is a section -->
 
124
      &libdbi-quickstart;
 
125
    <!-- this is another section -->
 
126
      &example-program;
 
127
  </Chapter>
 
128
 
 
129
  &libdbi-reference;
 
130
  &freedoc-license;
 
131
 
 
132
</Book>