From bece7e027234d800dae8156d45da37c545c65dfe Mon Sep 17 00:00:00 2001 From: Grant Croker Date: Wed, 25 Oct 2006 17:34:56 +0000 Subject: [PATCH] Update for new functionality git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@222371 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ingres-ii/constants.xml | 98 +++++++++++- .../ingres-ii/functions/ingres-connect.xml | 151 +++++++++++++++++- reference/ingres-ii/ini.xml | 20 ++- reference/ingres-ii/reference.xml | 48 +++++- 4 files changed, 308 insertions(+), 9 deletions(-) diff --git a/reference/ingres-ii/constants.xml b/reference/ingres-ii/constants.xml index b6c4064423..f191db87b6 100644 --- a/reference/ingres-ii/constants.xml +++ b/reference/ingres-ii/constants.xml @@ -1,5 +1,5 @@ - +
&reftitle.constants; &extension.constants; @@ -204,6 +204,102 @@ + + + INGRES_STRUCTURE_BTREE + (integer) + + + + Specifies the default table or index structure to BTREE when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_CBTREE + (integer) + + + + Specifies the default table or index structure to COMPRESSED BTREE when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_HASH + (integer) + + + + Specifies the default table or index structure to HASH when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_CHASH + (integer) + + + + Specifies the default table or index structure to COMPRESSED BTREE when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_HEAP + (integer) + + + + Specifies the default table structure to HEAP when used in combination with the + table_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_CHEAP + (integer) + + + + Specifies the default table structure to COMPRESSED HEAP when used in combination with the + table_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_ISAM + (integer) + + + + Specifies the default table or index structure to ISAM when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + + + + + INGRES_STRUCTURE_CISAM + (integer) + + + + Specifies the default table or index structure to COMPRESSED ISAM when used in combination with the + table_structure or index_structure option when connecting. Available since version 1.4.0 of the PECL extension. + + +
diff --git a/reference/ingres-ii/functions/ingres-connect.xml b/reference/ingres-ii/functions/ingres-connect.xml index 8d8820978e..0617d91cad 100644 --- a/reference/ingres-ii/functions/ingres-connect.xml +++ b/reference/ingres-ii/functions/ingres-connect.xml @@ -1,11 +1,11 @@ - + ingres_connect - Open a connection to an Ingres II database + Open a connection to an Ingres database @@ -15,9 +15,10 @@ stringdatabase stringusername stringpassword + arrayoptions - Returns a Ingres II link resource on success, or &false; on + Returns a Ingres link resource on success, or &false; on failure. @@ -30,7 +31,7 @@ If some parameters are missing, ingres_connect uses the values in &php.ini; for ingres.default_database, - ingres.default_user, and + ingres.default_user and ingres.default_password. @@ -42,6 +43,148 @@ default, so you need to store the returned value only if you use more than one link at a time. + + ingres_connect options + + + + + Option name + Description + + + + + date_century_boundary + The threshold by which a 2 digit year is determined to be in + the current century or in the next century. Equivalent to II_DATE_CENTURY_BOUNDARY. + + + group + Speficfies the group ID of the user, equivalent to the '-G' + flag + + + role + The role ID of the application. If a role password is + required, the parameter value should be specified as "role/password" + + + effective_user + The ingres user account being impersonated, equivalent to the '-u' flag + + + dbms_password + The internal database password for the user connecting to Ingres + + + table_structure + The default structure for new tables. Valid values for + table_structure are: + + INGRES_STRUCTURE_BTREE + INGRES_STRUCTURE_HASH + INGRES_STRUCTURE_HEAP + INGRES_STRUCTURE_ISAM + INGRES_STRUCTURE_CBTREE + INGRES_STRUCTURE_CISAM + INGRES_STRUCTURE_CHASH + INGRES_STRUCTURE_CHEAP + + + + + index_structure + The default structure for new secondary indexes. Valid values + for index_structure are: + + INGRES_STRUCTURE_CBTREE + INGRES_STRUCTURE_CISAM + INGRES_STRUCTURE_CHASH + INGRES_STRUCTURE_BTREE + INGRES_STRUCTURE_HASH + INGRES_STRUCTURE_ISAM + + + + + login_local + Determines how the connection user ID and password are + used when a VNODE is included in the target database string. + If set to TRUE, the user ID and password are used to locally access + the VNODE and the VNODE login information is used to establish the DBMS + connection. If set to FALSE, the process user ID is used to access + the VNODE and the connection user ID and password are used in place + of the VNODE login information to establish the DBMS connection. + This parameter is ignored if no VNODE is included in the target + database string. The default is FALSE. + + + timezone + Controls the timezone of the session. If not set it will + default the the value defined by II_TIMEZONE_NAME. If + II_TIMEZONE_NAME is not defined the NA-PACIFIC (GMT-8 with Daylight + Savings) is used. + + + date_format + Sets the allowable input and output format for Ingres dates. + Defaults to the value defined by II_DATE_FORMAT. If II_DATE_FORMAT is + not set the default date format is US, e.g. mm/dd/yy. Valid values + for date_format are: + + INGRES_DATE_DMY + INGRES_DATE_FINISH + INGRES_DATE_GERMAN + INGRES_DATE_ISO + INGRES_DATE_ISO4 + INGRES_DATE_MDY + INGRES_DATE_MULTINATIONAL + INGRES_DATE_MULTINATIONAL4 + INGRES_DATE_YMD + INGRES_DATE_US + + + + + decimal_separator + The character identifier for decimal data + + + money_lort + Leading or trailing currency sign. Valid values for money_lort + are: + + INGRES_MONEY_LEADING + INGRES_MONEY_TRAILING + + + + + money_sign + The currency symbol to be used with the MONEY datatype + + + money_precision + The precision of the MONEY datatype + + + float4_precision + Precision of the FLOAT4 datatype + + + float8_precision + Precision of the FLOAT8 data + + + blob_segment_length + The amount of data in bytes to fetch at a time when retrieving + BLOB/CLOB data, defaults to 4096 bytes when not explicitly set. + + + + + <function>ingres_connect</function> example diff --git a/reference/ingres-ii/ini.xml b/reference/ingres-ii/ini.xml index 747071b78e..dd9eaf107a 100644 --- a/reference/ingres-ii/ini.xml +++ b/reference/ingres-ii/ini.xml @@ -1,5 +1,5 @@ - +
&reftitle.runtime; &extension.runtime; @@ -70,6 +70,24 @@ PHP_INI_ALL Available since version 1.2.0 of the PECL extension. + + ingres.trace_connect + "0" + PHP_INI_ALL + Available since version 1.3.1 of the PECL extension. + + + ingres.timeout + "-1" + PHP_INI_ALL + Available since version 1.3.1 of the PECL extension. + + + ingres.array_index_start + "1" + PHP_INI_ALL + Available since version 1.3.1 of the PECL extension. + diff --git a/reference/ingres-ii/reference.xml b/reference/ingres-ii/reference.xml index 552cd2eb94..a5bf8f2b4e 100644 --- a/reference/ingres-ii/reference.xml +++ b/reference/ingres-ii/reference.xml @@ -1,5 +1,5 @@ - + @@ -30,8 +30,8 @@
&reftitle.required; - To compile PHP with Ingres support, you need the Open API library - and header files included with Ingres II. + To compile PHP with Ingres support, you need the Ingres OpenAPI library + and header files.
@@ -46,6 +46,48 @@ &reference.ingres-ii.constants; +
+ &reftitle.examples; + + This simple example shows how to connect, execute a query, print + resulting rows and disconnect from an Ingres database. + + Simple Ingres Example + +\n"; +while ($iirelation = ingres_fetch_object($link)) { + echo "\t\n"; + echo "\t\t" . $iirelation->relid . "\n"; + echo "\t\t" . $iirelation->relowner . "\n"; + echo "\t\n"; +} +echo "\n"; + +// Commit transaction +ingres_commit($link); +// Closing connection +ingres_close($link); +?> +]]> + + + +
&reference.ingres-ii.functions;