1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="cubrid.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
&extension.constants;
<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>
<row>
<entry>CUBRID_EXEC_QUERY_ALL</entry>
<entry>Execute the query in synchronous mode. This flag must be set
when executing multiple SQL statements.</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_OBJECT</entry>
<entry>Get query result an object.</entry>
</row>
<row>
<entry>CUBRID_LOB</entry>
<entry>The constant CUBRID_LOB can be used when you want to operate the
lob object. It can be passed to <function>cubrid_fetch</function>,
<function>cubrid_fetch_row</function>,
<function>cubrid_fetch_array</function>,
<function>cubrid_fetch_assoc</function> and
<function>cubrid_fetch_object</function>.</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. This flag has been removed from 8.4.1.</entry>
</row>
<row>
<entry>CUBRID_NO_MORE_DATA</entry>
<entry>Returned value of <function>cubrid_move_cursor</function>
function in case of failure. This flag has been removed from 8.4.1.</entry>
</row>
<row>
<entry>CUBRID_CURSOR_ERROR</entry>
<entry>Returned value of <function>cubrid_move_cursor</function>
function in case of failure. This flag has been removed from 8.4.1.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when setting the auto-commit mode for
the database connection. They can be passed to
<function>cubrid_set_autocommit</function> or returned by
<function>cubrid_get_autocommit</function>.
<table>
<title>CUBRID auto-commit mode flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_AUTOCOMMIT_TRUE</entry>
<entry>Enable the auto-commit mode.</entry>
</row>
<row>
<entry>CUBRID_AUTOCOMMIT_FALSE</entry>
<entry>Disable the auto-commit mode.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when setting the database parameter.
They can be passed to <function>cubrid_set_db_parameter</function>.
<table>
<title>CUBRID parameter flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>CUBRID_PARAM_ISOLATION_LEVEL</entry>
<entry>Transaction isolation level for the database connection.</entry>
</row>
<row>
<entry>CUBRID_PARAM_LOCK_TIMEOUT</entry>
<entry>Transaction timeout in seconds.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The following constants can be used when setting the transaction isolation
level. They can be passed to <function>cubrid_set_db_parameter</function>
or returned by <function>cubrid_get_db_parameter</function>.
<table>
<title>CUBRID isolation level flags</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>TRAN_COMMIT_CLASS_UNCOMMIT_INSTANCE</entry>
<entry>The lowest isolation level (1). A dirty, non-repeatable or
phantom read may occur for the tuple and a non-repeatable read may
occur for the table as well.</entry>
</row>
<row>
<entry>TRAN_COMMIT_CLASS_COMMIT_INSTANCE</entry>
<entry>A relatively low isolation level (2). A dirty read does not
occur, but non-repeatable or phantom read may occur.</entry>
</row>
<row>
<entry>TRAN_REP_CLASS_UNCOMMIT_INSTANCE</entry>
<entry>The default isolation of CUBRID (3). A dirty, non-repeatable or
phantom read may occur for the tuple, but repeatable read is ensured
for the table.</entry>
</row>
<row>
<entry>TRAN_REP_CLASS_COMMIT_INSTANCE</entry>
<entry>A relatively low isolation level (4). A dirty read does not
occur, but non-repeatable or phantom read may.</entry>
</row>
<row>
<entry>TRAN_REP_CLASS_REP_INSTANCE</entry>
<entry>A relatively high isolation level (5). A dirty or non-repeatable
read does not occur, but a phantom read may.</entry>
</row>
<row>
<entry>TRAN_SERIALIZABLE</entry>
<entry>The highest isolation level (6). Problems concerning concurrency
(e.g. dirty read, non-repeatable read, phantom read, etc.) do not
occur.</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 two 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 occurred in CUBRID dbms.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CAS</entry>
<entry>The error occurred in CUBRID broker cas.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CCI</entry>
<entry>The error occurred in CUBRID cci.</entry>
</row>
<row>
<entry>CUBRID_FACILITY_CLIENT</entry>
<entry>The error occurred in CUBRID PHP client.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|