From 7199b5a058227937bc1af06fd0b5d7244595edc7 Mon Sep 17 00:00:00 2001 From: Richard Quadling Date: Mon, 27 Nov 2006 10:40:45 +0000 Subject: [PATCH] WS, preparation for the new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@223956 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/uodbc/functions/odbc-autocommit.xml | 70 +++--- reference/uodbc/functions/odbc-binmode.xml | 216 +++++++++--------- reference/uodbc/functions/odbc-close-all.xml | 48 ++-- reference/uodbc/functions/odbc-close.xml | 50 ++-- .../uodbc/functions/odbc-columnprivileges.xml | 91 ++++---- reference/uodbc/functions/odbc-columns.xml | 110 +++++---- reference/uodbc/functions/odbc-commit.xml | 36 +-- reference/uodbc/functions/odbc-connect.xml | 136 +++++------ reference/uodbc/functions/odbc-cursor.xml | 34 +-- .../uodbc/functions/odbc-data-source.xml | 52 ++--- reference/uodbc/functions/odbc-do.xml | 38 +-- reference/uodbc/functions/odbc-error.xml | 56 ++--- reference/uodbc/functions/odbc-errormsg.xml | 58 ++--- reference/uodbc/functions/odbc-exec.xml | 64 +++--- reference/uodbc/functions/odbc-execute.xml | 130 +++++------ reference/uodbc/functions/odbc-fetch-into.xml | 162 ++++++------- reference/uodbc/functions/odbc-fetch-row.xml | 86 +++---- reference/uodbc/functions/odbc-field-len.xml | 48 ++-- reference/uodbc/functions/odbc-field-name.xml | 42 ++-- reference/uodbc/functions/odbc-field-num.xml | 42 ++-- .../uodbc/functions/odbc-field-precision.xml | 48 ++-- .../uodbc/functions/odbc-field-scale.xml | 40 ++-- reference/uodbc/functions/odbc-field-type.xml | 40 ++-- .../uodbc/functions/odbc-foreignkeys.xml | 130 +++++------ .../uodbc/functions/odbc-free-result.xml | 72 +++--- .../uodbc/functions/odbc-gettypeinfo.xml | 91 ++++---- .../uodbc/functions/odbc-longreadlen.xml | 54 ++--- .../uodbc/functions/odbc-next-result.xml | 18 +- reference/uodbc/functions/odbc-num-fields.xml | 40 ++-- reference/uodbc/functions/odbc-num-rows.xml | 54 ++--- reference/uodbc/functions/odbc-pconnect.xml | 82 +++---- reference/uodbc/functions/odbc-prepare.xml | 78 +++---- .../uodbc/functions/odbc-primarykeys.xml | 69 +++--- .../uodbc/functions/odbc-procedurecolumns.xml | 102 ++++----- reference/uodbc/functions/odbc-procedures.xml | 80 ++++--- reference/uodbc/functions/odbc-result-all.xml | 52 ++--- reference/uodbc/functions/odbc-result.xml | 102 ++++----- reference/uodbc/functions/odbc-rollback.xml | 40 ++-- reference/uodbc/functions/odbc-setoption.xml | 126 +++++----- .../uodbc/functions/odbc-specialcolumns.xml | 106 +++++---- reference/uodbc/functions/odbc-statistics.xml | 90 ++++---- .../uodbc/functions/odbc-tableprivileges.xml | 88 ++++--- reference/uodbc/functions/odbc-tables.xml | 188 ++++++++------- 43 files changed, 1664 insertions(+), 1695 deletions(-) diff --git a/reference/uodbc/functions/odbc-autocommit.xml b/reference/uodbc/functions/odbc-autocommit.xml index c8cf08cb9b..c06b46c0ab 100644 --- a/reference/uodbc/functions/odbc-autocommit.xml +++ b/reference/uodbc/functions/odbc-autocommit.xml @@ -1,40 +1,40 @@ - + - - - odbc_autocommit - Toggle autocommit behaviour - - - Description - - mixedodbc_autocommit - resourceconnection_id - boolOnOff - - - Without the OnOff parameter, this function - returns auto-commit status for - connection_id. Non-zero is returned if - auto-commit is on, 0 if it is off, or &false; if an error occurs. - - - If OnOff is &true;, auto-commit is enabled, - if it is &false; auto-commit is disabled. Returns &true; on success, - &false; on failure. - - - By default, auto-commit is on for a connection. Disabling - auto-commit is equivalent with starting a transaction. - - - See also - odbc_commit and - odbc_rollback. - - - + + + odbc_autocommit + Toggle autocommit behaviour + + + Description + + mixedodbc_autocommit + resourceconnection_id + boolOnOff + + + Without the OnOff parameter, this function + returns auto-commit status for + connection_id. Non-zero is returned if + auto-commit is on, 0 if it is off, or &false; if an error occurs. + + + If OnOff is &true;, auto-commit is enabled, + if it is &false; auto-commit is disabled. Returns &true; on success, + &false; on failure. + + + By default, auto-commit is on for a connection. Disabling + auto-commit is equivalent with starting a transaction. + + + See also + odbc_commit and + odbc_rollback. + + + + - - - odbc_binmode - Handling of binary column data - - - Description - - boolodbc_binmode - resourceresult_id - intmode - - - (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY) - - - - - ODBC_BINMODE_PASSTHRU: Passthru BINARY data - - - - - ODBC_BINMODE_RETURN: Return as is - - - - - ODBC_BINMODE_CONVERT: Convert to char and return - - - - - When binary SQL data is converted to character C data, each byte - (8 bits) of source data is represented as two ASCII characters. - These characters are the ASCII character representation of the - number in its hexadecimal form. For example, a binary 00000001 is - converted to "01" and a binary 11111111 is - converted to "FF". - - LONGVARBINARY handling - - - - binmode - longreadlen - result - - - - - ODBC_BINMODE_PASSTHRU - 0 - passthru - - - ODBC_BINMODE_RETURN - 0 - passthru - - - ODBC_BINMODE_CONVERT - 0 - passthru - - - ODBC_BINMODE_PASSTHRU - 0 - passthru - - - ODBC_BINMODE_PASSTHRU - >0 - passthru - - - ODBC_BINMODE_RETURN - >0 - return as is - - - ODBC_BINMODE_CONVERT - >0 - return as char - - - -
- - - If odbc_fetch_into is used, passthru means - that an empty string is returned for these columns. - - - If result_id is 0, the - settings apply as default for new results. - - - Default for longreadlen is 4096 and binmode - defaults to ODBC_BINMODE_RETURN. Handling - of binary long columns is also affected by - odbc_longreadlen - - - - - + + + odbc_binmode + Handling of binary column data + + + Description + + boolodbc_binmode + resourceresult_id + intmode + + + (ODBC SQL types affected: BINARY, VARBINARY, LONGVARBINARY) + + + + + ODBC_BINMODE_PASSTHRU: Passthru BINARY data + + + + + ODBC_BINMODE_RETURN: Return as is + + + + + ODBC_BINMODE_CONVERT: Convert to char and return + + + + + When binary SQL data is converted to character C data, each byte + (8 bits) of source data is represented as two ASCII characters. + These characters are the ASCII character representation of the + number in its hexadecimal form. For example, a binary 00000001 is + converted to "01" and a binary 11111111 is + converted to "FF". + + LONGVARBINARY handling + + + + binmode + longreadlen + result + + + + + ODBC_BINMODE_PASSTHRU + 0 + passthru + + + ODBC_BINMODE_RETURN + 0 + passthru + + + ODBC_BINMODE_CONVERT + 0 + passthru + + + ODBC_BINMODE_PASSTHRU + 0 + passthru + + + ODBC_BINMODE_PASSTHRU + >0 + passthru + + + ODBC_BINMODE_RETURN + >0 + return as is + + + ODBC_BINMODE_CONVERT + >0 + return as char + + + +
+ + + If odbc_fetch_into is used, passthru means + that an empty string is returned for these columns. + + + If result_id is 0, the + settings apply as default for new results. + + + Default for longreadlen is 4096 and binmode + defaults to ODBC_BINMODE_RETURN. Handling + of binary long columns is also affected by + odbc_longreadlen + + + + + + - - - odbc_close_all - Close all ODBC connections - - - Description - - voidodbc_close_all - - - - odbc_close_all will close down all - connections to database server(s). - - - This function will fail if there are open transactions on a - connection. This connection will remain open in this case. - - - - - + + + odbc_close_all + Close all ODBC connections + + + Description + + voidodbc_close_all + + + + odbc_close_all will close down all + connections to database server(s). + + + This function will fail if there are open transactions on a + connection. This connection will remain open in this case. + + + + + + - - - odbc_close - Close an ODBC connection - - - Description - - voidodbc_close - resourceconnection_id - - - odbc_close will close down the connection to - the database server associated with the given connection - identifier. - - - This function will fail if there are open transactions on this - connection. The connection will remain open in this case. - - - - - + + + odbc_close + Close an ODBC connection + + + Description + + voidodbc_close + resourceconnection_id + + + odbc_close will close down the connection to + the database server associated with the given connection + identifier. + + + This function will fail if there are open transactions on this + connection. The connection will remain open in this case. + + + + + + - - - odbc_columnprivileges - - Returns a result identifier that can be used to fetch a list of - columns and associated privileges - - - - Description - - resourceodbc_columnprivileges - resourceconnection_id - stringqualifier - stringowner - stringtable_name - stringcolumn_name - - - Lists columns and associated privileges for the given table. - Returns an ODBC result identifier or &false; on - failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_OWNER - TABLE_NAME - GRANTOR - GRANTEE - PRIVILEGE - IS_GRANTABLE - - - - The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and - TABLE_NAME. - - - The column_name argument accepts search - patterns ('%' to match zero or more characters and '_' to match a - single character). - - - + + + odbc_columnprivileges + Returns a result identifier that can be used to fetch a list of columns and associated privileges + + + Description + + resourceodbc_columnprivileges + resourceconnection_id + stringqualifier + stringowner + stringtable_name + stringcolumn_name + + + Lists columns and associated privileges for the given table. + Returns an ODBC result identifier or &false; on + failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_OWNER + TABLE_NAME + GRANTOR + GRANTEE + PRIVILEGE + IS_GRANTABLE + + + + The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and + TABLE_NAME. + + + The column_name argument accepts search + patterns ('%' to match zero or more characters and '_' to match a + single character). + + + + - - - odbc_columns - - Lists the column names in specified tables - - - - Description - - resourceodbc_columns - resourceconnection_id - stringqualifier - stringschema - stringtable_name - stringcolumn_name - - - Lists all columns in the requested range. Returns an ODBC result - identifier containing the information or &false; on failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_SCHEM - TABLE_NAME - COLUMN_NAME - DATA_TYPE - TYPE_NAME - PRECISION - LENGTH - SCALE - RADIX - NULLABLE - REMARKS - - - - The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and - TABLE_NAME. - - - The schema, - table_name and - column_name arguments accept search - patterns ('%' to match zero or more characters and '_' to match a - single character). - - - See also odbc_columnprivileges to retrieve - associated privileges. - - - + + + odbc_columns + Lists the column names in specified tables + + + Description + + resourceodbc_columns + resourceconnection_id + stringqualifier + stringschema + stringtable_name + stringcolumn_name + + + Lists all columns in the requested range. Returns an ODBC result + identifier containing the information or &false; on failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_SCHEM + TABLE_NAME + COLUMN_NAME + DATA_TYPE + TYPE_NAME + PRECISION + LENGTH + SCALE + RADIX + NULLABLE + REMARKS + + + + The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and + TABLE_NAME. + + + The schema, + table_name and + column_name arguments accept search + patterns ('%' to match zero or more characters and '_' to match a + single character). + + + See also odbc_columnprivileges to retrieve + associated privileges. + + + + - - - odbc_commit - Commit an ODBC transaction - - - Description - - boolodbc_commit - resourceconnection_id - - - odbc_commit commits all pending transactions - on the connection_id connection. &return.success; - - - + + + odbc_commit + Commit an ODBC transaction + + + Description + + boolodbc_commit + resourceconnection_id + + + odbc_commit commits all pending transactions + on the connection_id connection. &return.success; + + + + - - - odbc_connect - Connect to a datasource - - - Description - - resourceodbc_connect - stringdsn - stringuser - stringpassword - intcursor_type - - - Returns an ODBC connection id or 0 (&false;) on - error. - - - The connection id returned by this functions is needed by other - ODBC functions. You can have multiple connections open at once as long as - they either use different db or different credentials. - The optional fourth parameter sets the type of cursor to be used - for this connection. This parameter is not normally needed, but - can be useful for working around problems with some ODBC drivers. - - - With some ODBC drivers, executing a complex stored procedure may - fail with an error similar to: "Cannot open a cursor on a stored - procedure that has anything other than a single select statement - in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some - drivers don't support the optional row_number parameter in - odbc_fetch_row. SQL_CUR_USE_ODBC might help - in that case, too. - - - The following constants are defined for cursortype: - - - - - - SQL_CUR_USE_IF_NEEDED - - - - - SQL_CUR_USE_ODBC - - - - - SQL_CUR_USE_DRIVER - - - - - SQL_CUR_DEFAULT - - - - - For persistent connections see - odbc_pconnect. - - - + + + odbc_connect + Connect to a datasource + + + Description + + resourceodbc_connect + stringdsn + stringuser + stringpassword + intcursor_type + + + Returns an ODBC connection id or 0 (&false;) on + error. + + + The connection id returned by this functions is needed by other + ODBC functions. You can have multiple connections open at once as long as + they either use different db or different credentials. + The optional fourth parameter sets the type of cursor to be used + for this connection. This parameter is not normally needed, but + can be useful for working around problems with some ODBC drivers. + + + With some ODBC drivers, executing a complex stored procedure may + fail with an error similar to: "Cannot open a cursor on a stored + procedure that has anything other than a single select statement + in it". Using SQL_CUR_USE_ODBC may avoid that error. Also, some + drivers don't support the optional row_number parameter in + odbc_fetch_row. SQL_CUR_USE_ODBC might help + in that case, too. + + + The following constants are defined for cursortype: + + + + + + SQL_CUR_USE_IF_NEEDED + + + + + SQL_CUR_USE_ODBC + + + + + SQL_CUR_USE_DRIVER + + + + + SQL_CUR_DEFAULT + + + + + For persistent connections see + odbc_pconnect. + + + + - - - odbc_cursor - Get cursorname - - - Description - - stringodbc_cursor - resourceresult_id - - - odbc_cursor will return a cursorname for the given result_id. - - - + + + odbc_cursor + Get cursorname + + + Description + + stringodbc_cursor + resourceresult_id + + + odbc_cursor will return a cursorname for the given result_id. + + + - - - odbc_data_source - Returns information about a current connection - - - Description - - arrayodbc_data_source - resourceconnection_id - intfetch_type - - - Returns &false; on error, and an array upon success. - - - This function will return the list of available DNS (after calling it - several times). The - connection_id is required to be a valid ODBC - connection. The fetch_type can be one of two - constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST the - first time this function is called, thereafter use the SQL_FETCH_NEXT. - - - + + + + odbc_data_source + Returns information about a current connection + + + Description + + arrayodbc_data_source + resourceconnection_id + intfetch_type + + + Returns &false; on error, and an array upon success. + + + This function will return the list of available DNS (after calling it + several times). The + connection_id is required to be a valid ODBC + connection. The fetch_type can be one of two + constant types: SQL_FETCH_FIRST, SQL_FETCH_NEXT. Use SQL_FETCH_FIRST the + first time this function is called, thereafter use the SQL_FETCH_NEXT. + + + + - - - odbc_do - Synonym for odbc_exec - - - Description - - resourceodbc_do - resourceconn_id - stringquery - - - odbc_do will execute a query on the given - connection. - - - + + + odbc_do + Synonym for odbc_exec + + + Description + + resourceodbc_do + resourceconn_id + stringquery + + + odbc_do will execute a query on the given + connection. + + + + - - - odbc_error - Get the last error code - - - Description - - stringodbc_error - resourceconnection_id - - - Returns a six-digit ODBC state, or an empty string if there - has been no errors. If connection_id is - specified, the last state of that connection is returned, else the - last state of any connection is returned. - - - This function returns meaningful value only if last odbc query failed - (i.e. odbc_exec returned &false;). - - - See also: odbc_errormsg and - odbc_exec. - - - + + + odbc_error + Get the last error code + + + Description + + stringodbc_error + resourceconnection_id + + + Returns a six-digit ODBC state, or an empty string if there + has been no errors. If connection_id is + specified, the last state of that connection is returned, else the + last state of any connection is returned. + + + This function returns meaningful value only if last odbc query failed + (i.e. odbc_exec returned &false;). + + + See also: odbc_errormsg and + odbc_exec. + + + + - - - odbc_errormsg - Get the last error message - - - Description - - stringodbc_errormsg - resourceconnection_id - - - Returns a string containing the last ODBC error message, or an empty - string if there has been no errors. If - connection_id is specified, the last state of - that connection is returned, else the last state of any connection - is returned. - - - This function returns meaningful value only if last odbc query failed - (i.e. odbc_exec returned &false;). - - - See also: odbc_error and - odbc_exec. - - - + + + odbc_errormsg + Get the last error message + + + Description + + stringodbc_errormsg + resourceconnection_id + + + Returns a string containing the last ODBC error message, or an empty + string if there has been no errors. If + connection_id is specified, the last state of + that connection is returned, else the last state of any connection + is returned. + + + This function returns meaningful value only if last odbc query failed + (i.e. odbc_exec returned &false;). + + + See also: odbc_error and + odbc_exec. + + + + - - - odbc_exec - Prepare and execute a SQL statement - - - Description - - resourceodbc_exec - resourceconnection_id - stringquery_string - intflags - - - Returns &false; on error. Returns an ODBC - result identifier if the SQL command was executed successfully. - - - odbc_exec will send an SQL statement to the - database server specified by - connection_id. This parameter must be a - valid identifier returned by odbc_connect or - odbc_pconnect. - - - See also: odbc_prepare and - odbc_execute for multiple execution of SQL - statements. - - - + + + odbc_exec + Prepare and execute a SQL statement + + + Description + + resourceodbc_exec + resourceconnection_id + stringquery_string + intflags + + + Returns &false; on error. Returns an ODBC + result identifier if the SQL command was executed successfully. + + + odbc_exec will send an SQL statement to the + database server specified by + connection_id. This parameter must be a + valid identifier returned by odbc_connect or + odbc_pconnect. + + + See also: odbc_prepare and + odbc_execute for multiple execution of SQL + statements. + + + + - - - odbc_execute - Execute a prepared statement - - - Description - - boolodbc_execute - resourceresult_id - arrayparameters_array - - - Executes a statement prepared with - odbc_prepare.&return.success; The array - parameters_array only needs to be given if - you really have parameters in your statement. - - - Parameters in parameter_array will be - substituted for placeholders in the prepared statement in order. - Elements of this array will be converted to strings by calling this - function. - - - Any parameters in parameter_array which - start and end with single quotes will be taken as the name of a - file to read and send to the database server as the data for the - appropriate placeholder. - - - - As of PHP 4.1.1, this file reading functionality has the - following restrictions: - - - - File reading is not subject to any - &safemode; or open-basedir - restrictions. This is fixed in PHP 4.2.0. - - - - - Remote files - are not supported. - - - - - If you wish to store a string which actually begins and ends - with single quotes, you must escape them or add a space or - other non-single-quote character to the beginning or end of - the parameter, which will prevent the parameter's being taken - as a file name. If this is not an option, then you must use - another mechanism to store the string, such as executing the - query directly with odbc_exec). - - - - - - - + + + odbc_execute + Execute a prepared statement + + + Description + + boolodbc_execute + resourceresult_id + arrayparameters_array + + + Executes a statement prepared with + odbc_prepare.&return.success; The array + parameters_array only needs to be given if + you really have parameters in your statement. + + + Parameters in parameter_array will be + substituted for placeholders in the prepared statement in order. + Elements of this array will be converted to strings by calling this + function. + + + Any parameters in parameter_array which + start and end with single quotes will be taken as the name of a + file to read and send to the database server as the data for the + appropriate placeholder. + + + + As of PHP 4.1.1, this file reading functionality has the + following restrictions: + + + + File reading is not subject to any + &safemode; or open-basedir + restrictions. This is fixed in PHP 4.2.0. + + + + + Remote files + are not supported. + + + + + If you wish to store a string which actually begins and ends + with single quotes, you must escape them or add a space or + other non-single-quote character to the beginning or end of + the parameter, which will prevent the parameter's being taken + as a file name. If this is not an option, then you must use + another mechanism to store the string, such as executing the + query directly with odbc_exec). + + + + + + + + - - - odbc_fetch_into - Fetch one result row into array - - - Description - - intodbc_fetch_into - resourceresult_id - arrayresult_array - intrownumber - - - boolodbc_fetch_into - resourceresult_id - intrownumber - arrayresult_array - - - Returns the number of columns in the result; - &false; on error. - result_array must be passed by reference, - but it can be of any type since it will be converted to type - array. The array will contain the column values starting at array - index 0. - - - As of PHP 4.0.5 the result_array does not - need to be passed by reference any longer. - - - As of PHP 4.0.6 the rownumber cannot be - passed as a constant, but rather as a variable. - - - As of PHP 4.2.0 the result_array and - rownumber have been swapped. This allows the - rownumber to be a constant again. This change will also be the last one - to this function. - - - - <function>odbc_fetch_into</function> pre 4.0.6 example - + + + odbc_fetch_into + Fetch one result row into array + + + Description + + intodbc_fetch_into + resourceresult_id + arrayresult_array + intrownumber + + + boolodbc_fetch_into + resourceresult_id + intrownumber + arrayresult_array + + + Returns the number of columns in the result; + &false; on error. + result_array must be passed by reference, + but it can be of any type since it will be converted to type + array. The array will contain the column values starting at array + index 0. + + + As of PHP 4.0.5 the result_array does not + need to be passed by reference any longer. + + + As of PHP 4.0.6 the rownumber cannot be + passed as a constant, but rather as a variable. + + + As of PHP 4.2.0 the result_array and + rownumber have been swapped. This allows the + rownumber to be a constant again. This change will also be the last one + to this function. + + + + <function>odbc_fetch_into</function> pre 4.0.6 example + ]]> - - - or - - + + + or + + ]]> - - - - - - <function>odbc_fetch_into</function> 4.0.6 example - + + + + + + <function>odbc_fetch_into</function> 4.0.6 example + ]]> - - - or - - + + + or + + ]]> - - - - - - <function>odbc_fetch_into</function> 4.2.0 example - + + + + + + <function>odbc_fetch_into</function> 4.2.0 example + ]]> - - - or - - + + + or + + ]]> - - - - - + + + + + + - - - odbc_fetch_row - Fetch a row - - - Description - - boolodbc_fetch_row - resourceresult_id - introw_number - - - If odbc_fetch_row was successful (there was a - row), &true; is returned. If there are no more - rows, &false; is returned. - - - odbc_fetch_row fetches a row of the data - that was returned by odbc_do / - odbc_exec. After - odbc_fetch_row is called, the fields of that - row can be accessed with odbc_result. - - - If row_number is not specified, - odbc_fetch_row will try to fetch the next - row in the result set. Calls to - odbc_fetch_row with and without - row_number can be mixed. - - - To step through the result more than once, you can call - odbc_fetch_row with - row_number 1, and then continue doing - odbc_fetch_row without - row_number to review the result. If a - driver doesn't support fetching rows by number, the - row_number parameter is ignored. - - - + + + odbc_fetch_row + Fetch a row + + + Description + + boolodbc_fetch_row + resourceresult_id + introw_number + + + If odbc_fetch_row was successful (there was a + row), &true; is returned. If there are no more + rows, &false; is returned. + + + odbc_fetch_row fetches a row of the data + that was returned by odbc_do / + odbc_exec. After + odbc_fetch_row is called, the fields of that + row can be accessed with odbc_result. + + + If row_number is not specified, + odbc_fetch_row will try to fetch the next + row in the result set. Calls to + odbc_fetch_row with and without + row_number can be mixed. + + + To step through the result more than once, you can call + odbc_fetch_row with + row_number 1, and then continue doing + odbc_fetch_row without + row_number to review the result. If a + driver doesn't support fetching rows by number, the + row_number parameter is ignored. + + + + - - - odbc_field_len - Get the length (precision) of a field - - - Description - - intodbc_field_len - resourceresult_id - intfield_number - - - odbc_field_len will return the length of - the field referenced by number in the given ODBC result - identifier. Field numbering starts at 1. - - - See also: odbc_field_scale to get the scale of a - floating point number. - - - + + + odbc_field_len + Get the length (precision) of a field + + + Description + + intodbc_field_len + resourceresult_id + intfield_number + + + odbc_field_len will return the length of + the field referenced by number in the given ODBC result + identifier. Field numbering starts at 1. + + + See also: odbc_field_scale to get the scale of a + floating point number. + + + + - - - odbc_field_name - Get the columnname - - - Description - - stringodbc_field_name - resourceresult_id - intfield_number - - - odbc_field_name will return the name of the - field occupying the given column number in the given ODBC result - identifier. Field numbering starts at 1. - &false; is returned on error. - - - + + + odbc_field_name + Get the columnname + + + Description + + stringodbc_field_name + resourceresult_id + intfield_number + + + odbc_field_name will return the name of the + field occupying the given column number in the given ODBC result + identifier. Field numbering starts at 1. + &false; is returned on error. + + + + - - - odbc_field_num - Return column number - - - Description - - intodbc_field_num - resourceresult_id - stringfield_name - - - odbc_field_num will return the number of the - column slot that corresponds to the named field in the given ODBC - result identifier. Field numbering starts at 1. - &false; is returned on error. - - - + + + odbc_field_num + Return column number + + + Description + + intodbc_field_num + resourceresult_id + stringfield_name + + + odbc_field_num will return the number of the + column slot that corresponds to the named field in the given ODBC + result identifier. Field numbering starts at 1. + &false; is returned on error. + + + + - - - odbc_field_precision - Synonym for odbc_field_len - - - Description - - intodbc_field_precision - resourceresult_id - intfield_number - - - odbc_field_precision will return the precision - of the field referenced by number in the given ODBC result - identifier. - - - See also: odbc_field_scale to get the scale of a - floating point number. - - - + + + odbc_field_precision + Synonym for odbc_field_len + + + Description + + intodbc_field_precision + resourceresult_id + intfield_number + + + odbc_field_precision will return the precision + of the field referenced by number in the given ODBC result + identifier. + + + See also: odbc_field_scale to get the scale of a + floating point number. + + + + - - - odbc_field_scale - Get the scale of a field - - - Description - - intodbc_field_scale - resourceresult_id - intfield_number - - - odbc_field_scale will return the scale - of the field referenced by number in the given ODBC result - identifier. - - - + + + odbc_field_scale + Get the scale of a field + + + Description + + intodbc_field_scale + resourceresult_id + intfield_number + + + odbc_field_scale will return the scale + of the field referenced by number in the given ODBC result + identifier. + + + + - - - odbc_field_type - Datatype of a field - - - Description - - stringodbc_field_type - resourceresult_id - intfield_number - - - odbc_field_type will return the SQL type of - the field referenced by number in the given ODBC result - identifier. Field numbering starts at 1. - - - + + + odbc_field_type + Datatype of a field + + + Description + + stringodbc_field_type + resourceresult_id + intfield_number + + + odbc_field_type will return the SQL type of + the field referenced by number in the given ODBC result + identifier. Field numbering starts at 1. + + + + - - - odbc_foreignkeys - - Returns a list of foreign keys in the specified table or a list - of foreign keys in other tables that refer to the primary key in - the specified table - - - - Description - - resourceodbc_foreignkeys - resourceconnection_id - stringpk_qualifier - stringpk_owner - stringpk_table - stringfk_qualifier - stringfk_owner - stringfk_table - - - odbc_foreignkeys retrieves information about - foreign keys. Returns an ODBC result identifier or - &false; on failure. - - - The result set has the following columns: - - PKTABLE_QUALIFIER - PKTABLE_OWNER - PKTABLE_NAME - PKCOLUMN_NAME - FKTABLE_QUALIFIER - FKTABLE_OWNER - FKTABLE_NAME - FKCOLUMN_NAME - KEY_SEQ - UPDATE_RULE - DELETE_RULE - FK_NAME - PK_NAME - - - - If pk_table contains a table name, - odbc_foreignkeys returns a result set - containing the primary key of the specified table and all of the - foreign keys that refer to it. - - - If fk_table contains a table name, - odbc_foreignkeys returns a result set - containing all of the foreign keys in the specified table and the - primary keys (in other tables) to which they refer. - - - If both pk_table and - fk_table contain table names, - odbc_foreignkeys returns the foreign keys in - the table specified in fk_table that refer - to the primary key of the table specified in - pk_table. This should be one key at most. - - - + + + odbc_foreignkeys + Returns a list of foreign keys in the specified table or a list of foreign keys in other tables that refer to the primary key in the specified table + + + Description + + resourceodbc_foreignkeys + resourceconnection_id + stringpk_qualifier + stringpk_owner + stringpk_table + stringfk_qualifier + stringfk_owner + stringfk_table + + + odbc_foreignkeys retrieves information about + foreign keys. Returns an ODBC result identifier or + &false; on failure. + + + The result set has the following columns: + + PKTABLE_QUALIFIER + PKTABLE_OWNER + PKTABLE_NAME + PKCOLUMN_NAME + FKTABLE_QUALIFIER + FKTABLE_OWNER + FKTABLE_NAME + FKCOLUMN_NAME + KEY_SEQ + UPDATE_RULE + DELETE_RULE + FK_NAME + PK_NAME + + + + If pk_table contains a table name, + odbc_foreignkeys returns a result set + containing the primary key of the specified table and all of the + foreign keys that refer to it. + + + If fk_table contains a table name, + odbc_foreignkeys returns a result set + containing all of the foreign keys in the specified table and the + primary keys (in other tables) to which they refer. + + + If both pk_table and + fk_table contain table names, + odbc_foreignkeys returns the foreign keys in + the table specified in fk_table that refer + to the primary key of the table specified in + pk_table. This should be one key at most. + + + + - - - odbc_free_result - Free resources associated with a result - - - Description - - boolodbc_free_result - resourceresult_id - - - Always returns &true;. - - - odbc_free_result only needs to be called if - you are worried about using too much memory while your script is - running. All result memory will automatically be freed when the - script is finished. But, if you are sure you are not going to - need the result data anymore in a script, you may call - odbc_free_result, and the memory associated - with result_id will be freed. - - - - - If auto-commit is disabled (see - odbc_autocommit) and you call - odbc_free_result before committing, all - pending transactions are rolled back. - - - - - + + + odbc_free_result + Free resources associated with a result + + + Description + + boolodbc_free_result + resourceresult_id + + + Always returns &true;. + + + odbc_free_result only needs to be called if + you are worried about using too much memory while your script is + running. All result memory will automatically be freed when the + script is finished. But, if you are sure you are not going to + need the result data anymore in a script, you may call + odbc_free_result, and the memory associated + with result_id will be freed. + + + + + If auto-commit is disabled (see + odbc_autocommit) and you call + odbc_free_result before committing, all + pending transactions are rolled back. + + + + + + - - - odbc_gettypeinfo - - Returns a result identifier containing information about data - types supported by the data source - - - - Description - - resourceodbc_gettypeinfo - resourceconnection_id - intdata_type - - - Retrieves information about data types supported by the data - source. Returns an ODBC result identifier or - &false; on failure. The optional argument - data_type can be used to restrict the - information to a single data type. - - - The result set has the following columns: - - TYPE_NAME - DATA_TYPE - PRECISION - LITERAL_PREFIX - LITERAL_SUFFIX - CREATE_PARAMS - NULLABLE - CASE_SENSITIVE - SEARCHABLE - UNSIGNED_ATTRIBUTE - MONEY - AUTO_INCREMENT - LOCAL_TYPE_NAME - MINIMUM_SCALE - MAXIMUM_SCALE - - - The result set is ordered by DATA_TYPE and TYPE_NAME. - - - + + + odbc_gettypeinfo + Returns a result identifier containing information about data types supported by the data source + + + Description + + resourceodbc_gettypeinfo + resourceconnection_id + intdata_type + + + Retrieves information about data types supported by the data + source. Returns an ODBC result identifier or + &false; on failure. The optional argument + data_type can be used to restrict the + information to a single data type. + + + The result set has the following columns: + + TYPE_NAME + DATA_TYPE + PRECISION + LITERAL_PREFIX + LITERAL_SUFFIX + CREATE_PARAMS + NULLABLE + CASE_SENSITIVE + SEARCHABLE + UNSIGNED_ATTRIBUTE + MONEY + AUTO_INCREMENT + LOCAL_TYPE_NAME + MINIMUM_SCALE + MAXIMUM_SCALE + + + The result set is ordered by DATA_TYPE and TYPE_NAME. + + + + - - - odbc_longreadlen - Handling of LONG columns - - - Description - - boolodbc_longreadlen - resourceresult_id - intlength - - - (ODBC SQL types affected: LONG, LONGVARBINARY) The number of - bytes returned to PHP is controlled by the parameter length. If it - is set to 0, Long column data is passed through to the - client. - - - - Handling of LONGVARBINARY columns is also affected by - odbc_binmode. - - - - + + + odbc_longreadlen + Handling of LONG columns + + + Description + + boolodbc_longreadlen + resourceresult_id + intlength + + + (ODBC SQL types affected: LONG, LONGVARBINARY) The number of + bytes returned to PHP is controlled by the parameter length. If it + is set to 0, Long column data is passed through to the + client. + + + + Handling of LONGVARBINARY columns is also affected by + odbc_binmode. + + + + + odbc_next_result - - Checks if multiple results are available - + Checks if multiple results are available Description - - boolodbc_next_result - resourceresult_id - + + boolodbc_next_result + resourceresult_id + odbc_next_result returns &true; if there are more result sets - available as well as allowing access to the next result set via - odbc_fetch_array, odbc_fetch_row, + available as well as allowing access to the next result set via + odbc_fetch_array, odbc_fetch_row, odbc_result, etc. diff --git a/reference/uodbc/functions/odbc-num-fields.xml b/reference/uodbc/functions/odbc-num-fields.xml index 885367e036..fba7cf7f0f 100644 --- a/reference/uodbc/functions/odbc-num-fields.xml +++ b/reference/uodbc/functions/odbc-num-fields.xml @@ -1,25 +1,25 @@ - + - - - odbc_num_fields - Number of columns in a result - - - Description - - intodbc_num_fields - resourceresult_id - - - odbc_num_fields will return the number of - fields (columns) in an ODBC result. This function will return -1 - on error. The argument is a valid result identifier returned by - odbc_exec. - - - + + + odbc_num_fields + Number of columns in a result + + + Description + + intodbc_num_fields + resourceresult_id + + + odbc_num_fields will return the number of + fields (columns) in an ODBC result. This function will return -1 + on error. The argument is a valid result identifier returned by + odbc_exec. + + + + - - - odbc_num_rows - Number of rows in a result - - - Description - - intodbc_num_rows - resourceresult_id - - - odbc_num_rows will return the number of rows - in an ODBC result. This function will return -1 on error. For - INSERT, UPDATE and DELETE statements - odbc_num_rows returns the number of rows - affected. For a SELECT clause this can be - the number of rows available. - - - Note: Using odbc_num_rows to determine the - number of rows available after a SELECT will return -1 with many - drivers. - - - + + + odbc_num_rows + Number of rows in a result + + + Description + + intodbc_num_rows + resourceresult_id + + + odbc_num_rows will return the number of rows + in an ODBC result. This function will return -1 on error. For + INSERT, UPDATE and DELETE statements + odbc_num_rows returns the number of rows + affected. For a SELECT clause this can be + the number of rows available. + + + Note: Using odbc_num_rows to determine the + number of rows available after a SELECT will return -1 with many + drivers. + + + + - - - odbc_pconnect - Open a persistent database connection - - - Description - - resourceodbc_pconnect - stringdsn - stringuser - stringpassword - intcursor_type - - - Returns an ODBC connection id or 0 (&false;) on - error. This function is much like - odbc_connect, except that the connection is - not really closed when the script has finished. Future requests - for a connection with the same dsn, - user, password - combination (via odbc_connect and - odbc_pconnect) can reuse the persistent - connection. - - - - - Persistent connections have no effect if PHP is used as a CGI - program. - - - - - For information about the optional cursor_type parameter see the - odbc_connect function. For more information - on persistent connections, refer to the PHP FAQ. - - - + + + odbc_pconnect + Open a persistent database connection + + + Description + + resourceodbc_pconnect + stringdsn + stringuser + stringpassword + intcursor_type + + + Returns an ODBC connection id or 0 (&false;) on + error. This function is much like + odbc_connect, except that the connection is + not really closed when the script has finished. Future requests + for a connection with the same dsn, + user, password + combination (via odbc_connect and + odbc_pconnect) can reuse the persistent + connection. + + + + + Persistent connections have no effect if PHP is used as a CGI + program. + + + + + For information about the optional cursor_type parameter see the + odbc_connect function. For more information + on persistent connections, refer to the PHP FAQ. + + + + - - - odbc_prepare - Prepares a statement for execution - - - Description - - resourceodbc_prepare - resourceconnection_id - stringquery_string - - - Returns &false; on error. - - - Returns an ODBC result identifier if the SQL command was prepared - successfully. The result identifier can be used later to execute - the statement with odbc_execute. - - - Some databases (such as IBM DB2, MS SQL Server, and Oracle) support - stored procedures that accept parameters of type IN, INOUT, and OUT as - defined by the ODBC specification. However, the Unified ODBC driver - currently only supports parameters of type IN to stored procedures. - - - In the following code, $res will only be - valid if all three parameters to myproc are IN parameters: - + + + odbc_prepare + Prepares a statement for execution + + + Description + + resourceodbc_prepare + resourceconnection_id + stringquery_string + + + Returns &false; on error. + + + Returns an ODBC result identifier if the SQL command was prepared + successfully. The result identifier can be used later to execute + the statement with odbc_execute. + + + Some databases (such as IBM DB2, MS SQL Server, and Oracle) support + stored procedures that accept parameters of type IN, INOUT, and OUT as + defined by the ODBC specification. However, the Unified ODBC driver + currently only supports parameters of type IN to stored procedures. + + + In the following code, $res will only be + valid if all three parameters to myproc are IN parameters: + ]]> - - If you need to call a stored procedure using INOUT or OUT parameters, - the recommended workaround is to use a native extension for your database - (for example, mssql for MS SQL Server, - or oci8 for Oracle). - + + If you need to call a stored procedure using INOUT or OUT parameters, + the recommended workaround is to use a native extension for your database + (for example, mssql for MS SQL Server, + or oci8 for Oracle). + - - + + + - - - odbc_primarykeys - - Returns a result identifier that can be used to fetch the column - names that comprise the primary key for a table - - - - Description - - resourceodbc_primarykeys - resourceconnection_id - stringqualifier - stringowner - stringtable - - - Returns the column names that comprise the primary key for a - table. Returns an ODBC result identifier or - &false; on failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_OWNER - TABLE_NAME - COLUMN_NAME - KEY_SEQ - PK_NAME - - - - + + + odbc_primarykeys + Returns a result identifier that can be used to fetch the column names that comprise the primary key for a table + + + Description + + resourceodbc_primarykeys + resourceconnection_id + stringqualifier + stringowner + stringtable + + + Returns the column names that comprise the primary key for a + table. Returns an ODBC result identifier or + &false; on failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_OWNER + TABLE_NAME + COLUMN_NAME + KEY_SEQ + PK_NAME + + + + + - - - odbc_procedurecolumns - - Retrieve information about parameters to procedures - - - - Description - - resourceodbc_procedurecolumns - resourceconnection_id - stringqualifier - stringowner - stringproc - stringcolumn - - - Returns the list of input and output parameters, as well as the - columns that make up the result set for the specified procedures. Returns - an ODBC result identifier or &false; on failure. - - - The result set has the following columns: - - PROCEDURE_QUALIFIER - PROCEDURE_OWNER - PROCEDURE_NAME - COLUMN_NAME - COLUMN_TYPE - DATA_TYPE - TYPE_NAME - PRECISION - LENGTH - SCALE - RADIX - NULLABLE - REMARKS - - - The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, - PROCEDURE_NAME and COLUMN_TYPE. - - - The owner, proc and - column arguments accept search patterns - ('%' to match zero or more characters and '_' to match a single - character). - - - + + + odbc_procedurecolumns + Retrieve information about parameters to procedures + + + Description + + resourceodbc_procedurecolumns + resourceconnection_id + stringqualifier + stringowner + stringproc + stringcolumn + + + Returns the list of input and output parameters, as well as the + columns that make up the result set for the specified procedures. Returns + an ODBC result identifier or &false; on failure. + + + The result set has the following columns: + + PROCEDURE_QUALIFIER + PROCEDURE_OWNER + PROCEDURE_NAME + COLUMN_NAME + COLUMN_TYPE + DATA_TYPE + TYPE_NAME + PRECISION + LENGTH + SCALE + RADIX + NULLABLE + REMARKS + + + The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, + PROCEDURE_NAME and COLUMN_TYPE. + + + The owner, proc and + column arguments accept search patterns + ('%' to match zero or more characters and '_' to match a single + character). + + + + - - - odbc_procedures - - Get the list of procedures stored in a specific data source - - - - Description - - resourceodbc_procedures - resourceconnection_id - stringqualifier - stringowner - stringname - - - Lists all procedures in the requested range. Returns an ODBC - result identifier containing the information or &false; on failure. - - - The result set has the following columns: - - PROCEDURE_QUALIFIER - PROCEDURE_OWNER - PROCEDURE_NAME - NUM_INPUT_PARAMS - NUM_OUTPUT_PARAMS - NUM_RESULT_SETS - REMARKS - PROCEDURE_TYPE - - - - The owner and name - arguments accept search patterns ('%' to match zero or more - characters and '_' to match a single character). - - - + + + odbc_procedures + Get the list of procedures stored in a specific data source + + + Description + + resourceodbc_procedures + resourceconnection_id + stringqualifier + stringowner + stringname + + + Lists all procedures in the requested range. Returns an ODBC + result identifier containing the information or &false; on failure. + + + The result set has the following columns: + + PROCEDURE_QUALIFIER + PROCEDURE_OWNER + PROCEDURE_NAME + NUM_INPUT_PARAMS + NUM_OUTPUT_PARAMS + NUM_RESULT_SETS + REMARKS + PROCEDURE_TYPE + + + + The owner and name + arguments accept search patterns ('%' to match zero or more + characters and '_' to match a single character). + + + + - - - odbc_result_all - Print result as HTML table - - - Description - - intodbc_result_all - resourceresult_id - stringformat - - - Returns the number of rows in the result or - &false; on error. - - - odbc_result_all will print all rows from a - result identifier produced by odbc_exec. The - result is printed in HTML table format. With the optional string - argument format, additional overall table - formatting can be done. - - - + + + odbc_result_all + Print result as HTML table + + + Description + + intodbc_result_all + resourceresult_id + stringformat + + + Returns the number of rows in the result or + &false; on error. + + + odbc_result_all will print all rows from a + result identifier produced by odbc_exec. The + result is printed in HTML table format. With the optional string + argument format, additional overall table + formatting can be done. + + + + - - - odbc_result - Get result data - - - Description - - mixedodbc_result - resourceresult_id - mixedfield - - - Returns the string contents of the field, &false; on error, &null; for - NULL data, or &true; for binary data. - - - field can either be an integer containing - the column number of the field you want; or it can be a string - containing the name of the field. For example: - - + + + odbc_result + Get result data + + + Description + + mixedodbc_result + resourceresult_id + mixedfield + + + Returns the string contents of the field, &false; on error, &null; for + NULL data, or &true; for binary data. + + + field can either be an integer containing + the column number of the field you want; or it can be a string + containing the name of the field. For example: + + ]]> - - - - - The first call to odbc_result returns the - value of the third field in the current record of the query - result. The second function call to - odbc_result returns the value of the field - whose field name is "val" in the current record of the query - result. An error occurs if a column number parameter for a field - is less than one or exceeds the number of columns (or fields) in - the current record. Similarly, an error occurs if a field with a - name that is not one of the fieldnames of the table(s) that - is(are) being queried. - - - Field indices start from 1. Regarding the way binary or - long column data is returned refer to - odbc_binmode and - odbc_longreadlen. + + + + + The first call to odbc_result returns the + value of the third field in the current record of the query + result. The second function call to + odbc_result returns the value of the field + whose field name is "val" in the current record of the query + result. An error occurs if a column number parameter for a field + is less than one or exceeds the number of columns (or fields) in + the current record. Similarly, an error occurs if a field with a + name that is not one of the fieldnames of the table(s) that + is(are) being queried. + + + Field indices start from 1. Regarding the way binary or + long column data is returned refer to + odbc_binmode and + odbc_longreadlen. - - - + + + + - - - odbc_rollback - Rollback a transaction - - - Description - - boolodbc_rollback - resourceconnection_id - - - Rolls back all pending statements on - connection_id. Returns - &true; on success, &false; on - failure. - - - + + + odbc_rollback + Rollback a transaction + + + Description + + boolodbc_rollback + resourceconnection_id + + + Rolls back all pending statements on + connection_id. Returns + &true; on success, &false; on + failure. + + + + - - - odbc_setoption - - Adjust ODBC settings - - - - Description - - boolodbc_setoption - resourceid - intfunction - intoption - intparam - - - This function allows fiddling with the ODBC options for a - particular connection or query result. It was written to help - find work around to problems in quirky ODBC drivers. You should - probably only use this function if you are an ODBC programmer and - understand the effects the various options will have. You will - certainly need a good ODBC reference to explain all the different - options and values that can be used. Different driver versions - support different options. - - - Because the effects may vary depending on the ODBC driver, use of - this function in scripts to be made publicly available is - strongly discouraged. Also, some ODBC options are not available - to this function because they must be set before the connection - is established or the query is prepared. However, if on a - particular job it can make PHP work so your boss doesn't tell you - to use a commercial product, that's all that really - matters. - - - &return.success; - - - id is a connection id or result id on - which to change the settings.For SQLSetConnectOption(), this is a - connection id. For SQLSetStmtOption(), this is a result - id. - - - Function is the ODBC function to use. The - value should be 1 for SQLSetConnectOption() and 2 for - SQLSetStmtOption(). - - - Parameter option is the option to set. - - Parameter param is the value for the - given option. - - ODBC Setoption Examples - + + + odbc_setoption + Adjust ODBC settings + + + Description + + boolodbc_setoption + resourceid + intfunction + intoption + intparam + + + This function allows fiddling with the ODBC options for a + particular connection or query result. It was written to help + find work around to problems in quirky ODBC drivers. You should + probably only use this function if you are an ODBC programmer and + understand the effects the various options will have. You will + certainly need a good ODBC reference to explain all the different + options and values that can be used. Different driver versions + support different options. + + + Because the effects may vary depending on the ODBC driver, use of + this function in scripts to be made publicly available is + strongly discouraged. Also, some ODBC options are not available + to this function because they must be set before the connection + is established or the query is prepared. However, if on a + particular job it can make PHP work so your boss doesn't tell you + to use a commercial product, that's all that really + matters. + + + &return.success; + + + id is a connection id or result id on + which to change the settings.For SQLSetConnectOption(), this is a + connection id. For SQLSetStmtOption(), this is a result + id. + + + Function is the ODBC function to use. The + value should be 1 for SQLSetConnectOption() and 2 for + SQLSetStmtOption(). + + + Parameter option is the option to set. + + Parameter param is the value for the + given option. + + ODBC Setoption Examples + ]]> - - - - - + + + + + + - - - odbc_specialcolumns - - Returns either the optimal set of columns that uniquely - identifies a row in the table or columns that are automatically - updated when any value in the row is updated by a transaction - - - - Description - - resourceodbc_specialcolumns - resourceconnection_id - inttype - stringqualifier - stringowner - stringtable - intscope - intnullable - - - When the type argument is SQL_BEST_ROWID, - odbc_specialcolumns returns the - column or columns that uniquely identify each row in the table. - - - When the type argument is SQL_ROWVER, - odbc_specialcolumns returns the column or columns in the - specified table, if any, that are automatically updated by the data source - when any value in the row is updated by any transaction. - - - Returns an ODBC result identifier or &false; on - failure. - - - The result set has the following columns: - - SCOPE - COLUMN_NAME - DATA_TYPE - TYPE_NAME - PRECISION - LENGTH - SCALE - PSEUDO_COLUMN - - - - The result set is ordered by SCOPE. - - - + + + odbc_specialcolumns + Returns either the optimal set of columns that uniquely identifies a row in the table or columns that are automatically updated when any value in the row is updated by a transaction + + + Description + + resourceodbc_specialcolumns + resourceconnection_id + inttype + stringqualifier + stringowner + stringtable + intscope + intnullable + + + When the type argument is SQL_BEST_ROWID, + odbc_specialcolumns returns the + column or columns that uniquely identify each row in the table. + + + When the type argument is SQL_ROWVER, + odbc_specialcolumns returns the column or columns in the + specified table, if any, that are automatically updated by the data source + when any value in the row is updated by any transaction. + + + Returns an ODBC result identifier or &false; on + failure. + + + The result set has the following columns: + + SCOPE + COLUMN_NAME + DATA_TYPE + TYPE_NAME + PRECISION + LENGTH + SCALE + PSEUDO_COLUMN + + + + The result set is ordered by SCOPE. + + + + - - - odbc_statistics - Retrieve statistics about a table - - - Description - - resourceodbc_statistics - resourceconnection_id - stringqualifier - stringowner - stringtable_name - intunique - intaccuracy - - - Get statistics about a table and its indexes. Returns an ODBC - result identifier or &false; on failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_OWNER - TABLE_NAME - NON_UNIQUE - INDEX_QUALIFIER - INDEX_NAME - TYPE - SEQ_IN_INDEX - COLUMN_NAME - COLLATION - CARDINALITY - PAGES - FILTER_CONDITION - - - - The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, - INDEX_NAME and SEQ_IN_INDEX. - - - + + + odbc_statistics + Retrieve statistics about a table + + + Description + + resourceodbc_statistics + resourceconnection_id + stringqualifier + stringowner + stringtable_name + intunique + intaccuracy + + + Get statistics about a table and its indexes. Returns an ODBC + result identifier or &false; on failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_OWNER + TABLE_NAME + NON_UNIQUE + INDEX_QUALIFIER + INDEX_NAME + TYPE + SEQ_IN_INDEX + COLUMN_NAME + COLLATION + CARDINALITY + PAGES + FILTER_CONDITION + + + + The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, + INDEX_NAME and SEQ_IN_INDEX. + + + + - - - odbc_tableprivileges - - Lists tables and the privileges associated with each table - - - - Description - - resourceodbc_tableprivileges - resourceconnection_id - stringqualifier - stringowner - stringname - - - Lists tables in the requested range and the privileges associated - with each table. Returns an ODBC result identifier or - &false; on failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_OWNER - TABLE_NAME - GRANTOR - GRANTEE - PRIVILEGE - IS_GRANTABLE - - - - The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and - TABLE_NAME. - - - The owner and name - arguments accept search patterns ('%' to match zero or more - characters and '_' to match a single character). - - - + + + odbc_tableprivileges + Lists tables and the privileges associated with each table + + + Description + + resourceodbc_tableprivileges + resourceconnection_id + stringqualifier + stringowner + stringname + + + Lists tables in the requested range and the privileges associated + with each table. Returns an ODBC result identifier or + &false; on failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_OWNER + TABLE_NAME + GRANTOR + GRANTEE + PRIVILEGE + IS_GRANTABLE + + + + The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and + TABLE_NAME. + + + The owner and name + arguments accept search patterns ('%' to match zero or more + characters and '_' to match a single character). + + + + - - - odbc_tables - - Get the list of table names stored in a specific data source - - - - Description - - resourceodbc_tables - resourceconnection_id - stringqualifier - stringowner - stringname - stringtypes - - - Lists all tables in the requested range. Returns an ODBC result - identifier containing the information or &false; on failure. - - - The result set has the following columns: - - TABLE_QUALIFIER - TABLE_OWNER - TABLE_NAME - TABLE_TYPE - REMARKS - - - - The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER, - TABLE_OWNER and TABLE_NAME. - - - The owner and name - arguments accept search patterns ('%' to match zero or more - characters and '_' to match a single character). - - - To support enumeration of qualifiers, owners, and table types, - the following special semantics for the - qualifier, owner, - name, and - table_type are available: - - - - If qualifier is a single percent - character (%) and owner and - name are empty strings, then the result - set contains a list of valid qualifiers for the data - source. (All columns except the TABLE_QUALIFIER column contain - NULLs.) - - - - - If owner is a single percent character - (%) and qualifier and - name are empty strings, then the result - set contains a list of valid owners for the data source. (All - columns except the TABLE_OWNER column contain - NULLs.) - - - - - If table_type is a single percent - character (%) and qualifier, - owner and name - are empty strings, then the result set contains a list of - valid table types for the data source. (All columns except the - TABLE_TYPE column contain NULLs.) - - - - - - If table_type is not an empty string, it - must contain a list of comma-separated values for the types of - interest; each value may be enclosed in single quotes (') or - unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the - data source does not support a specified table type, - odbc_tables does not return any results for - that type. - - - See also odbc_tableprivileges to retrieve - associated privileges. - - - + + + odbc_tables + Get the list of table names stored in a specific data source + + + Description + + resourceodbc_tables + resourceconnection_id + stringqualifier + stringowner + stringname + stringtypes + + + Lists all tables in the requested range. Returns an ODBC result + identifier containing the information or &false; on failure. + + + The result set has the following columns: + + TABLE_QUALIFIER + TABLE_OWNER + TABLE_NAME + TABLE_TYPE + REMARKS + + + + The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER, + TABLE_OWNER and TABLE_NAME. + + + The owner and name + arguments accept search patterns ('%' to match zero or more + characters and '_' to match a single character). + + + To support enumeration of qualifiers, owners, and table types, + the following special semantics for the + qualifier, owner, + name, and + table_type are available: + + + + If qualifier is a single percent + character (%) and owner and + name are empty strings, then the result + set contains a list of valid qualifiers for the data + source. (All columns except the TABLE_QUALIFIER column contain + NULLs.) + + + + + If owner is a single percent character + (%) and qualifier and + name are empty strings, then the result + set contains a list of valid owners for the data source. (All + columns except the TABLE_OWNER column contain + NULLs.) + + + + + If table_type is a single percent + character (%) and qualifier, + owner and name + are empty strings, then the result set contains a list of + valid table types for the data source. (All columns except the + TABLE_TYPE column contain NULLs.) + + + + + + If table_type is not an empty string, it + must contain a list of comma-separated values for the types of + interest; each value may be enclosed in single quotes (') or + unquoted. For example, "'TABLE','VIEW'" or "TABLE, VIEW". If the + data source does not support a specified table type, + odbc_tables does not return any results for + that type. + + + See also odbc_tableprivileges to retrieve + associated privileges. + + +