re-orgnized the CUBRID PHP constants

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@307647 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Esen Sagynov 2011-01-21 06:22:08 +00:00
parent 5ec0a415a4
commit 50160d8770

View file

@ -4,395 +4,246 @@
<appendix xml:id="cubrid.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<para>
<variablelist>
<varlistentry>
<term>
<constant>CUBRID_INCLUDE_OID</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to determine whether to get OID after query execution.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_ASYNC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to execute the query in asynchronous mode.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_NUM</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to get the query result as a numeric array (0-default).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_ASSOC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to get the query result as an associative array.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_BOTH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to get the query result as both numeric and associative arrays (default value).
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_OBJECT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to get the query result an object that has the attribute whose name is the same as the column name.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_CURSOR_FIRST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to move the current cursor to the first position in the result.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_CURSOR_CURRENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to move the current cursor as a default value if the origin is not specified.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_CURSOR_LAST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is used to move the current cursor to the last position in the result.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_CURSOR_SUCCESS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the returned value of <function>cubrid_move_cursor</function> function in case of success.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_NO_MORE_DATA</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the returned value of <function>cubrid_move_cursor</function> function in case of failure.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_CURSOR_ERROR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the returned value of <function>cubrid_move_cursor</function> function in case of failure.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CLASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_VCLASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_QUERY_SPEC</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_ATTRIBUTE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CLASS_ATTRIBUTE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_METHOD</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CLASS_METHOD</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_METHOD_FILE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_SUPERCLASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_SUBCLASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CONSTRAINT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_TRIGGER</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CLASS_PRIVILEGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_ATTR_PRIVILEGE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_DIRECT_SUPER_CLASS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_PRIMARY_KEY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_IMPORTED_KEYS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_EXPORTED_KEYS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_SCH_CROSS_REFERENCE</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is a schema type used for <function>cubrid_schema</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_FACILITY_DBMS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the facility code of the occurred error code when using <function>cubrid_error_code_facility</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_FACILITY_CAS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the facility code of the occurred error code when using <function>cubrid_error_code_facility</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_FACILITY_CCI</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the facility code of the occurred error code when using <function>cubrid_error_code_facility</function> function.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>CUBRID_FACILITY_CLIENT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Is the facility code of the occurred error code when using <function>cubrid_error_code_facility</function> function.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
The following constants can be used when executing SQL statement. They can be passed to <function>cubrid_prepare</function>
and <function>cubrid_execute</function>.
<table>
<title>CUBRID SQL execution flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_INCLUDE_OID</entry>
<entry>Determine whether to get OID during query execution.</entry>
</row>
<row>
<entry>CUBRID_ASYNC</entry>
<entry>Execute the query in asynchronous mode.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when fetching the results to specify fetch behaviour. They can be passed to <function>cubrid_fetch</function>
and <function>cubrid_fetch_array</function>.
<table>
<title>CUBRID fetch flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_NUM</entry>
<entry>Get query result as a numeric array (0-default).</entry>
</row>
<row>
<entry>CUBRID_ASSOC</entry>
<entry>Get query result as an associative array.</entry>
</row>
<row>
<entry>CUBRID_BOTH</entry>
<entry>Get query result as both numeric and associative arrays (default value).</entry>
</row>
<row>
<entry>CUBRID_BOTH</entry>
<entry>Get query result as both numeric and associative arrays (default value).</entry>
</row>
<row>
<entry>CUBRID_OBJECT</entry>
<entry>Get query result an object.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when positioning the cursor in query results. They can be passed to or returned by
<function>cubrid_move_cursor</function>.
<table>
<title>CUBRID cursor position flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_CURSOR_FIRST</entry>
<entry>Move current cursor to the first position in the result.</entry>
</row>
<row>
<entry>CUBRID_CURSOR_CURRENT</entry>
<entry>Move current cursor as a default value if the origin is not specified.</entry>
</row>
<row>
<entry>CUBRID_CURSOR_LAST</entry>
<entry>Move current cursor to the last position in the result.</entry>
</row>
<row>
<entry>CUBRID_CURSOR_SUCCESS</entry>
<entry>Returned value of <function>cubrid_move_cursor</function> function in case of success.</entry>
</row>
<row>
<entry>CUBRID_NO_MORE_DATA</entry>
<entry>Returned value of <function>cubrid_move_cursor</function> function in case of failure.</entry>
</row>
<row>
<entry>CUBRID_CURSOR_ERROR</entry>
<entry>Returned value of <function>cubrid_move_cursor</function> function in case of failure.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when getting schema information. They can be passed to <function>cubrid_schema</function>.
<table>
<title>CUBRID schema flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_SCH_CLASS</entry>
<entry>Get name and type of table in CUBRID.</entry>
</row>
<row>
<entry>CUBRID_SCH_VCLASS</entry>
<entry>Get name and type of view in CUBRID.</entry>
</row>
<row>
<entry>CUBRID_SCH_QUERY_SPEC</entry>
<entry>Get the query definition of view.</entry>
</row>
<row>
<entry>CUBRID_SCH_ATTRIBUTE</entry>
<entry>Get the attributes of table column.</entry>
</row>
<row>
<entry>CUBRID_SCH_CLASS_ATTRIBUTE</entry>
<entry>Get the attributes of table.</entry>
</row>
<row>
<entry>CUBRID_SCH_METHOD</entry>
<entry>Get the instance method. The instance method is a method called
by a class instance. It is used more often than the class method
because most operations are executed in the instance.</entry>
</row>
<row>
<entry>CUBRID_SCH_CLASS_METHOD</entry>
<entry>Get the class method. The class method is a method called by a
class object. It is usually used to create a new class instance or to
initialize it. It is also used to access or update class
attributes.</entry>
</row>
<row>
<entry>CUBRID_SCH_METHOD_FILE</entry>
<entry>Get the information of the file where the method of the table is
defined.</entry>
</row>
<row>
<entry>CUBRID_SCH_SUPERCLASS</entry>
<entry>Get the name and type of table which table inherites attributes
from.</entry>
</row>
<row>
<entry>CUBRID_SCH_SUBCLASS</entry>
<entry>Get the name and type of table which inherites attributes from
this table.</entry>
</row>
<row>
<entry>CUBRID_SCH_CONSTRAINT</entry>
<entry>Get the table constraints.</entry>
</row>
<row>
<entry>CUBRID_SCH_TRIGGER</entry>
<entry>Get the table triggers.</entry>
</row>
<row>
<entry>CUBRID_SCH_CLASS_PRIVILEGE</entry>
<entry>Get the privilege information of table.</entry>
</row>
<row>
<entry>CUBRID_SCH_ATTR_PRIVILEGE</entry>
<entry>Get the privilege information of column.</entry>
</row>
<row>
<entry>CUBRID_SCH_DIRECT_SUPER_CLASS</entry>
<entry>Get the direct super table of table.</entry>
</row>
<row>
<entry>CUBRID_SCH_PRIMARY_KEY</entry>
<entry>Get the table primary key.</entry>
</row>
<row>
<entry>CUBRID_SCH_IMPORTED_KEYS</entry>
<entry>Get imported keys of table.</entry>
</row>
<row>
<entry>CUBRID_SCH_EXPORTED_KEYS</entry>
<entry>Get exported keys of table.</entry>
</row>
<row>
<entry>CUBRID_SCH_CROSS_REFERENCE</entry>
<entry>Get reference relationship of tow tables.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when reporting errors. They can be
returned from <function>cubrid_error_code_facility</function>.
<table>
<title>CUBRID error facility code</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_FACILITY_DBMS</entry>
<entry>The error occured in CUBRID dbms.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CAS</entry>
<entry>The error occured in CUBRID broker cas.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CCI</entry>
<entry>The error occured in CUBRID cci.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CLIENT</entry>
<entry>The error occured in CUBRID PHP client.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</appendix>
<!-- Keep this comment at the end of the file