From 9f68d649a777c9487411ba8ebf9c505c7c3c5055 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 10 Jun 2007 19:06:37 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237358 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../ingres-ii/functions/ingres-autocommit.xml | 68 +-- .../ingres-ii/functions/ingres-close.xml | 64 +-- .../ingres-ii/functions/ingres-commit.xml | 66 +-- .../ingres-ii/functions/ingres-connect.xml | 409 +++++++++--------- .../ingres-ii/functions/ingres-cursor.xml | 74 ++-- .../ingres-ii/functions/ingres-errno.xml | 84 ++-- .../ingres-ii/functions/ingres-error.xml | 84 ++-- .../functions/ingres-errsqlstate.xml | 86 ++-- .../functions/ingres-fetch-array.xml | 126 +++--- .../functions/ingres-fetch-object.xml | 106 ++--- .../ingres-ii/functions/ingres-fetch-row.xml | 80 ++-- .../functions/ingres-field-length.xml | 66 +-- .../ingres-ii/functions/ingres-field-name.xml | 62 +-- .../functions/ingres-field-nullable.xml | 62 +-- .../functions/ingres-field-precision.xml | 66 +-- .../functions/ingres-field-scale.xml | 66 +-- .../ingres-ii/functions/ingres-field-type.xml | 78 ++-- .../ingres-ii/functions/ingres-num-fields.xml | 54 ++- .../ingres-ii/functions/ingres-num-rows.xml | 92 ++-- .../ingres-ii/functions/ingres-pconnect.xml | 80 ++-- .../ingres-ii/functions/ingres-query.xml | 192 ++++---- .../ingres-ii/functions/ingres-rollback.xml | 58 +-- 22 files changed, 1056 insertions(+), 1067 deletions(-) diff --git a/reference/ingres-ii/functions/ingres-autocommit.xml b/reference/ingres-ii/functions/ingres-autocommit.xml index d0c429f8a9..ee69975b43 100644 --- a/reference/ingres-ii/functions/ingres-autocommit.xml +++ b/reference/ingres-ii/functions/ingres-autocommit.xml @@ -1,39 +1,39 @@ - + - - - ingres_autocommit - Switch autocommit on or off - - - Description - - boolingres_autocommit - resourcelink - - - ingres_autocommit is called before opening a - transaction (before the first call to - ingres_query or just after a call to - ingres_rollback or - ingres_commit) to switch the - "autocommit" mode of the server on or off (when the script begins - the autocommit mode is off). - - - When the autocommit mode is on, every query is automatically - committed by the server, as if ingres_commit - was called after every call to ingres_query. - - - See also - ingres_query, - ingres_rollback, and - ingres_commit. - - - + + + ingres_autocommit + Switch autocommit on or off + + + Description + + boolingres_autocommit + resourcelink + + + ingres_autocommit is called before opening a + transaction (before the first call to + ingres_query or just after a call to + ingres_rollback or + ingres_commit) to switch the + "autocommit" mode of the server on or off (when the script begins + the autocommit mode is off). + + + When the autocommit mode is on, every query is automatically + committed by the server, as if ingres_commit + was called after every call to ingres_query. + + + See also + ingres_query, + ingres_rollback, and + ingres_commit. + + + + - - - ingres_close - Close an Ingres II database connection - - - Description - - boolingres_close - resourcelink - - - Returns &true; on success, or &false; on failure. - - - ingres_close closes the connection to - the Ingres server that's associated with the specified link. - If the link parameter isn't - specified, the last opened link is used. - - - ingres_close isn't usually necessary, as it - won't close persistent connections and all non-persistent connections - are automatically closed at the end of the script. - - See also - ingres_connect and - ingres_pconnect. - - - + + + ingres_close + Close an Ingres II database connection + + + Description + + boolingres_close + resourcelink + + + Returns &true; on success, or &false; on failure. + + + ingres_close closes the connection to + the Ingres server that's associated with the specified link. + If the link parameter isn't + specified, the last opened link is used. + + + ingres_close isn't usually necessary, as it + won't close persistent connections and all non-persistent connections + are automatically closed at the end of the script. + + See also + ingres_connect and + ingres_pconnect. + + + + - - - ingres_commit - Commit a transaction - - - Description - - boolingres_commit - resourcelink - - - ingres_commit commits the currently open - transaction, making all changes made to the database permanent. - - - This closes the transaction. A new one can be open by sending a - query with ingres_query. - - - You can also have the server commit automatically after every - query by calling ingres_autocommit before - opening the transaction. - - - See also - ingres_query, - ingres_rollback, and - ingres_autocommit. - - - + + + ingres_commit + Commit a transaction + + + Description + + boolingres_commit + resourcelink + + + ingres_commit commits the currently open + transaction, making all changes made to the database permanent. + + + This closes the transaction. A new one can be open by sending a + query with ingres_query. + + + You can also have the server commit automatically after every + query by calling ingres_autocommit before + opening the transaction. + + + See also + ingres_query, + ingres_rollback, and + ingres_autocommit. + + + + - - - ingres_connect - - Open a connection to an Ingres database - - - - Description - - resourceingres_connect - stringdatabase - stringusername - stringpassword - arrayoptions - - - Returns a Ingres link resource on success, or &false; on - failure. - - - ingres_connect opens a connection with the - Ingres database designated by database, - which follows the syntax - [node_id::]dbname[/svr_class]. - - - If some parameters are missing, ingres_connect - uses the values in &php.ini; for - ingres.default_database, - ingres.default_user and - ingres.default_password. - - - The connection is closed when the script ends or when - ingres_close is called on this link. - - - All the other ingres functions use the last opened link as a - 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 - + + + ingres_connect + Open a connection to an Ingres database + + + Description + + resourceingres_connect + stringdatabase + stringusername + stringpassword + arrayoptions + + + Returns a Ingres link resource on success, or &false; on + failure. + + + ingres_connect opens a connection with the + Ingres database designated by database, + which follows the syntax + [node_id::]dbname[/svr_class]. + + + If some parameters are missing, ingres_connect + uses the values in &php.ini; for + ingres.default_database, + ingres.default_user and + ingres.default_password. + + + The connection is closed when the script ends or when + ingres_close is called on this link. + + + All the other ingres functions use the last opened link as a + 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 + ]]> - - - - - <function>ingres_connect</function> example using default link - - + + + + + <function>ingres_connect</function> example using default link + + ]]> - - - - See also - ingres_pconnect and - ingres_close. - - - + + + + + See also + ingres_pconnect and + ingres_close. + + + + - - - ingres_cursor - Gets a cursor name for a given link resource - - - Description - - stringingres_cursor - resourcelink - - - Returns an string containing the active cursor name. If no cursor is - active then NULL is returned. - - - If a link resource is passed to - ingres_cursor it returns the cursor name recorded - for the link. If no link is passed then - ingres_cursor returns the cursor name asssociated - with the default link. - - - - <function>ingres_cursor</function> example - + + + ingres_cursor + Gets a cursor name for a given link resource + + + Description + + stringingres_cursor + resourcelink + + + Returns an string containing the active cursor name. If no cursor is + active then NULL is returned. + + + If a link resource is passed to + ingres_cursor it returns the cursor name recorded + for the link. If no link is passed then + ingres_cursor returns the cursor name asssociated + with the default link. + + + + <function>ingres_cursor</function> example + ]]> - - - - - See also - ingres_prepare and - ingres_execute. - - - + + + + + See also + ingres_prepare and + ingres_execute. + + + + - - - ingres_errno - Gets the last ingres error number generated - - - Description - - intingres_errno - resourcelink - - - Returns an integer containing the last error number. If no error was - reported 0 is returned. - - - If a link resource is passed to - ingres_errno it returns the last error recorded for - the link. If no link is passed then ingres_errno - returns the last error reported using the default link. - - - The function, ingres_errno, should always be called - after executing a database query. Calling another function before - ingres_errno is called, will reset or change any - error code from the last Ingres function call. - - - - <function>ingres_errno</function> example - + + + ingres_errno + Gets the last ingres error number generated + + + Description + + intingres_errno + resourcelink + + + Returns an integer containing the last error number. If no error was + reported 0 is returned. + + + If a link resource is passed to + ingres_errno it returns the last error recorded for + the link. If no link is passed then ingres_errno + returns the last error reported using the default link. + + + The function, ingres_errno, should always be called + after executing a database query. Calling another function before + ingres_errno is called, will reset or change any + error code from the last Ingres function call. + + + + <function>ingres_errno</function> example + ]]> - - - - - See also - ingres_error and - ingres_errsqlstate. - - - + + + + + See also + ingres_error and + ingres_errsqlstate. + + + + - - - ingres_error - Gets a meaningful error message for the last error generated - - - Description - - stringingres_error - resourcelink - - - Returns a string containing the last error, or NULL if no error has - occurred. - - - If a link resource is passed to - ingres_error it returns the last error recorded for - the link. If no link is passed then ingres_error - returns the last error reported using the default link. - - - The function, ingres_error, should always be called - after executing any database query. Calling another function before - ingres_error is called will reset or change any - error message from the last Ingres function call. - - - - <function>ingres_error</function> example - + + + ingres_error + Gets a meaningful error message for the last error generated + + + Description + + stringingres_error + resourcelink + + + Returns a string containing the last error, or NULL if no error has + occurred. + + + If a link resource is passed to + ingres_error it returns the last error recorded for + the link. If no link is passed then ingres_error + returns the last error reported using the default link. + + + The function, ingres_error, should always be called + after executing any database query. Calling another function before + ingres_error is called will reset or change any + error message from the last Ingres function call. + + + + <function>ingres_error</function> example + ]]> - - - - - See also - ingres_errno and - ingres_errsqlstate. - - - + + + + + See also + ingres_errno and + ingres_errsqlstate. + + + + - - - ingres_errsqlstate - Gets the last SQLSTATE error code generated - - - Description - - stringingres_errsqlstate - resourcelink - - - Returns a string containing the last SQLSTATE, or NULL if no error has - occurred. - - - If a link resource is passed to - ingres_errsqlstate it returns the last error - recorded for the link. If no link is passed then - ingres_errsqlstate returns the last error reported - using the default link. - - - The function, ingres_errsqlstate, should always be - called after executing any database query. Calling another function - before ingres_errsqlstate is called will reset or - change any error message from the last Ingres function call. - - - - <function>ingres_errsqlstate</function> example - + + + ingres_errsqlstate + Gets the last SQLSTATE error code generated + + + Description + + stringingres_errsqlstate + resourcelink + + + Returns a string containing the last SQLSTATE, or NULL if no error has + occurred. + + + If a link resource is passed to + ingres_errsqlstate it returns the last error + recorded for the link. If no link is passed then + ingres_errsqlstate returns the last error reported + using the default link. + + + The function, ingres_errsqlstate, should always be + called after executing any database query. Calling another function + before ingres_errsqlstate is called will reset or + change any error message from the last Ingres function call. + + + + <function>ingres_errsqlstate</function> example + ]]> - - - - - See also - ingres_errno and - ingres_errsqlstate. - - - + + + + + See also + ingres_errno and + ingres_errsqlstate. + + + + - - - ingres_fetch_array - Fetch a row of result into an array - - - Description - - arrayingres_fetch_array - intresult_type - resourcelink - - - ingres_fetch_array Returns an array that - corresponds to the fetched row, or &false; if there are no more - rows. - - - This function is an extended version of - ingres_fetch_row. In addition to storing - the data in the numeric indices of the result array, it also - stores the data in associative indices, using the field names as - keys. - - - If two or more columns of the result have the same field names, - the last column will take precedence. To access the other - column(s) of the same name, you must use the numeric index of the - column or make an alias for the column. - - + + + ingres_fetch_array + Fetch a row of result into an array + + + Description + + arrayingres_fetch_array + intresult_type + resourcelink + + + ingres_fetch_array Returns an array that + corresponds to the fetched row, or &false; if there are no more + rows. + + + This function is an extended version of + ingres_fetch_row. In addition to storing + the data in the numeric indices of the result array, it also + stores the data in associative indices, using the field names as + keys. + + + If two or more columns of the result have the same field names, + the last column will take precedence. To access the other + column(s) of the same name, you must use the numeric index of the + column or make an alias for the column. + + ]]> - - - - - result_type can be INGRES_NUM for - enumerated array, INGRES_ASSOC for associative array, or - INGRES_BOTH (default). - - - Speed-wise, the function is identical to - ingres_fetch_object, and almost as quick as - ingres_fetch_row (the difference is - insignificant). - - - - <function>ingres_fetch_array</function> example - + + + + + result_type can be INGRES_NUM for + enumerated array, INGRES_ASSOC for associative array, or + INGRES_BOTH (default). + + + Speed-wise, the function is identical to + ingres_fetch_object, and almost as quick as + ingres_fetch_row (the difference is + insignificant). + + + + <function>ingres_fetch_array</function> example + ]]> - - - - - See also - ingres_query, - ingres_num_fields, - ingres_field_name, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + + + See also + ingres_query, + ingres_num_fields, + ingres_field_name, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_fetch_object - Fetch a row of result into an object - - - Description - - objectingres_fetch_object - intresult_type - resourcelink - - - ingres_fetch_object Returns an object that - corresponds to the fetched row, or &false; if there are no more - rows. - - - This function is similar to - ingres_fetch_array, with one difference - an - object is returned, instead of an array. Indirectly, that means - that you can only access the data by the field names, and not by - their offsets (numbers are illegal property names). - - - The optional argument result_type is a - constant and can take the following values: INGRES_ASSOC, - INGRES_NUM, and INGRES_BOTH. - - - Speed-wise, the function is identical to - ingres_fetch_array, and almost as quick as - ingres_fetch_row (the difference is - insignificant). - - - - <function>ingres_fetch_object</function> example - + + + ingres_fetch_object + Fetch a row of result into an object + + + Description + + objectingres_fetch_object + intresult_type + resourcelink + + + ingres_fetch_object Returns an object that + corresponds to the fetched row, or &false; if there are no more + rows. + + + This function is similar to + ingres_fetch_array, with one difference - an + object is returned, instead of an array. Indirectly, that means + that you can only access the data by the field names, and not by + their offsets (numbers are illegal property names). + + + The optional argument result_type is a + constant and can take the following values: INGRES_ASSOC, + INGRES_NUM, and INGRES_BOTH. + + + Speed-wise, the function is identical to + ingres_fetch_array, and almost as quick as + ingres_fetch_row (the difference is + insignificant). + + + + <function>ingres_fetch_object</function> example + ]]> - - - - - See also - ingres_query, - ingres_num_fields, - ingres_field_name, - ingres_fetch_array, and - ingres_fetch_row. - - - + + + + + See also + ingres_query, + ingres_num_fields, + ingres_field_name, + ingres_fetch_array, and + ingres_fetch_row. + + + + - - - ingres_fetch_row - - Fetch a row of result into an enumerated array - - - - Description - - arrayingres_fetch_row - resourcelink - - - ingres_fetch_row returns an array that - corresponds to the fetched row, or &false; if there are no more - rows. Each result column is stored in an array offset, starting - at offset 1. - - - Subsequent call to ingres_fetch_row would - return the next row in the result set, or &false; if there are no - more rows. - - - - <function>ingres_fetch_row</function> example - + + + ingres_fetch_row + Fetch a row of result into an enumerated array + + + Description + + arrayingres_fetch_row + resourcelink + + + ingres_fetch_row returns an array that + corresponds to the fetched row, or &false; if there are no more + rows. Each result column is stored in an array offset, starting + at offset 1. + + + Subsequent call to ingres_fetch_row would + return the next row in the result set, or &false; if there are no + more rows. + + + + <function>ingres_fetch_row</function> example + ]]> - - - - - See also - ingres_num_fields, - ingres_query, - ingres_fetch_array, and - ingres_fetch_object. - - - + + + + + See also + ingres_num_fields, + ingres_query, + ingres_fetch_array, and + ingres_fetch_object. + + + + - - - ingres_field_length - Get the length of a field - - - Description - - intingres_field_length - intindex - resourcelink - - - ingres_field_length returns the length of a - field. This is the number of bytes used by the server to store - the field. For detailed information, see the Ingres/OpenAPI User - Guide - Appendix C. - - - index is the number of the field and must - be between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_field_length + Get the length of a field + + + Description + + intingres_field_length + intindex + resourcelink + + + ingres_field_length returns the length of a + field. This is the number of bytes used by the server to store + the field. For detailed information, see the Ingres/OpenAPI User + Guide - Appendix C. + + + index is the number of the field and must + be between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_field_name - Get the name of a field in a query result - - - Description - - stringingres_field_name - intindex - resourcelink - - - ingres_field_name returns the name of a field - in a query result, or &false; on failure. - - - index is the number of the field and must be - between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object and - ingres_fetch_row. - - - + + + ingres_field_name + Get the name of a field in a query result + + + Description + + stringingres_field_name + intindex + resourcelink + + + ingres_field_name returns the name of a field + in a query result, or &false; on failure. + + + index is the number of the field and must be + between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object and + ingres_fetch_row. + + + + - - - ingres_field_nullable - Test if a field is nullable - - - Description - - boolingres_field_nullable - intindex - resourcelink - - - ingres_field_nullable returns &true; if the - field can be set to the &null; value and &false; if it can't. - - - index is the number of the field and must - be between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_field_nullable + Test if a field is nullable + + + Description + + boolingres_field_nullable + intindex + resourcelink + + + ingres_field_nullable returns &true; if the + field can be set to the &null; value and &false; if it can't. + + + index is the number of the field and must + be between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_field_precision - Get the precision of a field - - - Description - - intingres_field_precision - intindex - resourcelink - - - ingres_field_precision returns the precision - of a field. This value is used only for decimal, float and money - SQL data types. For detailed information, see the Ingres/OpenAPI - User Guide - Appendix C. - - - index is the number of the field and must - be between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_field_precision + Get the precision of a field + + + Description + + intingres_field_precision + intindex + resourcelink + + + ingres_field_precision returns the precision + of a field. This value is used only for decimal, float and money + SQL data types. For detailed information, see the Ingres/OpenAPI + User Guide - Appendix C. + + + index is the number of the field and must + be between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_field_scale - Get the scale of a field - - - Description - - intingres_field_scale - intindex - resourcelink - - - ingres_field_scale returns the scale of a - field. This value is used only for the decimal SQL data - type. For detailed information, see the Ingres/OpenAPI User Guide - - Appendix C. - - - index is the number of the field and must - be between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_field_scale + Get the scale of a field + + + Description + + intingres_field_scale + intindex + resourcelink + + + ingres_field_scale returns the scale of a + field. This value is used only for the decimal SQL data + type. For detailed information, see the Ingres/OpenAPI User Guide + - Appendix C. + + + index is the number of the field and must + be between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_field_type - - Get the type of a field in a query result - - - - Description - - stringingres_field_type - intindex - resourcelink - - - ingres_field_type returns the type of a - field in a query result, or &false; on failure. Examples of - types returned are "IIAPI_BYTE_TYPE", "IIAPI_CHA_TYPE", - "IIAPI_DTE_TYPE", "IIAPI_FLT_TYPE", "IIAPI_INT_TYPE", - "IIAPI_VCH_TYPE". Some of these types can map to more than one - SQL type depending on the length of the field (see - ingres_field_length). For example - "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed - information, see the Ingres/OpenAPI User Guide - Appendix C. - - - index is the number of the field and must - be between 1 and the value given by - ingres_num_fields. - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_field_type + Get the type of a field in a query result + + + Description + + stringingres_field_type + intindex + resourcelink + + + ingres_field_type returns the type of a + field in a query result, or &false; on failure. Examples of + types returned are "IIAPI_BYTE_TYPE", "IIAPI_CHA_TYPE", + "IIAPI_DTE_TYPE", "IIAPI_FLT_TYPE", "IIAPI_INT_TYPE", + "IIAPI_VCH_TYPE". Some of these types can map to more than one + SQL type depending on the length of the field (see + ingres_field_length). For example + "IIAPI_FLT_TYPE" can be a float4 or a float8. For detailed + information, see the Ingres/OpenAPI User Guide - Appendix C. + + + index is the number of the field and must + be between 1 and the value given by + ingres_num_fields. + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_num_fields - - Get the number of fields returned by the last query - - - - Description - - intingres_num_fields - resourcelink - - - ingres_num_fields returns the number of - fields in the results returned by the Ingres server after a call - to ingres_query - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_num_fields + Get the number of fields returned by the last query + + + Description + + intingres_num_fields + resourcelink + + + ingres_num_fields returns the number of + fields in the results returned by the Ingres server after a call + to ingres_query + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_num_rows - - Get the number of rows affected or returned by the last query - - - - Description - - intingres_num_rows - resourcelink - - - For delete, insert or update queries, - ingres_num_rows returns the number of rows - affected by the query. For other queries, - ingres_num_rows returns the number of rows - in the query's result. - - - - - This function is mainly meant to get the number of rows - modified in the database. If this function is called before - using ingres_fetch_array, - ingres_fetch_object or - ingres_fetch_row the server will delete - the result's data and the script won't be able to get them. - - - You should instead retrieve the result's data using one of - these fetch functions in a loop until it returns &false;, - indicating that no more results are available. - - - - - See also - ingres_query, - ingres_fetch_array, - ingres_fetch_object, and - ingres_fetch_row. - - - + + + ingres_num_rows + Get the number of rows affected or returned by the last query + + + Description + + intingres_num_rows + resourcelink + + + For delete, insert or update queries, + ingres_num_rows returns the number of rows + affected by the query. For other queries, + ingres_num_rows returns the number of rows + in the query's result. + + + + + This function is mainly meant to get the number of rows + modified in the database. If this function is called before + using ingres_fetch_array, + ingres_fetch_object or + ingres_fetch_row the server will delete + the result's data and the script won't be able to get them. + + + You should instead retrieve the result's data using one of + these fetch functions in a loop until it returns &false;, + indicating that no more results are available. + + + + + See also + ingres_query, + ingres_fetch_array, + ingres_fetch_object, and + ingres_fetch_row. + + + + - - - ingres_pconnect - - Open a persistent connection to an Ingres II database - - - - Description - - resourceingres_pconnect - stringdatabase - stringusername - stringpassword - - - Returns a Ingres II link resource on success, or &false; on - failure. - - - See ingres_connect for parameters details - and examples. There are only 2 differences between - ingres_pconnect and - ingres_connect : First, when connecting, the - function will first try to find a (persistent) link that's - already opened with the same parameters. If one is found, an - identifier for it will be returned instead of opening a new - connection. Second, the connection to the Ingres server will not - be closed when the execution of the script ends. Instead, the - link will remain open for future use - (ingres_close will not close links - established by ingres_pconnect). This type - of link is therefore called 'persistent'. - - See also - ingres_connect and - ingres_close. - - - + + + ingres_pconnect + Open a persistent connection to an Ingres II database + + + Description + + resourceingres_pconnect + stringdatabase + stringusername + stringpassword + + + Returns a Ingres II link resource on success, or &false; on + failure. + + + See ingres_connect for parameters details + and examples. There are only 2 differences between + ingres_pconnect and + ingres_connect : First, when connecting, the + function will first try to find a (persistent) link that's + already opened with the same parameters. If one is found, an + identifier for it will be returned instead of opening a new + connection. Second, the connection to the Ingres server will not + be closed when the execution of the script ends. Instead, the + link will remain open for future use + (ingres_close will not close links + established by ingres_pconnect). This type + of link is therefore called 'persistent'. + + See also + ingres_connect and + ingres_close. + + + + - - - ingres_query - Send a SQL query to Ingres II - - - Description - - boolingres_query - stringquery - resourcelink - - - Returns &true; on success, or &false; on failure. - - - ingres_query sends the given - query to the Ingres server. This query - must be a valid SQL query (see the Ingres SQL reference guide) - - - The query becomes part of the currently open transaction. If - there is no open transaction, ingres_query - opens a new transaction. To close the transaction, you can either - call ingres_commit to commit the changes - made to the database or ingres_rollback to - cancel these changes. When the script ends, any open transaction - is rolled back (by calling - ingres_rollback). You can also use - ingres_autocommit before opening a new - transaction to have every SQL query immediately committed. - - - Some types of SQL queries can't be sent with this function: - - - - close (see ingres_close) - - - - - commit (see ingres_commit) - - - - - connect (see ingres_connect) - - - - - disconnect (see ingres_close) - - - - get dbevent - - - prepare to commit - - - - rollback (see ingres_rollback) - - - savepoint - - - set autocommit (see ingres_autocommit) - - - - all cursor related queries are unsupported - - - - - - <function>ingres_query</function> example - + + + ingres_query + Send a SQL query to Ingres II + + + Description + + boolingres_query + stringquery + resourcelink + + + Returns &true; on success, or &false; on failure. + + + ingres_query sends the given + query to the Ingres server. This query + must be a valid SQL query (see the Ingres SQL reference guide) + + + The query becomes part of the currently open transaction. If + there is no open transaction, ingres_query + opens a new transaction. To close the transaction, you can either + call ingres_commit to commit the changes + made to the database or ingres_rollback to + cancel these changes. When the script ends, any open transaction + is rolled back (by calling + ingres_rollback). You can also use + ingres_autocommit before opening a new + transaction to have every SQL query immediately committed. + + + Some types of SQL queries can't be sent with this function: + + + + close (see ingres_close) + + + + + commit (see ingres_commit) + + + + + connect (see ingres_connect) + + + + + disconnect (see ingres_close) + + + + get dbevent + + + prepare to commit + + + + rollback (see ingres_rollback) + + + savepoint + + + set autocommit (see ingres_autocommit) + + + + all cursor related queries are unsupported + + + + + + <function>ingres_query</function> example + ]]> - - - - - See also - ingres_fetch_array, - ingres_fetch_object, - ingres_fetch_row, - ingres_commit, - ingres_rollback, and - ingres_autocommit. - - - + + + + + See also + ingres_fetch_array, + ingres_fetch_object, + ingres_fetch_row, + ingres_commit, + ingres_rollback, and + ingres_autocommit. + + + + - - - ingres_rollback - Roll back a transaction - - - Description - - boolingres_rollback - resourcelink - - - ingres_rollback rolls back the currently - open transaction, actually canceling all changes made to the - database during the transaction. - - - This closes the transaction. A new one can be open by sending a - query with ingres_query. - - - See also - ingres_query, - ingres_commit, and - ingres_autocommit. - - - + + + ingres_rollback + Roll back a transaction + + + Description + + boolingres_rollback + resourcelink + + + ingres_rollback rolls back the currently + open transaction, actually canceling all changes made to the + database during the transaction. + + + This closes the transaction. A new one can be open by sending a + query with ingres_query. + + + See also + ingres_query, + ingres_commit, and + ingres_autocommit. + + +