cvs: phpdoc /en/reference/ibase constants.xml

abies Sun May 30 18:04:43 2004 EDT Modified files: /phpdoc/en/reference/ibase constants.xml Log: Added more elaborate description of transaction & fetch flags Added new service API constants

http://cvs.php.net/diff.php/phpdoc/en/reference/ibase/constants.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/ibase/constants.xml diff -u phpdoc/en/reference/ibase/constants.xml:1.3 phpdoc/en/reference/ibase/constants.xml:1.4 --- phpdoc/en/reference/ibase/constants.xml:1.3 Sun Jul 27 18:21:29 2003 +++ phpdoc/en/reference/ibase/constants.xml Sun May 30 18:04:43 2004 @@ -1,175 +1,591 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Id: constants.xml,v 1.4 2004/05/30 22:04:43 abies Exp $ --> <section id="ibase.constants"> &reftitle.constants; &extension.constants; - <variablelist> - <varlistentry> - <term> - <constant>IBASE_DEFAULT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_TEXT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_UNIXTIME</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_WRITE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Access mode - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_READ</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Access mode - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_COMMITTED</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Isolation level - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_CONSISTENCY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Isolation level - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_CONCURRENCY</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Isolation level (default) - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_REC_VERSION</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_REC_NO_VERSION</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_NOWAIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Lock resolution - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_WAIT</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - Lock resolution (default) - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_TIMESTAMP</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_DATE</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - <varlistentry> - <term> - <constant>IBASE_TIME</constant> - (<type>integer</type>) - </term> - <listitem> - <simpara> - - </simpara> - </listitem> - </varlistentry> - </variablelist> + <para> + The following constants can be passed to <function>ibase_trans</function> + to specify transaction behaviour. + <table> + <title>Firebird/InterBase transaction flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Constant</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>IBASE_DEFAULT</entry> + <entry> + The default transaction settings are to be used. This default is + determined by the client library, which defines it as + IBASE_WRITE|IBASE_CONCURRENCY|IBASE_WAIT in most cases.</entry> + </row> + <row> + <entry>IBASE_READ</entry> + <entry>Starts a read-only transaction.</entry> + </row> + <row> + <entry>IBASE_WRITE</entry> + <entry>Starts a read-write transaction.</entry> + </row> + <row> + <entry>IBASE_CONSISTENCY</entry> + <entry>Starts a transaction with the isolation level set to + 'consistency', which means the transaction cannot read from tables + that are being modified by other concurrent transactions.</entry> + </row> + <row> + <entry>IBASE_CONCURRENCY</entry> + <entry>Starts a transaction with the isolation level set to + 'concurrency' (or 'snapshot'), which means the transaction + has access to all tables, but cannot see changes that were committed + by other transactions after the transaction was started.</entry> + </row> + <row> + <entry>IBASE_COMMITTED</entry> + <entry>Starts a transaction with the isolation level set to + 'read committed'. This flag should be combined with either + <constant>IBASE_REC_VERSION</constant> or + <constant>IBASE_REC_NO_VERSION</constant>. This isolation level + allows access to changes that were committed after the transaction + was started. If <constant>IBASE_REC_NO_VERSION</constant> was + specified, only the latest version of a row can be read. If + <constant>IBASE_REC_VERSION</constant> was specified, a row can + even be read when a modification to it is pending in a concurrent + transaction. + </entry> + </row> + <row> + <entry>IBASE_WAIT</entry> + <entry>Indicated that a transaction should wait and retry when a + conflict occurs.</entry> + </row> + <row> + <entry>IBASE_NOWAIT</entry> + <entry>Indicated that a transaction should fail immediately when a + conflict occurs.</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + <para> + The following constants can be passed to <function>ibase_fetch_row</function>, + <function>ibase_fetch_assoc</function> or <function>ibase_fetch_object</function> + to specify fetch behaviour. + <table> + <title>Firebird/InterBase fetch flags</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Constant</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>IBASE_FETCH_BLOBS</entry> + <entry>Also available as <constant>IBASE_TEXT</constant>for backward + compatibility. Causes BLOB contents to be fetched inline, instead of + being fetched as BLOB identifiers.</entry> + </row> + <row> + <entry>IBASE_FETCH_ARRAYS</entry> + <entry>Causes arrays to be fetched inline. Otherwise, array + identifiers are returned. Array identifiers can only be used as + arguments to INSERT operations, as no functions to handle array + identifiers are currently available. + </entry> + </row> + <row> + <entry>IBASE_UNIXTIME</entry> + <entry>Causes date and time fields not to be returned as strings, + but as UNIX timestamps (the number of seconds since the epoch, which + is 1-Jan-1970 0:00 UTC). Might be problematic if used with dates + before 1970 on some systems. + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + <para> + The following constants are used to pass requests and options to the service + API functions (<function>ibase_server_info</function>, <function>ibase_db_info + </function>, <function>ibase_backup</function>, <function>ibase_restore + </function> and <function>ibase_maintain_db</function>). Please refer to + the Firebird/InterBase manuals for the meaning of these options. + <variablelist> + <varlistentry> + <term> + <constant>IBASE_BKP_IGNORE_CHECKSUMS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_IGNORE_LIMBO</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_METADATA_ONLY</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_NO_GARBAGE_COLLECT</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_OLD_DESCRIPTIONS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_NON_TRANSPORTABLE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_BKP_CONVERT</constant> + </term> + <listitem> + <simpara> + Options to <function>ibase_backup()</function> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_DEACTIVATE_IDX</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_NO_SHADOW</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_NO_VALIDITY</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_ONE_AT_A_TIME</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_REPLACE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_CREATE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RES_USE_ALL_SPACE</constant> + </term> + <listitem> + <simpara> + Options to <function>ibase_restore</function> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_PAGE_BUFFERS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_SWEEP_INTERVAL</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_SHUTDOWN_DB</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_DENY_NEW_TRANSACTIONS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_DENY_NEW_ATTACHMENTS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_RESERVE_SPACE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_RES_USE_FULL</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_RES</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_WRITE_MODE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_WM_ASYNC</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_WM_SYNC</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_ACCESS_MODE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_AM_READONLY</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_AM_READWRITE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_SET_SQL_DIALECT</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_ACTIVATE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_PRP_DB_ONLINE</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_CHECK_DB</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_IGNORE_CHECKSUM</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_KILL_SHADOWS</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_MEND_DB</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_VALIDATE_DB</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_FULL</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_RPR_SWEEP_DB</constant> + </term> + <listitem> + <simpara> + Options to <function>ibase_maintain_db</function> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_STS_DATA_PAGES</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_STS_DB_LOG</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_STS_HDR_PAGES</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_STS_IDX_PAGES</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_STS_SYS_RELATIONS</constant> + </term> + <listitem> + <simpara> + Options to <function>ibase_db_info</function> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_SERVER_VERSION</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_IMPLEMENTATION</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_GET_ENV</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_GET_ENV_LOCK</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_GET_ENV_MSG</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_USER_DBPATH</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_SVR_DB_INFO</constant> + </term> + <listitem> + <simpara> + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>IBASE_SVC_GET_USERS</constant> + </term> + <listitem> + <simpara> + Options to <function>ibase_server_info</function> + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> </section> <!-- Keep this comment at the end of the file