source: trunk/phpgwapi/inc/adodb/docs/docs-datadict.htm @ 2

Revision 2, 20.6 KB checked in by niltonneto, 17 years ago (diff)

Removida todas as tags usadas pelo CVS ($Id, $Source).
Primeira versão no CVS externo.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3<head>
4  <title>ADODB Data Dictionary Manual</title>
5  <meta http-equiv="Content-Type"
6 content="text/html; charset=iso-8859-1">
7  <style type="text/css">
8      body, td {
9        /*font-family: Arial, Helvetica, sans-serif;*/
10        font-size: 11pt;
11      }
12      pre {
13        font-size: 9pt;
14         background-color: #EEEEEE; padding: .5em; margin: 0px;
15      }
16      .toplink {
17        font-size: 8pt;
18      }
19    </style>
20</head>
21<body style="background-color: rgb(255, 255, 255);">
22<h2>ADOdb Data Dictionary Library for PHP</h2>
23<p>V4.50 6 July 2004 (c) 2000-2004 John Lim (<a
24 href="mailto:jlim#natsoft.com.my">jlim#natsoft.com.my</a>).<br>
25AXMLS (c) 2004 ars Cognita, Inc</p>
26<p><font size="1">This software is dual licensed using BSD-Style and
27LGPL. This means you can use it in compiled proprietary and commercial
28products.</font></p>
29<table border="1">
30  <tbody>
31    <tr>
32      <td><font color="red">Kindly note that the ADOdb home page has
33moved to <a href="http://adodb.sourceforge.net/">http://adodb.sourceforge.net/</a>
34because of the persistent unreliability of http://php.weblogs.com. <b>Please
35change your links</b>!</font></td>
36    </tr>
37  </tbody>
38</table>
39<p>Useful ADOdb links: <a href="http://adodb.sourceforge.net/#download">Download</a>
40&nbsp; <a href="http://adodb.sourceforge.net/#docs">Other Docs</a>
41</p>
42<p>This documentation describes a PHP class library to automate the
43creation of tables, indexes and foreign key constraints portably for
44multiple databases. Richard Tango-Lowy and Dan Cech have been kind
45enough to contribute <a href="#xmlschema">AXMLS</a>, an XML schema
46system for defining databases. You can contact them at
47dcech#phpwerx.net and richtl#arscognita.com.</p>
48<p>Currently the following databases are supported:</p>
49<p> <b>Well-tested:</b> PostgreSQL, MySQL, Oracle, MSSQL.<br>
50<b>Beta-quality:</b> DB2, Informix, Sybase, Interbase, Firebird.<br>
51<b>Alpha-quality:</b> MS Access (does not support DEFAULT values) and
52generic ODBC.
53</p>
54<h3>Example Usage</h3>
55<pre>  include_once('adodb.inc.php');<br>  <font color="#006600"># First create a normal connection</font><br>  $db-&gt;NewADOConnection('mysql');<br>  $db-&gt;Connect(...);<br><br>  <font
56 color="#006600"># Then create a data dictionary object, using this connection</font><br>  $dict = <strong>NewDataDictionary</strong>($db);<br><br>  <font
57 color="#006600"># We have a portable declarative data dictionary format in ADOdb, similar to SQL.<br>  # Field types use 1 character codes, and fields are separated by commas.<br>  # The following example creates three fields: "col1", "col2" and "col3":</font><br>  $flds = " <br>  <font
58 color="#663300"><strong> col1 C(32) NOTNULL DEFAULT 'abc',<br>   col2 I  DEFAULT 0,<br>   col3 N(12.2)</strong></font><br>  ";<br><br>  <font
59 color="#006600"># We demonstrate creating tables and indexes</font><br>  $sqlarray = $dict-&gt;<strong>CreateTableSQL</strong>($tabname, $flds, $taboptarray);<br>  $dict-&gt;<strong>ExecuteSQLArray</strong>($sqlarray);<br><br>  $idxflds = 'co11, col2';<br>  $sqlarray = $dict-&gt;<strong>CreateIndexSQL</strong>($idxname, $tabname, $idxflds);<br>  $dict-&gt;<strong>ExecuteSQLArray</strong>($sqlarray);<br></pre>
60<h3>Functions</h3>
61<h4>function CreateDatabase($dbname, $optionsarray=false)</h4>
62<p>Create a database with the name $dbname;</p>
63<h4>function CreateTableSQL($tabname, $fldarray, $taboptarray=false)</h4>
64<pre>  RETURNS:      an array of strings, the sql to be executed, or false<br>  $tabname:     name of table<br>  $fldarray:    string (or array) containing field info<br>  $taboptarray: array containing table options<br></pre>
65<p>The new format of $fldarray uses a free text format, where each
66field is comma-delimited.
67The first token for each field is the field name, followed by the type
68and optional
69field size. Then optional keywords in $otheroptions:</p>
70<pre>  "$fieldname $type $colsize $otheroptions"</pre>
71<p>The older (and still supported) format of $fldarray is a
722-dimensional array, where each row in the 1st dimension represents one
73field. Each row has this format:</p>
74<pre>  array($fieldname, $type, [,$colsize] [,$otheroptions]*)</pre>
75<p>The first 2 fields must be the field name and the field type. The
76field type can be a portable type codes or the actual type for that
77database.</p>
78<p>Legal portable type codes include:</p>
79<pre>  C:  varchar<br>  X:  Largest varchar size <br>  XL: For Oracle, returns CLOB, otherwise same as 'X' above<br><br>  C2: Multibyte varchar<br>  X2: Multibyte varchar (largest size)<br><br>  B:  BLOB (binary large object)<br><br>  D:  Date (some databases do not support this, and we return a datetime type)<br>  T:  Datetime or Timestamp<br>  L:  Integer field suitable for storing booleans (0 or 1)<br>  I:  Integer (mapped to I4)<br>  I1: 1-byte integer<br>  I2: 2-byte integer<br>  I4: 4-byte integer<br>  I8: 8-byte integer<br>  F:  Floating point number<br>  N:  Numeric or decimal number<br></pre>
80<p>The $colsize field represents the size of the field. If a decimal
81number is used, then it is assumed that the number following the dot is
82the precision, so 6.2 means a number of size 6 digits and 2 decimal
83places. It is recommended that the default for number types be
84represented as a string to avoid any rounding errors.</p>
85<p>The $otheroptions include the following keywords (case-insensitive):</p>
86<pre>  AUTO            For autoincrement number. Emulated with triggers if not available.<br>                  Sets NOTNULL also.<br>  AUTOINCREMENT   Same as auto.<br>  KEY             Primary key field. Sets NOTNULL also. Compound keys are supported.<br>  PRIMARY         Same as KEY.<br>  DEF             Synonym for DEFAULT for lazy typists.<br>  DEFAULT         The default value. Character strings are auto-quoted unless<br>                  the string begins and ends with spaces, eg ' SYSDATE '.<br>  NOTNULL         If field is not null.<br>  DEFDATE         Set default value to call function to get today's date.<br>  DEFTIMESTAMP    Set default to call function to get today's datetime.<br>  NOQUOTE         Prevents autoquoting of default string values.<br>  CONSTRAINTS     Additional constraints defined at the end of the field<br>                  definition.<br></pre>
87<p>The Data Dictonary accepts two formats, the older array
88specification:</p>
89<pre>  $flds = array(<br>    array('COLNAME',   'DECIMAL', '8.4', 'DEFAULT' =&gt; 0, 'NOTNULL'),<br>    array('id',        'I'      , 'AUTO'),<br>    array('`MY DATE`', 'D'      , 'DEFDATE'),<br>    array('NAME',      'C'      , '32', 'CONSTRAINTS' =&gt; 'FOREIGN KEY REFERENCES reftable')<br>  );<br></pre>
90<p>Or the simpler declarative format:</p>
91<pre>  $flds = "<font color="#660000"><strong><br>    COLNAME DECIMAL(8.4) DEFAULT 0 NOTNULL,<br>    id I AUTO,<br>    `MY DATE` D DEFDATE,<br>    NAME C(32) CONSTRAINTS 'FOREIGN KEY REFERENCES reftable'</strong></font><br>  ";<br></pre>
92<p>Note that if you have special characters in the field name (e.g. My
93Date), you should enclose it in back-quotes. Normally field names are
94not case-sensitive, but if you enclose it in back-quotes, some
95databases will treat the names as case-sensitive (eg. Oracle) , and
96others won't. So be careful.</p>
97<p>The $taboptarray is the 3rd parameter of the CreateTableSQL
98function. This contains table specific settings. Legal keywords include:</p>
99<ul>
100  <li><b>REPLACE</b><br>
101Indicates that the previous table definition should be removed
102(dropped)together with ALL data. See first example below. </li>
103  <li><b>DROP</b><br>
104Drop table. Useful for removing unused tables. </li>
105  <li><b>CONSTRAINTS</b><br>
106Define this as the key, with the constraint as the value. See the
107postgresql example below. Additional constraints defined for the whole
108table. You will probably need to prefix this with a comma. </li>
109</ul>
110<p>Database specific table options can be defined also using the name
111of the database type as the array key. In the following example, <em>create
112the table as ISAM with MySQL, and store the table in the "users"
113tablespace if using Oracle</em>. And because we specified REPLACE, drop
114the table first.</p>
115<pre>  $taboptarray = array('mysql' =&gt; 'TYPE=ISAM', 'oci8' =&gt; 'tablespace users', 'REPLACE');</pre>
116<p>You can also define foreignkey constraints. The following is syntax
117for postgresql:
118</p>
119<pre>  $taboptarray = array('constraints' =&gt; ', FOREIGN KEY (col1) REFERENCES reftable (refcol)');</pre>
120<h4>function DropTableSQL($tabname)</h4>
121<p>Returns the SQL to drop the specified table.</p>
122<h4>function ChangeTableSQL($tabname, $flds)</h4>
123<p>Checks to see if table exists, if table does not exist, behaves like
124CreateTableSQL. If table exists, generates appropriate ALTER TABLE
125MODIFY COLUMN commands if field already exists, or ALTER TABLE ADD
126$column if field does not exist.</p>
127<p>The class must be connected to the database for ChangeTableSQL to
128detect the existence of the table. Idea and code contributed by Florian
129Buzin.</p>
130<h4>function CreateIndexSQL($idxname, $tabname, $flds,
131$idxoptarray=false)</h4>
132<pre>  RETURNS:      an array of strings, the sql to be executed, or false<br>  $idxname:     name of index<br>  $tabname:     name of table<br>  $flds:        list of fields as a comma delimited string or an array of strings<br>  $idxoptarray: array of index creation options<br></pre>
133<p>$idxoptarray is similar to $taboptarray in that index specific
134information can be embedded in the array. Other options include:</p>
135<pre>  CLUSTERED     Create clustered index (only mssql)<br>  BITMAP        Create bitmap index (only oci8)<br>  UNIQUE        Make unique index<br>  FULLTEXT      Make fulltext index (only mysql)<br>  HASH          Create hash index (only postgres)<br>  DROP          Drop legacy index<br></pre>
136<h4>function DropIndexSQL ($idxname, $tabname = NULL)</h4>
137<p>Returns the SQL to drop the specified index.</p>
138<h4>function AddColumnSQL($tabname, $flds)</h4>
139<p>Add one or more columns. Not guaranteed to work under all situations.</p>
140<h4>function AlterColumnSQL($tabname, $flds)</h4>
141<p>Warning, not all databases support this feature.</p>
142<h4>function DropColumnSQL($tabname, $flds)</h4>
143<p>Drop 1 or more columns.</p>
144<h4>function SetSchema($schema)</h4>
145<p>Set the schema.</p>
146<h4>function &amp;MetaTables()</h4>
147<h4>function &amp;MetaColumns($tab, $upper=true, $schema=false)</h4>
148<h4>function &amp;MetaPrimaryKeys($tab,$owner=false,$intkey=false)</h4>
149<h4>function &amp;MetaIndexes($table, $primary = false, $owner = false)</h4>
150<p>These functions are wrappers for the corresponding functions in the
151connection object. However, the table names will be autoquoted by the
152TableName function (see below) before being passed to the connection
153object.</p>
154<h4>function NameQuote($name = NULL)</h4>
155<p>If the provided name is quoted with backquotes (`) or contains
156special characters, returns the name quoted with the appropriate quote
157character, otherwise the name is returned unchanged.</p>
158<h4>function TableName($name)</h4>
159<p>The same as NameQuote, but will prepend the current schema if
160specified</p>
161<h4>function MetaType($t,$len=-1,$fieldobj=false)</h4>
162<h4>function ActualType($meta)</h4>
163<p>Convert between database-independent 'Meta' and database-specific
164'Actual' type codes.</p>
165<h4>function ExecuteSQLArray($sqlarray, $contOnError = true)</h4>
166<pre>  RETURNS:      0 if failed, 1 if executed all but with errors, 2 if executed successfully<br>  $sqlarray:    an array of strings with sql code (no semicolon at the end of string)<br>  $contOnError: if true, then continue executing even if error occurs<br></pre>
167<p>Executes an array of SQL strings returned by CreateTableSQL or
168CreateIndexSQL.</p>
169<hr>
170<a name="xmlschema"></a>
171<h2>ADOdb XML Schema (AXMLS)</h2>
172<p>This is a class contributed by Richard Tango-Lowy and Dan Cech that
173allows the user to quickly
174and easily build a database using the excellent ADODB database library
175and a simple XML formatted file.
176You can <a href="http://sourceforge.net/projects/adodb-xmlschema/">download
177the latest version of AXMLS here</a>.</p>
178<h3>Quick Start</h3>
179<p>Adodb-xmlschema, or AXMLS, is a set of classes that allow the user
180to quickly and easily build or upgrade a database on almost any RDBMS
181using the excellent ADOdb database library and a simple XML formatted
182schema file. Our goal is to give developers a tool that's simple to
183use, but that will allow them to create a single file that can build,
184upgrade, and manipulate databases on most RDBMS platforms.</p>
185<span style="font-weight: bold;"> Installing axmls</span>
186<p>The easiest way to install AXMLS to download and install any recent
187version of the ADOdb database abstraction library. To install AXMLS
188manually, simply copy the adodb-xmlschema.inc.php file and the xsl
189directory into your adodb directory.</p>
190<span style="font-weight: bold;"> Using AXMLS in Your Application</span>
191<p>There are two steps involved in using AXMLS in your application:
192first, you must create a schema, or XML representation of your
193database, and second, you must create the PHP code that will parse and
194execute the schema.</p>
195<p>Let's begin with a schema that describes a typical, if simplistic
196user management table for an application.</p>
197<pre class="listing"><pre>&lt;?xml version="1.0"?&gt;<br>&lt;schema version="0.2"&gt;<br><br>  &lt;table name="users"&gt;<br>    &lt;desc&gt;A typical users table for our application.&lt;/desc&gt;<br>    &lt;field name="userId" type="I"&gt;<br>      &lt;descr&gt;A unique ID assigned to each user.&lt;/descr&gt;<br><br>      &lt;KEY/&gt;<br>      &lt;AUTOINCREMENT/&gt;<br>    &lt;/field&gt;<br>    <br>    &lt;field name="userName" type="C" size="16"&gt;&lt;NOTNULL/&gt;&lt;/field&gt;<br><br>    <br>    &lt;index name="userName"&gt;<br>      &lt;descr&gt;Put a unique index on the user name&lt;/descr&gt;<br>      &lt;col&gt;userName&lt;/col&gt;<br>      &lt;UNIQUE/&gt;<br><br>    &lt;/index&gt;<br>  &lt;/table&gt;<br>  <br>  &lt;sql&gt;<br>    &lt;descr&gt;Insert some data into the users table.&lt;/descr&gt;<br>    &lt;query&gt;insert into users (userName) values ( 'admin' )&lt;/query&gt;<br><br>    &lt;query&gt;insert into users (userName) values ( 'Joe' )&lt;/query&gt;<br>  &lt;/sql&gt;<br>&lt;/schema&gt;                       <br></pre></pre>
198<p>Let's take a detailed look at this schema.</p>
199<p>The opening &lt;?xml version="1.0"?&gt; tag is required by XML. The
200&lt;schema&gt; tag tells the parser that the enclosed markup defines an
201XML schema. The version="0.2" attribute sets <em>the version of the
202AXMLS DTD used by the XML schema.</em> </p>
203<p>All versions of AXMLS prior to version 1.0 have a schema version of
204"0.1". The current schema version is "0.2".</p>
205<pre class="listing"><pre>&lt;?xml version="1.0"?&gt;<br>&lt;schema version="0.2"&gt;<br>  ...<br>&lt;/schema&gt;<br></pre></pre>
206<p>Next we define one or more tables. A table consists of a fields (and
207other objects) enclosed by &lt;table&gt; tags. The name="" attribute
208specifies the name of the table that will be created in the database.</p>
209<pre class="listing"><pre>&lt;table name="users"&gt;<br><br>    &lt;desc&gt;A typical users table for our application.&lt;/desc&gt;<br>    &lt;field name="userId" type="I"&gt;<br><br>      &lt;descr&gt;A unique ID assigned to each user.&lt;/descr&gt;<br>      &lt;KEY/&gt;<br>      &lt;AUTOINCREMENT/&gt;<br>    &lt;/field&gt;<br>    <br>    &lt;field name="userName" type="C" size="16"&gt;&lt;NOTNULL/&gt;&lt;/field&gt;<br><br>    <br>&lt;/table&gt;<br></pre></pre>
210<p>This table is called "users" and has a description and two fields.
211The description is optional, and is currently only for your own
212information; it is not applied to the database.</p>
213<p>The first &lt;field&gt; tag will create a field named "userId" of
214type "I", or integer. (See the ADOdb Data Dictionary documentation for
215a list of valid types.) This &lt;field&gt; tag encloses two special
216field options: &lt;KEY/&gt;, which specifies this field as a primary
217key, and &lt;AUTOINCREMENT/&gt;, which specifies that the database
218engine should automatically fill this field with the next available
219value when a new row is inserted.</p>
220<p>The second &lt;field&gt; tag will create a field named "userName" of
221type "C", or character, and of length 16 characters. The
222&lt;NOTNULL/&gt; option specifies that this field does not allow NULLs.</p>
223<p>There are two ways to add indexes to a table. The simplest is to
224mark a field with the &lt;KEY/&gt; option as described above; a primary
225key is a unique index. The second and more powerful method uses the
226&lt;index&gt; tags.</p>
227<pre class="listing"><pre>&lt;table name="users"&gt;<br>  ...<br>    <br>  &lt;index name="userName"&gt;<br>    &lt;descr&gt;Put a unique index on the user name&lt;/descr&gt;<br>    &lt;col&gt;userName&lt;/col&gt;<br><br>    &lt;UNIQUE/&gt;<br>  &lt;/index&gt;<br>    <br>&lt;/table&gt;<br></pre></pre>
228<p>The &lt;index&gt; tag specifies that an index should be created on
229the enclosing table. The name="" attribute provides the name of the
230index that will be created in the database. The description, as above,
231is for your information only. The &lt;col&gt; tags list each column
232that will be included in the index. Finally, the &lt;UNIQUE/&gt; tag
233specifies that this will be created as a unique index.</p>
234<p>Finally, AXMLS allows you to include arbitrary SQL that will be
235applied to the database when the schema is executed.</p>
236<pre class="listing"><pre>&lt;sql&gt;<br>  &lt;descr&gt;Insert some data into the users table.&lt;/descr&gt;<br>  &lt;query&gt;insert into users (userName) values ( 'admin' )&lt;/query&gt;<br><br>  &lt;query&gt;insert into users (userName) values ( 'Joe' )&lt;/query&gt;<br>&lt;/sql&gt;<br></pre></pre>
237<p>The &lt;sql&gt; tag encloses any number of SQL queries that you
238define for your own use.</p>
239<p>Now that we've defined an XML schema, you need to know how to apply
240it to your database. Here's a simple PHP script that shows how to load
241the schema.</p>
242<pre class="listing"><pre>&lt;?PHP<br>/* You must tell the script where to find the ADOdb and<br> * the AXMLS libraries.<br> */<br>require( "path_to_adodb/adodb.inc.php");<br>require( "path_to_adodb/adodb-xmlschema.inc.php" );<br><br>/* Configuration information. Define the schema filename,<br> * RDBMS platform (see the ADODB documentation for valid<br> * platform names), and database connection information here.<br> */<br>$schemaFile = 'example.xml';<br>$platform = 'mysql';<br>$dbHost = 'localhost';<br>$dbName = 'database';<br>$dbUser = 'username';<br>$dbPassword = 'password';<br><br>/* Start by creating a normal ADODB connection.<br> */<br>$db = ADONewConnection( $platform );<br>$db-&gt;Connect( $dbHost, $dbUser, $dbPassword, $dbName );<br><br>/* Use the database connection to create a new adoSchema object.<br> */<br>$schema = new adoSchema( $db );<br><br>/* Call ParseSchema() to build SQL from the XML schema file.<br> * Then call ExecuteSchema() to apply the resulting SQL to <br> * the database.<br> */<br>$sql = $schema-&gt;ParseSchema( $schemaFile );<br>$result = $schema-&gt;ExecuteSchema();<br>?&gt;<br></pre></pre>
243<p>Let's look at each part of the example in turn. After you manually
244create the database, there are three steps required to load (or
245upgrade) your schema.</p>
246<p>First, create a normal ADOdb connection. The variables and values
247here should be those required to connect to your database.</p>
248<pre class="listing"><pre>$db = ADONewConnection( 'mysql' );<br>$db-&gt;Connect( 'host', 'user', 'password', 'database' );<br></pre></pre>
249<p>Second, create the adoSchema object that load and manipulate your
250schema. You must pass an ADOdb database connection object in order to
251create the adoSchema object.</p>
252<pre class="listing"><pre>$schema = new adoSchema( $db );<br></pre></pre>
253<p>Third, call ParseSchema() to parse the schema and then
254ExecuteSchema() to apply it to the database. You must pass
255ParseSchema() the path and filename of your schema file.</p>
256<pre class="listing"><pre><br>$schema-&gt;ParseSchema( $schemaFile ); <br>$schema-&gt;ExecuteSchema(); <br></pre></pre>
257<p>Execute the above code and then log into your database. If you've
258done all this right, you should see your tables, indexes, and SQL.</p>
259<p>You can find the source files for this tutorial in the examples
260directory as tutorial_shema.xml and tutorial.php. See the class
261documentation for a more detailed description of the adoSchema methods,
262including methods and schema elements that are not described in this
263tutorial.</p>
264<h3>Upgrading</h3>
265If your schema version is older, than XSLT is used to transform the
266schema to the newest version. This means that if you are using an older
267XML schema format, you need to have the XSLT extension installed.
268If you do not want to require your users to have the XSLT extension
269installed, make sure you modify your XML schema to conform to the
270latest version.
271<hr>
272<address>If you have any questions or comments, please email them to
273Richard at richtl#arscognita.com.
274</address>
275</body>
276</html>
Note: See TracBrowser for help on using the repository browser.