Skip to content

D
doctrine-dbal
Commit 614ec1fb authored by pookey's avatar pookey
Browse files
Options

docbook docs update

parent 2662b46e
Hide whitespace changes
Inline Side-by-side
Showing with 55 additions and 47 deletions
manual/docbook/doctrine.xml
View file @ 614ec1fb
...@@ -113,44 +113,46 @@ ...@@ -113,44 +113,46 @@
<sect1 id="features"> <sect1 id="features">
<title>Features</title> <title>Features</title>
<para> <sect3 id="features-general">
General Features <title>
</para> General Features
<itemizedlist> </title>
<listitem>Fully object-oriented following best practices and design patterns</listitem> <itemizedlist>
<listitem>Multiple databases</listitem> <listitem>Fully object-oriented following best practices and design patterns</listitem>
<listitem>Database connection pooling with connection-record -registry</listitem> <listitem>Multiple databases</listitem>
<listitem>Runtime configuration (no XML needed!)</listitem> <listitem>Database connection pooling with connection-record -registry</listitem>
<listitem>Very modular structure (only uses the needed features)</listitem> <listitem>Runtime configuration (no XML needed!)</listitem>
<listitem>The runtime components can be compiled into a single fileM</listitem> <listitem>Very modular structure (only uses the needed features)</listitem>
<listitem>Leveled configuration (attributes can be set at global, connection and table levels)</listitem> <listitem>The runtime components can be compiled into a single fileM</listitem>
</itemizedlist> <listitem>Leveled configuration (attributes can be set at global, connection and table levels)</listitem>
</itemizedlist>
<para> </sect3>
Database Abstraction <sect3>
</para> <title>
<itemizedlist> Database Abstraction
<listitem>A DSN (data source name) or array format for specifying database servers</listitem> </title>
<listitem>Datatype abstraction and on demand datatype conversion</listitem> <itemizedlist>
<listitem>supports PDO</listitem> <listitem>A DSN (data source name) or array format for specifying database servers</listitem>
<listitem>Database query profiling</listitem> <listitem>Datatype abstraction and on demand datatype conversion</listitem>
<listitem>Query caching</listitem> <listitem>supports PDO</listitem>
<listitem>Sequence / autoincrement emulation</listitem> <listitem>Database query profiling</listitem>
<listitem>Replace emulation</listitem> <listitem>Query caching</listitem>
<listitem>RDBMS management methods (creating, dropping, altering)</listitem> <listitem>Sequence / autoincrement emulation</listitem>
<listitem>SQL function call abstraction</listitem> <listitem>Replace emulation</listitem>
<listitem>SQL expression abstraction</listitem> <listitem>RDBMS management methods (creating, dropping, altering)</listitem>
<listitem>Pattern matching abstraction</listitem> <listitem>SQL function call abstraction</listitem>
<listitem>Portable error codes</listitem> <listitem>SQL expression abstraction</listitem>
<listitem>Nested transactions</listitem> <listitem>Pattern matching abstraction</listitem>
<listitem>Transaction isolation abstraction</listitem> <listitem>Portable error codes</listitem>
<listitem>Transaction savepoint abstraction</listitem> <listitem>Nested transactions</listitem>
<listitem>Index/Unique Key/Primary Key support</listitem> <listitem>Transaction isolation abstraction</listitem>
<listitem>Ability to read the information schema</listitem> <listitem>Transaction savepoint abstraction</listitem>
<listitem>Reverse engineering schemas from an existing database</listitem> <listitem>Index/Unique Key/Primary Key support</listitem>
<listitem>LIMIT / OFFSET emulation </listitem> <listitem>Ability to read the information schema</listitem>
</itemizedlist> <listitem>Reverse engineering schemas from an existing database</listitem>
<listitem>LIMIT / OFFSET emulation </listitem>
</itemizedlist>
</sect3>
<sect3 id="features-orm"> <sect3 id="features-orm">
<title> <title>
Object Relational Mapping Object Relational Mapping
...@@ -218,10 +220,16 @@ ...@@ -218,10 +220,16 @@
<title>Requirements</title> <title>Requirements</title>
<para> <para>
Doctrine requires PHP >= 5.1, and it doesn't require any external libraries. Doctrine requires PHP >= 5.1, and it doesn't require any external libraries.
It runs on both windows and *nix based platforms.
</para> </para>
<para> <para>
For database abstraction Doctrine uses PDO which is bundled with php by For database abstraction Doctrine uses PDO which is bundled with php by
default. Doctrine also requires a little adodb-hack for table creation, default. You will need PDO support for whatever database you intend to
use, and if you want to be able to run the included unit tests, you
will need SQLite support.
</para>
<para>
Doctrine also requires a little adodb-hack for table creation,
which comes with doctrine. which comes with doctrine.
</para> </para>
</sect1> </sect1>
...@@ -229,15 +237,8 @@ ...@@ -229,15 +237,8 @@
<sect1 id="community"> <sect1 id="community">
<title>Community</title> <title>Community</title>
<para> <para>
Doctrine has 3 mailing lists, an IRC channel, a forum, and a wiki. Doctrine has 3 mailing lists, an IRC channel, a forum, and a wiki/trac.
</para> </para>
<sect2 id="community-forum">
<title>Forum</title>
<para>
The Doctrine forum can be found here:
<ulink url="http://www.phpbbserver.com/phpdoctrine/">http://www.phpbbserver.com/phpdoctrine/</ulink>
</para>
</sect2>
<sect2 id="community-mailinglist"> <sect2 id="community-mailinglist">
<title>Mailing Lists</title> <title>Mailing Lists</title>
<para> <para>
...@@ -273,6 +274,13 @@ ...@@ -273,6 +274,13 @@
url="http://doctrine.pengus.net/trac">http://doctrine.pengus.net/trac</ulink> url="http://doctrine.pengus.net/trac">http://doctrine.pengus.net/trac</ulink>
</para> </para>
</sect2> </sect2>
<sect2 id="community-forum">
<title>Forum</title>
<para>
The Doctrine forum can be found here:
<ulink url="http://www.phpbbserver.com/phpdoctrine/">http://www.phpbbserver.com/phpdoctrine/</ulink>
</para>
</sect2>
</sect1> </sect1>
<sect1 id="contributing"> <sect1 id="contributing">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment