From b8989f5a4541a24420645f162d11ce6a020384d4 Mon Sep 17 00:00:00 2001 From: Philip Olson Date: Wed, 19 Mar 2008 21:51:42 +0000 Subject: [PATCH] removed dead sesam docs git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@255509 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../sesam/functions/sesam-affected-rows.xml | 104 ------- reference/sesam/functions/sesam-commit.xml | 85 ------ reference/sesam/functions/sesam-connect.xml | 122 --------- .../sesam/functions/sesam-diagnostic.xml | 191 ------------- .../sesam/functions/sesam-disconnect.xml | 91 ------- reference/sesam/functions/sesam-errormsg.xml | 76 ------ reference/sesam/functions/sesam-execimm.xml | 114 -------- .../sesam/functions/sesam-fetch-array.xml | 256 ------------------ .../sesam/functions/sesam-fetch-result.xml | 149 ---------- reference/sesam/functions/sesam-fetch-row.xml | 226 ---------------- .../sesam/functions/sesam-field-array.xml | 235 ---------------- .../sesam/functions/sesam-field-name.xml | 88 ------ .../sesam/functions/sesam-free-result.xml | 63 ----- .../sesam/functions/sesam-num-fields.xml | 84 ------ 14 files changed, 1884 deletions(-) delete mode 100644 reference/sesam/functions/sesam-affected-rows.xml delete mode 100644 reference/sesam/functions/sesam-commit.xml delete mode 100644 reference/sesam/functions/sesam-connect.xml delete mode 100644 reference/sesam/functions/sesam-diagnostic.xml delete mode 100644 reference/sesam/functions/sesam-disconnect.xml delete mode 100644 reference/sesam/functions/sesam-errormsg.xml delete mode 100644 reference/sesam/functions/sesam-execimm.xml delete mode 100644 reference/sesam/functions/sesam-fetch-array.xml delete mode 100644 reference/sesam/functions/sesam-fetch-result.xml delete mode 100644 reference/sesam/functions/sesam-fetch-row.xml delete mode 100644 reference/sesam/functions/sesam-field-array.xml delete mode 100644 reference/sesam/functions/sesam-field-name.xml delete mode 100644 reference/sesam/functions/sesam-free-result.xml delete mode 100644 reference/sesam/functions/sesam-num-fields.xml diff --git a/reference/sesam/functions/sesam-affected-rows.xml b/reference/sesam/functions/sesam-affected-rows.xml deleted file mode 100644 index 489c711ac5..0000000000 --- a/reference/sesam/functions/sesam-affected-rows.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - sesam_affected_rows - Get number of rows affected by an immediate query - - - - &reftitle.description; - - intsesam_affected_rows - stringresult_id - - - Gets the number of rows affected by an immediate query. - - - The sesam_affected_rows function can only return - useful values when used in combination with "immediate" SQL statements - (updating operations like INSERT, - UPDATE and DELETE) because SESAM - does not deliver any "affected rows" information for "select type" - queries. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows affected by a query associated with - result_id. - - - - - &reftitle.examples; - - - <function>sesam_affected_rows</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - sesam_query - sesam_execimm - - - - - - - diff --git a/reference/sesam/functions/sesam-commit.xml b/reference/sesam/functions/sesam-commit.xml deleted file mode 100644 index 0801be4d35..0000000000 --- a/reference/sesam/functions/sesam-commit.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - sesam_commit - Commit pending updates to the SESAM database - - - - &reftitle.description; - - boolsesam_commit - - - - Commits any pending updates to the database. - - - Note that there is no "auto-commit" feature as in other - databases, as it could lead to accidental data loss. Uncommitted - data at the end of the current script (or when calling - sesam_disconnect) will be discarded by an - implied sesam_rollback call. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Committing an update to the SESAM database - -)")) - die("insert failed"); - if (!sesam_commit()) - die("commit failed"); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - sesam_rollback - - - - - - - diff --git a/reference/sesam/functions/sesam-connect.xml b/reference/sesam/functions/sesam-connect.xml deleted file mode 100644 index 38bde14f4c..0000000000 --- a/reference/sesam/functions/sesam-connect.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - sesam_connect - Open SESAM database connection - - - - &reftitle.description; - - boolsesam_connect - stringcatalog - stringschema - stringuser - - - Establishes a connection to a SESAM database handler task. The connection - is always "persistent" in the sense that only the very first invocation - will actually load the driver from the configured SESAM OML PLAM library. - Subsequent calls will reuse the driver and will immediately use the given - catalog, schema, and user. - - - - - &reftitle.parameters; - - - - catalog - - - When creating a database, the "catalog" name is - specified in the SESAM configuration directive - //ADD-SQL-DATABASE-CATALOG-LIST ENTRY-1 = - *CATALOG(CATALOG-NAME = catalogname,...) - - - - - schema - - - The schema references the desired database - schema (see SESAM handbook). - - - - - user - - - The "user" argument references one of the users - which are allowed to access this "catalog" / - "schema" combination. Note that - "user" is completely independent from both the - system's user id's and from HTTP user/password protection. It appears - in the SESAM configuration only. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Connect to a SESAM database - - -]]> - - - - - - - &reftitle.seealso; - - - sesam_disconnect - - - - - - - diff --git a/reference/sesam/functions/sesam-diagnostic.xml b/reference/sesam/functions/sesam-diagnostic.xml deleted file mode 100644 index 9538f4408d..0000000000 --- a/reference/sesam/functions/sesam-diagnostic.xml +++ /dev/null @@ -1,191 +0,0 @@ - - - - - sesam_diagnostic - Return status information for last SESAM call - - - - &reftitle.description; - - arraysesam_diagnostic - - - - Returns status information for last SESAM call. - - - - - &reftitle.returnvalues; - - Returns an associative array of status and return codes for the - last SQL query/statement/command. Elements of the array are: - - - Status information returned by <function>sesam_diagnostic</function> - - - - - Element - Contents - - - - - $array["sqlstate"] - - 5 digit SQL return code (see the SESAM manual for the - description of the possible values of SQLSTATE) - - - - $array["rowcount"] - - number of affected rows in last update/insert/delete (set - after "immediate" statements only) - - - - $array["errmsg"] - - "human readable" error message string (set after errors - only) - - - - $array["errcol"] - - error column number of previous error (0-based; or -1 if - undefined. Set after errors only) - - - - $array["errlin"] - - error line number of previous error (0-based; or -1 if - undefined. Set after errors only) - - - - -
- - - - - &reftitle.examples; - - In the following example, a syntax error (E SEW42AE ILLEGAL - CHARACTER) is displayed by including the offending SQL statement - and pointing to the error location: - - Displaying SESAM error messages with error position - -\n"; - echo "ERROR: ". - htmlspecialchars($err["errmsg"]) . "\n"; - if ($err["errcol"] >= 0) { - echo "
\n";
-        $errstmt = $exec_str . "\n";
-        for ($lin=0; $errstmt != ""; ++$lin) {
-            if ($lin != $err["errlin"]) { // $lin is less or greater than errlin
-                if (!($i = strchr($errstmt, "\n")))
-                    $i = "";
-                $line = substr ($errstmt, 0, strlen($errstmt)-strlen($i)+1);
-                $errstmt = substr($i, 1);
-                if ($line != "\n")
-                    echo htmlspecialchars($line);
-            } else {
-                if (! ($i = strchr ($errstmt, "\n")))
-                    $i = "";
-                $line = substr ($errstmt, 0, strlen ($errstmt)-strlen($i)+1);
-                $errstmt = substr($i, 1);
-                for ($col=0; $col < $err["errcol"]; ++$col) {
-                    echo (substr($line, $col, 1) == "\t") ? "\t" : ".";
-                }
-                echo "\\\n";
-                echo "" . htmlspecialchars($line) . "";
-                for ($col=0; $col < $err["errcol"]; ++$col) {
-                    echo (substr ($line, $col, 1) == "\t") ? "\t" : ".";
-                }
-                echo "/\n";
-            }
-        }
-        echo "
\n"; - } - echo "\n"; - echo " sqlstate=" . $err["sqlstate"] . "\n"; - if ($err["errlin"] != -1) - echo " errlin=" . $err["errlin"] . "\n"; - if ($err["errcol"] != -1) - echo " errcol=" . $err["errcol"] . "\n"; - if ($err["rowcount"] != 0) - echo " rowcount=" . $err["rowcount"] . "\n"; - echo "\n"; - echo "\n"; -} - -if (!sesam_connect ("mycatalog", "phoneno", "otto")) - die ("cannot connect"); - -$stmt = "SELECT * FROM phone\n" . - " WHERE@ LASTNAME='KRAEMER'\n" . - " ORDER BY FIRSTNAME"; -if (!($result = sesam_query ($stmt))) - PrintReturncode ($stmt); -?> -]]> - - - - - - - &reftitle.seealso; - - - sesam_errormsg - - - - - - - diff --git a/reference/sesam/functions/sesam-disconnect.xml b/reference/sesam/functions/sesam-disconnect.xml deleted file mode 100644 index 3da64250a9..0000000000 --- a/reference/sesam/functions/sesam-disconnect.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - sesam_disconnect - Detach from SESAM connection - - - - &reftitle.description; - - boolsesam_disconnect - - - - Closes the logical link to a SESAM database (without actually - disconnecting and unloading the driver). - - - Note that this isn't usually necessary, as the open connection is - automatically closed at the end of the script's execution. - Uncommitted data will be discarded, because an implicit - sesam_rollback is executed. - - - sesam_disconnect will not close the - persistent link, it will only invalidate the currently defined - "catalog", "schema" - and "user" triple, so that any sesam - function called after sesam_disconnect will - fail. - - - - - &reftitle.returnvalues; - - Always returns &true;. - - - - - &reftitle.examples; - - - Closing a SESAM connection - - -]]> - - - - - - - &reftitle.seealso; - - - sesam_connect - - - - - - - diff --git a/reference/sesam/functions/sesam-errormsg.xml b/reference/sesam/functions/sesam-errormsg.xml deleted file mode 100644 index 59335a29de..0000000000 --- a/reference/sesam/functions/sesam-errormsg.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - sesam_errormsg - Returns error message of last SESAM call - - - - &reftitle.description; - - stringsesam_errormsg - - - - Gets the SESAM error message associated with the most recent SESAM error. - - - - - &reftitle.returnvalues; - - Returns the SESAM error message associated with the most recent SESAM - error. An empty string means no errors. - - - - - &reftitle.examples; - - - <function>sesam_errormsg</function> example - -\n"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - sesam_diagnostic - - - - - - - diff --git a/reference/sesam/functions/sesam-execimm.xml b/reference/sesam/functions/sesam-execimm.xml deleted file mode 100644 index 54ee30eb4c..0000000000 --- a/reference/sesam/functions/sesam-execimm.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - sesam_execimm - Execute an "immediate" SQL-statement - - - - &reftitle.description; - - stringsesam_execimm - stringquery - - - Executes an "immediate" statement. - - - Sets the affected_rows value for retrieval by the - sesam_affected_rows function. - - - Note that sesam_query can handle both "immediate" and - "select-type" queries. Use sesam_execimm only if you - know beforehand what type of statement will be executed. An attempt to - use SELECT type queries with sesam_execimm will - return $err["sqlstate"] == "42SBW". - - - - - &reftitle.parameters; - - - - query - - - An "immediate" statement (i.e., a statement like UPDATE, INSERT or - DELETE which returns no result, and has no INPUT or OUTPUT variables). - "select type" queries can not be used with - sesam_execimm. - - - - - - - - - &reftitle.returnvalues; - - Returns a SESAM result identifier on success, or &false; on error. - - - The returned "result identifier" can not be used for retrieving anything - but the sesam_affected_rows; it is only returned for - symmetry with the sesam_query function. - - - - - &reftitle.examples; - - - <function>sesam_execimm</function> Example - - -]]> - - - - - - - &reftitle.seealso; - - - sesam_query - sesam_affected_rows - - - - - - - diff --git a/reference/sesam/functions/sesam-fetch-array.xml b/reference/sesam/functions/sesam-fetch-array.xml deleted file mode 100644 index a487c33c7d..0000000000 --- a/reference/sesam/functions/sesam-fetch-array.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - sesam_fetch_array - Fetch one row as an associative array - - - - &reftitle.description; - - arraysesam_fetch_array - stringresult_id - intwhence - intoffset - - - sesam_fetch_array is an alternative version - of sesam_fetch_row. Instead of storing the - data in the numeric indices of the result array, it stores the - data in associative indices, using the field names as keys. - - - sesam_fetch_array fetches one row of data - from the result associated with the specified result identifier. - The row is returned as an associative array. Each result column - is stored with an associative index equal to its column - (aka. field) name. The column names are converted to lower case. - - - Columns without a field name (e.g., results of arithmetic - operations) and empty fields are not stored in the array. Also, - if two or more columns of the result have the same column names, - the later column will take precedence. In this situation, either - call sesam_fetch_row or make an alias for - the column. - - - - - - - - A special handling allows fetching "multiple field" columns - (which would otherwise all have the same column names). For each - column of a "multiple field", the index name is constructed by - appending the string "(n)" where n is the sub-index of the - multiple field column, ranging from 1 to its declared repetition - factor. The indices are NOT zero based, in order to match the - nomenclature used in the respective query syntax. For a column - declared as: - - - - - - the associative indices used for the individual "multiple field" - columns would be "multi(1)", - "multi(2)", and "multi(3)" - respectively. - - - Subsequent calls to sesam_fetch_array would - return the next (or prior, or n'th next/prior, depending on the - scroll attributes) row in the result set, or &false; if there are no more rows. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - whence - - - whence is an optional - parameter for a fetch operation on "scrollable" cursors, which - can be set to the following predefined constants: - - Valid values for <parameter>"whence"</parameter> parameter - - - - Value - Constant - Meaning - - - - - 0 - SESAM_SEEK_NEXT - - read sequentially (after fetch, the internal default is set - to SESAM_SEEK_NEXT) - - - - 1 - SESAM_SEEK_PRIOR - - read sequentially backwards (after fetch, the internal - default is set to SESAM_SEEK_PRIOR) - - - - 2 - SESAM_SEEK_FIRST - - rewind to first row (after fetch, the default is set to - SESAM_SEEK_NEXT) - - - - 3 - SESAM_SEEK_LAST - - seek to last row (after fetch, the default is set to - SESAM_SEEK_PRIOR) - - - - 4 - SESAM_SEEK_ABSOLUTE - - seek to absolute row number given as - offset (Zero-based. After fetch, the - internal default is set to - SESAM_SEEK_ABSOLUTE, and the internal - offset value is auto-incremented) - - - - 5 - SESAM_SEEK_RELATIVE - - seek relative to current scroll position, where - offset can be a positive or negative - offset value. - - - - -
- This parameter is only valid for "scrollable" cursors. - - - When using "scrollable" cursors, the cursor can be freely positioned - on the result set. If the whence parameter is - omitted, the global default values for the scrolling type (initialized - to: SESAM_SEEK_NEXT, and settable by - sesam_seek_row) are used. If - whence is supplied, its value replaces the - global default. - - - - - offset - - - Only evaluated (and required) if whence is - either SESAM_SEEK_RELATIVE or - SESAM_SEEK_ABSOLUTE. This parameter is only - valid for "scrollable" cursors. - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or - &false; if there are no more rows. - - - - - &reftitle.examples; - - - SESAM fetch array - -\n"; -while (($row = sesam_fetch_array($result)) && count($row) > 0) { - echo "\n"; - echo "" . htmlspecialchars($row["firstname"]) . "\n"; - echo "" . htmlspecialchars($row["lastname"]) . "\n"; - echo "" . htmlspecialchars($row["phoneno"]) . "\n"; - echo "\n"; -} -echo "\n"; -sesam_free_result($result); -?> -]]> - - - - - - - &reftitle.seealso; - - - sesam_fetch_row - - - - - - - diff --git a/reference/sesam/functions/sesam-fetch-result.xml b/reference/sesam/functions/sesam-fetch-result.xml deleted file mode 100644 index 5a6aa59fa5..0000000000 --- a/reference/sesam/functions/sesam-fetch-result.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - sesam_fetch_result - Return all or part of a query result - - - - &reftitle.description; - - mixedsesam_fetch_result - stringresult_id - intmax_rows - - - Fetches a result, optionally limited to max_rows. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - max_rows - - - Note that the amount of memory used up by a large query may be - gigantic. Use the max_rows parameter to - limit the maximum number of rows returned, unless you are - absolutely sure that your result will not use up all available - memory. - - - - - - - - - &reftitle.returnvalues; - - Returns a mixed array with the query result entries, optionally - limited to a maximum of max_rows rows. - Note that both row and column indexes are zero-based. - - - Mixed result set returned by <function>sesam_fetch_result</function> - - - - - Array Element - Contents - - - - - int $arr["count"] - - number of columns in result set (or zero if this was an - "immediate" query) - - - - int $arr["rows"] - - number of rows in result set (between zero and - max_rows) - - - - bool $arr["truncated"] - - &true; if the number of rows was at least - max_rows, &false; - otherwise. Note that even when this is - &true;, the next - sesam_fetch_result call may return zero - rows because there are no more result entries. - - - - mixed $arr[col][row] - - result data for all the fields at - row(row) and - column(col), (where the integer index - row is between 0 and - $arr["rows"]-1, and - col is between 0 and - $arr["count"]-1). Fields may be empty, so - you must check for the existence of a field by using the php - isset function. The type of the - returned fields depend on the respective SQL type declared - for its column (see SESAM - overview for the conversions applied). SESAM - "multiple fields" are "inlined" and treated like a sequence - of columns. - - - - -
- - - - - &reftitle.seealso; - - - sesam_fetch_array - sesam_fetch_row - sesam_query - - - - - - - diff --git a/reference/sesam/functions/sesam-fetch-row.xml b/reference/sesam/functions/sesam-fetch-row.xml deleted file mode 100644 index fe46c76c7f..0000000000 --- a/reference/sesam/functions/sesam-fetch-row.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - sesam_fetch_row - Fetch one row as an array - - - - &reftitle.description; - - arraysesam_fetch_row - stringresult_id - intwhence - intoffset - - - Fetches one row of data from the result associated with the specified - result identifier. The row is returned as an array (indexed by values - between 0 and $array["count"]-1). - Fields may be empty, so you must check for the existence of a field by - using the isset function. The type of the returned - fields depend on the respective SQL type declared for its column (see - SESAM overview for the conversions - applied). SESAM "multiple fields" are "inlined" and treated like a - sequence of columns. - - - The number of columns in the result set is returned in an associative - array element $array["count"]. Because some of the result columns may be - empty, the count function can not be used on the - result row returned by sesam_fetch_row. - - - Subsequent calls to sesam_fetch_row would return the - next (or prior, or n'th next/prior, depending on the scroll attributes) - row in the result set, or &false; if there are no more rows. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - whence - - - whence is an optional - parameter for a fetch operation on "scrollable" cursors, which - can be set to the following predefined constants: - - Valid values for <parameter>"whence"</parameter> parameter - - - - Value - Constant - Meaning - - - - - 0 - SESAM_SEEK_NEXT - - read sequentially (after fetch, the internal default is set - to SESAM_SEEK_NEXT) - - - - 1 - SESAM_SEEK_PRIOR - - read sequentially backwards (after fetch, the internal - default is set to SESAM_SEEK_PRIOR) - - - - 2 - SESAM_SEEK_FIRST - - rewind to first row (after fetch, the default is set to - SESAM_SEEK_NEXT) - - - - 3 - SESAM_SEEK_LAST - - seek to last row (after fetch, the default is set to - SESAM_SEEK_PRIOR) - - - - 4 - SESAM_SEEK_ABSOLUTE - - seek to absolute row number given as - offset (Zero-based. After fetch, the - internal default is set to - SESAM_SEEK_ABSOLUTE, and the internal - offset value is auto-incremented) - - - - 5 - SESAM_SEEK_RELATIVE - - seek relative to current scroll position, where - offset can be a positive or negative - offset value. - - - - -
- This parameter is only valid for "scrollable" cursors. - - - When using "scrollable" cursors, the cursor can be freely positioned - on the result set. If the whence parameter is - omitted, the global default values for the scrolling type (initialized - to: SESAM_SEEK_NEXT, and settable by - sesam_seek_row) are used. If - whence is supplied, its value replaces the - global default. - - - - - offset - - - Only evaluated (and required) if whence is - either SESAM_SEEK_RELATIVE or - SESAM_SEEK_ABSOLUTE. This parameter is only - valid for "scrollable" cursors. - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or - &false; if there are no more rows. - - - - - &reftitle.examples; - - SESAM fetch rows - -\n"; -$row = sesam_fetch_row($result, SESAM_SEEK_LAST); -while (is_array($row)) { - echo "\n"; - for ($col = 0; $col < $row["count"]; ++$col) { - echo "" . htmlspecialchars($row[$col]) . "\n"; - } - echo "\n"; - // use implied SESAM_SEEK_PRIOR - $row = sesam_fetch_row($result); -} -echo "\n"; -sesam_free_result($result); -?> -]]> - - - - - - &reftitle.seealso; - - - sesam_fetch_array - sesam_fetch_result - - - - - - - diff --git a/reference/sesam/functions/sesam-field-array.xml b/reference/sesam/functions/sesam-field-array.xml deleted file mode 100644 index 1e370c5c94..0000000000 --- a/reference/sesam/functions/sesam-field-array.xml +++ /dev/null @@ -1,235 +0,0 @@ - - - - - sesam_field_array - Return meta information about individual columns in a result - - - - &reftitle.description; - - arraysesam_field_array - stringresult_id - - - Returns a mixed associative/indexed array with meta information (column - name, type, precision, ...) about individual columns of the result after - the query associated with result_id. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - - - - - &reftitle.returnvalues; - - - - Mixed result set returned by <function>sesam_field_array</function> - - - - - Array Element - Contents - - - - - int $arr["count"] - - Total number of columns in result set (or zero if this was - an "immediate" query). SESAM "multiple fields" are - "inlined" and treated like the respective number of columns. - - - - string $arr[col]["name"] - - column name for column(col), where - col is between 0 and - $arr["count"]-1. The returned value can - be the empty string (for dynamically computed - columns). SESAM "multiple fields" are "inlined" and treated - like the respective number of columns, each with the same - column name. - - - - string $arr[col]["count"] - - The "count" attribute describes the repetition factor when - the column has been declared as a "multiple field". Usually, - the "count" attribute is 1. The first column of a "multiple - field" column however contains the number of repetitions - (the second and following column of the "multiple field" - contain a "count" attribute of 1). This can be used to - detect "multiple fields" in the result set. See the example - shown in the sesam_query description - for a sample use of the "count" attribute. - - - - string $arr[col]["type"] - - PHP variable type of the data for - column(col), where col - is between 0 and $arr["count"]-1. The - returned value can be one of - - - integer - - - float - - - string - - - depending on the SQL type of the result. SESAM "multiple - fields" are "inlined" and treated like the respective number - of columns, each with the same PHP type. - - - - - string $arr[col]["sqltype"] - - SQL variable type of the column data for - column(col), where col - is between 0 and $arr["count"]-1. The - returned value can be one of - - - "CHARACTER" - - - "VARCHAR" - - - "NUMERIC" - - - "DECIMAL" - - - "INTEGER" - - - "SMALLINT" - - - "FLOAT" - - - "REAL" - - - "DOUBLE" - - - "DATE" - - - "TIME" - - - "TIMESTAMP" - - - describing the SQL type of the result. SESAM "multiple - fields" are "inlined" and treated like the respective number - of columns, each with the same SQL type. - - - - - string $arr[col]["length"] - - The SQL "length" attribute of the SQL variable in - column(col), where col - is between 0 and $arr["count"]-1. The - "length" attribute is used with "CHARACTER" and "VARCHAR" - SQL types to specify the (maximum) length of the string - variable. SESAM "multiple fields" are "inlined" and treated - like the respective number of columns, each with the same - length attribute. - - - - string $arr[col]["precision"] - - The "precision" attribute of the SQL variable in - column(col), where col - is between 0 and $arr["count"]-1. The - "precision" attribute is used with numeric and time data - types. SESAM "multiple fields" are "inlined" and treated - like the respective number of columns, each with the same - precision attribute. - - - - string $arr[col]["scale"] - - The "scale" attribute of the SQL variable in - column(col), where col - is between 0 and $arr["count"]-1. The - "scale" attribute is used with numeric data types. SESAM - "multiple fields" are "inlined" and treated like the - respective number of columns, each with the same scale - attribute. - - - - -
- - - - - &reftitle.seealso; - - - sesam_query - - - - - - - diff --git a/reference/sesam/functions/sesam-field-name.xml b/reference/sesam/functions/sesam-field-name.xml deleted file mode 100644 index 6e5ee7ec3e..0000000000 --- a/reference/sesam/functions/sesam-field-name.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - sesam_field_name - Return one column name of the result set - - - - &reftitle.description; - - intsesam_field_name - stringresult_id - intindex - - - Gets the field name. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - index - - - The column index is zero-based, not one-based as in SESAM. - - - - - - - - - &reftitle.returnvalues; - - Returns the name of a field in the result set, or &false; on error. - - - For "immediate" queries, or for dynamic columns, an empty string - is returned. - - - - - &reftitle.seealso; - - - sesam_field_array. It provides an - easier interface to access the column names and types, and allows - for detection of "multiple fields". - - - - - - - diff --git a/reference/sesam/functions/sesam-free-result.xml b/reference/sesam/functions/sesam-free-result.xml deleted file mode 100644 index e52e68a094..0000000000 --- a/reference/sesam/functions/sesam-free-result.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - sesam_free_result - Releases resources for the query - - - - &reftitle.description; - - boolsesam_free_result - stringresult_id - - - Releases resources for the query. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/sesam/functions/sesam-num-fields.xml b/reference/sesam/functions/sesam-num-fields.xml deleted file mode 100644 index 452658a171..0000000000 --- a/reference/sesam/functions/sesam-num-fields.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - sesam_num_fields - Return the number of fields/columns in a result set - - - - &reftitle.description; - - intsesam_num_fields - stringresult_id - - - After calling sesam_query with a "select - type" query, this function gives you the number of columns in the - result. - - - For "immediate" statements, the value zero is returned. The SESAM - "multiple field" columns count as their respective dimension, - i.e., a three-column "multiple field" counts as three columns. - - - - - &reftitle.parameters; - - - - result_id - - - A valid result id returned by sesam_query. - - - - - - - - - &reftitle.returnvalues; - - Returns an integer describing the total number of columns (aka. fields) in - the current result_id result set or &false; on - error. - - - - - &reftitle.seealso; - - - sesam_query - sesam_field_array for a way to distinguish - between "multiple field" columns and regular columns. - - - - - - -