diff --git a/reference/uodbc/functions/odbc-close-all.xml b/reference/uodbc/functions/odbc-close-all.xml index 963bfa2960..631e258b59 100644 --- a/reference/uodbc/functions/odbc-close-all.xml +++ b/reference/uodbc/functions/odbc-close-all.xml @@ -1,5 +1,5 @@ - + odbc_close_all @@ -16,6 +16,12 @@ connections to database server(s). + + + &reftitle.parameters; + &no.function.parameters; + + &reftitle.returnvalues; diff --git a/reference/uodbc/functions/odbc-connect.xml b/reference/uodbc/functions/odbc-connect.xml index 1b43bfed5a..2b6c193a66 100644 --- a/reference/uodbc/functions/odbc-connect.xml +++ b/reference/uodbc/functions/odbc-connect.xml @@ -1,13 +1,13 @@ - - + odbc_connect Connect to a datasource - - Description + + + &reftitle.description; resourceodbc_connect stringdsn @@ -15,17 +15,10 @@ 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 @@ -36,37 +29,94 @@ 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. - + + + &reftitle.parameters; + + + + dsn + + + The database source name for the connection. + + + + + user + + + The username. + + + + + password + + + The password. + + + + + cursor_type + + + This 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. + + + The following constants are defined for cursortype: + + + + + + SQL_CUR_USE_IF_NEEDED + + + + + SQL_CUR_USE_ODBC + + + + + SQL_CUR_USE_DRIVER + + + + + SQL_CUR_DEFAULT + + + + + + + + + + + + &reftitle.returnvalues; + + Returns an ODBC connection id or 0 (&false;) on + error. + + + + + &reftitle.seealso; + + + For persistent connections: odbc_pconnect + + + + - + 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 + + + &reftitle.description; resourceodbc_foreignkeys resourceconnection_id diff --git a/reference/uodbc/functions/odbc-gettypeinfo.xml b/reference/uodbc/functions/odbc-gettypeinfo.xml index 515c68a93f..9f13e7bc84 100644 --- a/reference/uodbc/functions/odbc-gettypeinfo.xml +++ b/reference/uodbc/functions/odbc-gettypeinfo.xml @@ -1,13 +1,13 @@ - - + odbc_gettypeinfo Returns a result identifier containing information about data types supported by the data source - - Description + + + &reftitle.description; resourceodbc_gettypeinfo resourceconnection_id diff --git a/reference/uodbc/functions/odbc-pconnect.xml b/reference/uodbc/functions/odbc-pconnect.xml index f06c468f9f..aca3b85ed4 100644 --- a/reference/uodbc/functions/odbc-pconnect.xml +++ b/reference/uodbc/functions/odbc-pconnect.xml @@ -1,13 +1,13 @@ - - + odbc_pconnect Open a persistent database connection - - Description + + + &reftitle.description; resourceodbc_pconnect stringdsn diff --git a/reference/uodbc/functions/odbc-prepare.xml b/reference/uodbc/functions/odbc-prepare.xml index 7d05262be2..944a9c99fa 100644 --- a/reference/uodbc/functions/odbc-prepare.xml +++ b/reference/uodbc/functions/odbc-prepare.xml @@ -1,13 +1,13 @@ - - + odbc_prepare Prepares a statement for execution - - Description + + + &reftitle.description; resourceodbc_prepare resourceconnection_id diff --git a/reference/uodbc/functions/odbc-procedurecolumns.xml b/reference/uodbc/functions/odbc-procedurecolumns.xml index 3328e528f7..8414f7d145 100644 --- a/reference/uodbc/functions/odbc-procedurecolumns.xml +++ b/reference/uodbc/functions/odbc-procedurecolumns.xml @@ -1,13 +1,14 @@ - + odbc_procedurecolumns Retrieve information about parameters to procedures - - Description + + + &reftitle.description; resourceodbc_procedurecolumns resourceconnection_id diff --git a/reference/uodbc/functions/odbc-procedures.xml b/reference/uodbc/functions/odbc-procedures.xml index 55a1b93c3c..001ed56e90 100644 --- a/reference/uodbc/functions/odbc-procedures.xml +++ b/reference/uodbc/functions/odbc-procedures.xml @@ -1,13 +1,14 @@ - + odbc_procedures Get the list of procedures stored in a specific data source - - Description + + + &reftitle.description; resourceodbc_procedures resourceconnection_id diff --git a/reference/uodbc/functions/odbc-result.xml b/reference/uodbc/functions/odbc-result.xml index e8ef7cb681..14bd876f28 100644 --- a/reference/uodbc/functions/odbc-result.xml +++ b/reference/uodbc/functions/odbc-result.xml @@ -1,13 +1,13 @@ - - + odbc_result Get result data - - Description + + + &reftitle.description; mixedodbc_result resourceresult_id diff --git a/reference/uodbc/functions/odbc-setoption.xml b/reference/uodbc/functions/odbc-setoption.xml index 51b0c422c7..92c8904e36 100644 --- a/reference/uodbc/functions/odbc-setoption.xml +++ b/reference/uodbc/functions/odbc-setoption.xml @@ -1,13 +1,13 @@ - - + odbc_setoption Adjust ODBC settings - - Description + + + &reftitle.description; boolodbc_setoption resourceid diff --git a/reference/uodbc/functions/odbc-specialcolumns.xml b/reference/uodbc/functions/odbc-specialcolumns.xml index 3a92692280..907c74db40 100644 --- a/reference/uodbc/functions/odbc-specialcolumns.xml +++ b/reference/uodbc/functions/odbc-specialcolumns.xml @@ -1,13 +1,13 @@ - - + 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 + + + &reftitle.description; resourceodbc_specialcolumns resourceconnection_id diff --git a/reference/uodbc/functions/odbc-statistics.xml b/reference/uodbc/functions/odbc-statistics.xml index b2edb82bd6..3478a0c037 100644 --- a/reference/uodbc/functions/odbc-statistics.xml +++ b/reference/uodbc/functions/odbc-statistics.xml @@ -1,13 +1,13 @@ - - + odbc_statistics Retrieve statistics about a table - - Description + + + &reftitle.description; resourceodbc_statistics resourceconnection_id diff --git a/reference/uodbc/functions/odbc-tableprivileges.xml b/reference/uodbc/functions/odbc-tableprivileges.xml index bc1a3258d5..ae8392d164 100644 --- a/reference/uodbc/functions/odbc-tableprivileges.xml +++ b/reference/uodbc/functions/odbc-tableprivileges.xml @@ -1,13 +1,13 @@ - - + odbc_tableprivileges Lists tables and the privileges associated with each table - - Description + + + &reftitle.description; resourceodbc_tableprivileges resourceconnection_id @@ -17,8 +17,54 @@ Lists tables in the requested range and the privileges associated - with each table. Returns an ODBC result identifier or - &false; on failure. + with each table. + + + + + &reftitle.parameters; + + + + connection_id + + &odbc.connection.id; + + + + qualifier + + + The qualifier. + + + + + owner + + + The owner. Accepts the following search patterns: + ('%' to match zero or more characters and '_' to match a single character) + + + + + name + + + The name. Accepts the following search patterns: + ('%' to match zero or more characters and '_' to match a single character) + + + + + + + + + &reftitle.returnvalues; + + An ODBC result identifier or &false; on failure. The result set has the following columns: @@ -36,12 +82,8 @@ 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 + + + &reftitle.description; resourceodbc_tables resourceconnection_id @@ -17,27 +17,7 @@ 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). + Lists all tables in the requested range. To support enumeration of qualifiers, owners, and table types, @@ -78,20 +58,93 @@ + + + + &reftitle.parameters; - 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. + + + connection_id + + &odbc.connection.id; + + + + qualifier + + + The qualifier. + + + + + owner + + + The owner. Accepts search patterns ('%' to match zero or more + characters and '_' to match a single character). + + + + + name + + + The name. Accepts search patterns ('%' to match zero or more + characters and '_' to match a single character). + + + + + types + + + 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. + + + + + + + + + &reftitle.returnvalues; + + 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 + - See also odbc_tableprivileges to retrieve - associated privileges. + The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER, + TABLE_OWNER and TABLE_NAME. + + + &reftitle.seealso; + + + odbc_tableprivileges + + + +