← Back to branch summary

~ubuntu-branches/ubuntu/karmic/mergeant/karmic

« back to all changes in this revision

Viewing changes to doc/libmergeant/C/intro.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo R. Montesino
  • Date: 2007-11-29 08:44:48 UTC
  • mfrom: (2.1.4 hardy)
  • Revision ID: james.westby@ubuntu.com-20071129084448-6aon73d22bv6hzfw
Tags: 0.67-3
* Re-enable installation of the mime files in mergeant.install
* mergeant.dirs: create usr/share/mime/packages to make dh_installmime add
  the update-mime-database code snippets

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/libmergeant/C/intro.sgml
1
 
<chapter>
2
 
<title>Introduction to the library</title>
3
 
<para>
4
 
  The libmergeant library's aim is to make it easy to manage data within databases.
5
 
  To achieve its purpose, it provides the following features:
6
 
  <itemizedlist>
7
 
    <listitem>
8
 
      <para>A dynamically managed structure of objects to represent the database
9
 
         structure and the server features (data types, functions, aggregates, tables, constraints
10
 
         on tables, etc). This structure can be used to obtain information on the database structure, it
11
 
         is the data dictionnary; a dictionnary is represented by a single <link linkend="MgConf">MgConf</link>;
12
 
      </para>
13
 
    </listitem>
14
 
    <listitem>
15
 
      <para>Some high level widgets to be used in applications 
16
 
         (<link linkend="MgSelector">MgSelector</link> and <link linkend="MgWorkForm">
17
 
          MgWorkForm</link> for instance);
18
 
      </para>
19
 
    </listitem>
20
 
    <listitem>
21
 
      <para>Some specific objects (<link linkend="MgDataHandler">MgDataHandler</link>) and widgets 
22
 
            (<link linkend="MgDataEntry">MgDataEntry</link>)to interact with data of most the most common type 
23
 
            (string, number, dates, etc) and plugins can be used to add support for other database specific
24
 
            data types;
25
 
      </para>
26
 
    </listitem>
27
 
    <listitem>
28
 
      <para>A dynamic way to build queries of any kind (even complex ones) with the <link linkend="MgQuery">MgQuery</link>
29
 
            object and encapsulates sending queries to the DBMS and receiving data from it; Each query can have some (optional or
30
 
            not) parameters (<link linkend="MgParameter">MgParameter</link> objects) required for their execution.
31
 
      </para>
32
 
    </listitem>
33
 
    <listitem>
34
 
      <para>Parameters are grouped together within a <link linkend="MgContext">MgContext</link> object, which manages
35
 
            them. Parameters can be declared as "shadows" of other parameters (alias parameters) which allow easy dynamic 
36
 
            and automatic update of widgets.
37
 
      </para>
38
 
    </listitem>
39
 
    <listitem>
40
 
      <para>The XML format is used to store all the meta-data (using the <link linkend="MgXmlStorage">MgXmlStorage</link> interface)
41
 
            and mechanisms to retreive references to objects from their XML id (the id stored in the XML file).
42
 
      </para>
43
 
    </listitem>
44
 
  </itemizedlist>
45
 
</para>
46
 
<para>
47
 
  Look at the examples in the source distribution of the library, or at the small example below.
48
 
</para>
49
 
&libmergeant-Example;
50
 
</chapter>