sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

White space, punctuation and some typos.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@60114 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Egon Schmid 2001-10-17 20:50:36 +00:00
parent 88887298f1
commit ba19739f4f
1 changed files with 222 additions and 196 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

418
functions/fbsql.xml
View file

@ -1,21 +1,21 @@
<?xml encoding="iso-8859-1"?>
<!-- $Revision: 1.29 $ -->
<!-- $Revision: 1.30 $ -->
<reference id="ref.fbsql">
<title>FrontBase functions</title>
<title>FrontBase Functions</title>
<titleabbrev>FrontBase</titleabbrev>
<partintro>
<simpara>
These functions allow you to access FrontBase database servers. In
order to have these functions available, you must compile php
with fbsql support by using the
<option role="configure">--with-fbsql</option> option. If you
use this option without specifying the path to fbsql, php will
search for the fbsql client libraries in the default installation
location for the platform. Users who installed FrontBase in
a non standard directory should always specify the path to fbsql:
<option role="configure">--with-fbsql=/path/to/fbsql</option>.
This will force php to use the client libraries installed by
FrontBase, avoiding any conflicts.
order to have these functions available, you must compile php with
fbsql support by using the <option
role="configure">--with-fbsql</option> option. If you use this
option without specifying the path to fbsql, php will search for
the fbsql client libraries in the default installation location
for the platform. Users who installed FrontBase in a non standard
directory should always specify the path to fbsql: <option
role="configure">--with-fbsql=/path/to/fbsql</option>. This will
force php to use the client libraries installed by FrontBase,
avoiding any conflicts.
</simpara>
<simpara>
More information about FrontBase can be found at <ulink
@ -33,8 +33,9 @@
<refentry id="function.fbsql-affected-rows">
<refnamediv>
<refname>fbsql_affected_rows</refname>
<refpurpose>Get number of affected rows in previous FrontBase
operation</refpurpose>
<refpurpose>
Get number of affected rows in previous FrontBase operation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -63,17 +64,17 @@
</para>
</note>
<para>
If the last query was a DELETE query with no WHERE clause, all
of the records will have been deleted from the table but this
If the last query was a DELETE query with no WHERE clause, all of
the records will have been deleted from the table but this
function will return zero.
</para>
<note>
<para>
When using UPDATE, FrontBase will not update columns where the new
value is the same as the old value. This creates the possiblity
that <function>fbsql_affected_rows</function> may not actually
equal the number of rows matched, only the number of rows that
were literally affected by the query.
When using UPDATE, FrontBase will not update columns where the
new value is the same as the old value. This creates the
possiblity that <function>fbsql_affected_rows</function> may not
actually equal the number of rows matched, only the number of
rows that were literally affected by the query.
</para>
</note>
<para>
@ -112,7 +113,7 @@
With OnOff set to &true; each statement will be commited
automatically, if no errors was found.
With OnOff set to &false; the user must commit or rollback
the transaction unsing either <function>fbsql_commit</function> or
the transaction using either <function>fbsql_commit</function> or
<function>fbsql_rollback</function>.
</para>
<para> See also:
@ -150,11 +151,11 @@
</funcsynopsis>
<para>
<function>fbsql_change_user</function> changes the logged in user
of the current active connection, or the connection given by the
optional parameter link_identifier. If a database is
specified, this will default or current database after the user
has been changed. If the new user and password authorization fails,
the current connected user stays active.
of the current active connection, or the connection given by the
optional parameter link_identifier. If a database is specified,
this will default or current database after the user has been
changed. If the new user and password authorization fails, the
current connected user stays active.
</para>
</refsect1>
</refentry>
@ -179,10 +180,11 @@
<para>
Returns: &true; on success, &false; on error.
</para>
<para> <function>fbsql_close</function> closes the connection to
the FrontBase server that's associated with the specified link
identifier. If <parameter>link_identifier</parameter> isn't
specified, the last opened link is used.
<para>
<function>fbsql_close</function> closes the connection to the
FrontBase server that's associated with the specified link
identifier. If <parameter>link_identifier</parameter> isn't
specified, the last opened link is used.
</para>
<para>
Using <function>fbsql_close</function> isn't usually necessary,
@ -228,10 +230,10 @@
Returns: &true; on success, &false; on failure.
</para>
<para>
<function>fbsql_commit</function> ends the current transaction
by writing all insertsm updates and deletes to the disk and unlucking
all row and table locks held by the transaction.
This command is only needed if autocommit is set to false.
<function>fbsql_commit</function> ends the current transaction by
writing all insertsm updates and deletes to the disk and
unlucking all row and table locks held by the transaction. This
command is only needed if autocommit is set to false.
</para>
<para> See also:
<function>fbsql_autocommit</function> and
@ -269,14 +271,14 @@
</funcprototype>
</funcsynopsis>
<para>
Returns a positive FrontBase link identifier on success, or an error
message on failure.
Returns a positive FrontBase link identifier on success, or an
error message on failure.
</para>
<para>
<function>fbsql_connect</function> establishes a connection
to a FrontBase server. The following defaults are assumed for
missing optional parameters: <parameter>hostname</parameter> =
'&null;', <parameter>username</parameter> = '_SYSTEM' and
<function>fbsql_connect</function> establishes a connection to a
FrontBase server. The following defaults are assumed for missing
optional parameters: <parameter>hostname</parameter> = '&null;',
<parameter>username</parameter> = '_SYSTEM' and
<parameter>password</parameter> = empty password.
</para>
<para>
@ -376,9 +378,9 @@
Returns: A resource handle to the newly created blob.
</para>
<para>
<function>fbsql_create_blob</function> creates a blob from blob_data.
The returned resource handle can be used with insert and update commands
to store the blob in the database.
<function>fbsql_create_blob</function> creates a blob from
blob_data. The returned resource handle can be used with insert
and update commands to store the blob in the database.
</para>
<example>
<title><function>fbsql_create_blob</function> example</title>
@ -398,11 +400,11 @@
?&gt;
</programlisting>
</example>
<para>See also:
<function>fbsql_create_clob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>,
<function>fbsql_set_lob_mode</function>
<para>
See also: <function>fbsql_create_clob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>, and
<function>fbsql_set_lob_mode</function>.
</para>
</refsect1>
</refentry>
@ -429,9 +431,9 @@
Returns: A resource handle to the newly created CLOB.
</para>
<para>
<function>fbsql_create_clob</function> creates a clob from clob_data.
The returned resource handle can be used with insert and update commands
to store the clob in the database.
<function>fbsql_create_clob</function> creates a clob from
clob_data. The returned resource handle can be used with insert
and update commands to store the clob in the database.
</para>
<example>
<title><function>fbsql_create_clob</function> example</title>
@ -451,11 +453,11 @@
?&gt;
</programlisting>
</example>
<para>See also:
<function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>,
<function>fbsql_set_lob_mode</function>
<para>
See also: <function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>, and
<function>fbsql_set_lob_mode</function>.
</para>
</refsect1>
</refentry>
@ -463,15 +465,20 @@
<refentry id="function.fbsql-database-password">
<refnamediv>
<refname>fbsql_database_password</refname>
<refpurpose>Sets or retreives the password for a FrontBase database</refpurpose>
<refpurpose>
Sets or retreives the password for a FrontBase database
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>fbsql_database_password</function></funcdef>
<paramdef>resource <parameter>link_identifier</parameter></paramdef>
<paramdef>string
<funcdef>string
<function>fbsql_database_password</function>
</funcdef>
<paramdef>resource
<parameter>link_identifier</parameter></paramdef>
<paramdef>string
<parameter>
<optional>database_password</optional>
</parameter>
@ -479,22 +486,22 @@
</funcprototype>
</funcsynopsis>
<para>
Returns: The database password for the database represented by the link
identifier.
Returns: The database password for the database represented by
the link identifier.
</para>
<para>
<function>fbsql_database_password</function> sets and retreives
the database password for the current database.
if the second optional parameter is given the function sets the
database password for the database on the server that's associated
with the specified link identifier. If no link identifier is specified,
the last opened link is assumed. If no link is open, the function will
try to establish a link as if <function>fbsql_connect</function> was
called, and use it.
the database password for the current database. if the second
optional parameter is given the function sets the database
password for the database on the server that's associated with
the specified link identifier. If no link identifier is
specified, the last opened link is assumed. If no link is open,
the function will try to establish a link as if
<function>fbsql_connect</function> was called, and use it.
</para>
<para> See also:
<function>fbsql_connect</function> and
<function>fbsql_pconnect</function>
<para>
See also: <function>fbsql_connect</function> and
<function>fbsql_pconnect</function>.
</para>
</refsect1>
</refentry>
@ -509,7 +516,9 @@
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>fbsql_data_seek</function></funcdef>
<paramdef>resource <parameter>result_identifier</parameter></paramdef>
<paramdef>resource
<parameter>result_identifier</parameter>
</paramdef>
<paramdef>int <parameter>row_number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@ -518,14 +527,14 @@
</para>
<para>
<function>fbsql_data_seek</function> moves the internal row
pointer of the FrontBase result associated with the specified result
identifier to point to the specified row number. The next call
to <function>fbsql_fetch_row</function> would return that row.
pointer of the FrontBase result associated with the specified
result identifier to point to the specified row number. The next
call to <function>fbsql_fetch_row</function> would return that
row.
</para>
<para>
<parameter>Row_number</parameter> starts at 0.
</para>
<example>
<title><function>fbsql_data_seek</function> example</title>
<programlisting role="php">
@ -581,15 +590,15 @@
</funcprototype>
</funcsynopsis>
<para>
Returns: A positive FrontBase result identifier to the query result,
or &false; on error.
Returns: A positive FrontBase result identifier to the query
result, or &false; on error.
</para>
<para>
<function>fbsql_db_query</function> selects a database and
executes a query on it. If the optional link identifier isn't
specified, the function will try to find an open link to the
FrontBase server and if no such link is found it'll try to create one
as if <function>fbsql_connect</function> was called with no
FrontBase server and if no such link is found it'll try to create
one as if <function>fbsql_connect</function> was called with no
arguments
</para>
<para>
@ -601,7 +610,7 @@
<refentry id="function.fbsql-db-status">
<refnamediv>
<refname>fbsql_db_status</refname>
<refpurpose>Get the status for a given database.</refpurpose>
<refpurpose>Get the status for a given database</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -620,9 +629,10 @@
Returns: An integer value with the current status.
</para>
<para>
<function>fbsql_db_status</function> requests the current
status of the database specified by <parameter>database_name</parameter>.
if the <parameter>link_identifier</parameter> is omitted the default
<function>fbsql_db_status</function> requests the current status
of the database specified by
<parameter>database_name</parameter>. If the
<parameter>link_identifier</parameter> is omitted the default
link_identifier will be used.
</para>
<para>
@ -632,8 +642,8 @@
<simpara>
&false; - The exec handler for the host was invalid. This
error will ocour when the link_identifier connects directly to
a database by using a port number. FBExec can be available on the
server but no connection has been made for it.
a database by using a port number. FBExec can be available on
the server but no connection has been made for it.
</simpara>
</listitem>
<listitem>
@ -671,9 +681,9 @@
</listitem>
</itemizedlist>
</para>
<para> See also:
<function>fbsql_start_db</function> and
<function>fbsql_stop_db</function>
<para>
See also: <function>fbsql_start_db</function> and
<function>fbsql_stop_db</function>.
</para>
</refsect1>
</refentry>
@ -710,8 +720,10 @@
<refentry id="function.fbsql-errno">
<refnamediv>
<refname>fbsql_errno</refname>
<refpurpose>Returns the numerical value of the error message from previous
FrontBase operation</refpurpose>
<refpurpose>
Returns the numerical value of the error message from previous
FrontBase operation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -730,14 +742,13 @@
<literal>0</literal> (zero) if no error occurred.
</para>
<para>
Errors coming back from the fbsql database backend dont
issue warnings. Instead, use <function>fbsql_errno</function> to
Errors coming back from the fbsql database backend dont issue
warnings. Instead, use <function>fbsql_errno</function> to
retrieve the error code. Note that this function only returns the
error code from the most recently executed fbsql function (not
including <function>fbsql_error</function> and
<function>fbsql_errno</function>), so if you want to use it,
make sure you check the value before calling another fbsql
function.
<function>fbsql_errno</function>), so if you want to use it, make
sure you check the value before calling another fbsql function.
<informalexample>
<programlisting role="php">
&lt;?php
@ -752,8 +763,8 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
</informalexample>
</para>
<para>
See also: <function>fbsql_error</function>,
<function>fbsql_warnings</function>
See also: <function>fbsql_error</function> and
<function>fbsql_warnings</function>.
</para>
</refsect1>
</refentry>
@ -761,8 +772,10 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
<refentry id="function.fbsql-error">
<refnamediv>
<refname>fbsql_error</refname>
<refpurpose>Returns the text of the error message from previous
FrontBase operation</refpurpose>
<refpurpose>
Returns the text of the error message from previous FrontBase
operation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -781,8 +794,8 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
<literal>''</literal> (the empty string) if no error occurred.
</para>
<para>
Errors coming back from the fbsql database backend dont
issue warnings. Instead, use <function>fbsql_error</function> to
Errors coming back from the fbsql database backend dont issue
warnings. Instead, use <function>fbsql_error</function> to
retrieve the error text. Note that this function only returns the
error text from the most recently executed fbsql function (not
including <function>fbsql_error</function> and
@ -802,8 +815,8 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
</informalexample>
</para>
<para>
See also: <function>fbsql_errno</function>,
<function>fbsql_warnings</function>
See also: <function>fbsql_errno</function> and
<function>fbsql_warnings</function>.
</para>
</refsect1>
</refentry>
@ -812,7 +825,8 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
<refnamediv>
<refname>fbsql_fetch_array</refname>
<refpurpose>
Fetch a result row as an associative array, a numeric array, or both.
Fetch a result row as an associative array, a numeric array, or
both
</refpurpose>
</refnamediv>
<refsect1>
@ -830,7 +844,8 @@ echo fbsql_errno().": ".fbsql_error()."&lt;BR>";
</funcsynopsis>
<para>
Returns an array that corresponds to the fetched row, or &false;
if there are no more rows.</para>
if there are no more rows.
</para>
<para>
<function>fbsql_fetch_array</function> is an extended version of
<function>fbsql_fetch_row</function>. In addition to storing the
@ -862,7 +877,8 @@ select t1.f1 as foo t2.f1 as bar from t1, t2
</para>
<para>
For further details, see also
<function>fbsql_fetch_row</function> and <function>fbsql_fetch_assoc</function>.
<function>fbsql_fetch_row</function> and
<function>fbsql_fetch_assoc</function>.
</para>
<example>
<title><function>fbsql_fetch_array</function> example</title>
@ -923,7 +939,8 @@ fbsql_free_result ($result);
</para>
<para>
For further details, see also
<function>fbsql_fetch_row</function> and <function>fbsql_fetch_array</function>.
<function>fbsql_fetch_row</function> and
<function>fbsql_fetch_array</function>.
</para>
<example>
<title><function>fbsql_fetch_assoc</function> example</title>
@ -1165,7 +1182,7 @@ fbsql_free_result ($result);
See also: <function>fbsql_fetch_array</function>,
<function>fbsql_fetch_object</function>,
<function>fbsql_data_seek</function>,
<function>fbsql_fetch_lengths</function> and
<function>fbsql_fetch_lengths</function>, and
<function>fbsql_result</function>.
</para>
</refsect1>
@ -1430,8 +1447,8 @@ fbsql_close();
</funcsynopsis>
<para>
<function>fbsql_insert_id</function> returns the ID generated for
an column defined as DEFAULT UNIQUE by the previous INSERT query using the
given <parameter>link_identifier</parameter>. If
an column defined as DEFAULT UNIQUE by the previous INSERT query
using the given <parameter>link_identifier</parameter>. If
<parameter>link_identifier</parameter> isn't specified, the last
opened link is assumed.
</para>
@ -1447,7 +1464,7 @@ fbsql_close();
<literal>LAST_INSERT_ID()</literal> always contains the most
recently generated DEFAULT UNIQUE value, and is not reset
between queries.
</para>
</para>
</note>
</refsect1>
</refentry>
@ -1485,7 +1502,7 @@ $link = fbsql_connect('localhost', 'myname', 'secret');
$db_list = fbsql_list_dbs($link);
while ($row = fbsql_fetch_object($db_list)) {
echo $row->Database . "\n";
echo $row->Database . "\n";
}
</programlisting>
</example>
@ -1535,7 +1552,7 @@ database3
the table name. A result pointer is returned which can be used
with <function>fbsql_field_flags</function>,
<function>fbsql_field_len</function>,
<function>fbsql_field_name</function> and
<function>fbsql_field_name</function>, and
<function>fbsql_field_type</function>.
</para>
<para>
@ -1555,7 +1572,7 @@ $fields = fbsql_list_fields("database1", "table1", $link);
$columns = fbsql_num_fields($fields);
for ($i = 0; $i &lt; $columns; $i++) {
echo fbsql_field_name($fields, $i) . "\n";;
echo fbsql_field_name($fields, $i) . "\n";;
}
</programlisting>
</example>
@ -1605,7 +1622,9 @@ field3
<refentry id="function.fbsql-next-result">
<refnamediv>
<refname>fbsql_next_result</refname>
<refpurpose>Move the internal result pointer to the next result</refpurpose>
<refpurpose>
Move the internal result pointer to the next result
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -1618,13 +1637,14 @@ field3
</funcprototype>
</funcsynopsis>
<para>
When sending more than one SQL statement to the server or executing a stored procedure
with multiple results will cause the server to return multiple result sets.
This function will test for additional results available form the server. if an
additional result set exists it will free the existing result set and prepare to
fetch the wors from the new result set.
The function will return &true; if an additional result set was
available or &false; othervise.
When sending more than one SQL statement to the server or
executing a stored procedure with multiple results will cause the
server to return multiple result sets. This function will test
for additional results available form the server. If an
additional result set exists it will free the existing result set
and prepare to fetch the words from the new result set. The
function will return &true; if an additional result set was
available or &false; otherwise.
</para>
<example>
<title><function>fbsql_next_result</function> example</title>
@ -1667,8 +1687,9 @@ field3
See also:
<function>fbsql_db_query</function>,
<function>fbsql_query</function>,
<function>fbsql_fetch_field</function>,
<function>fbsql_num_rows</function>.</para>
<function>fbsql_fetch_field</function>, and
<function>fbsql_num_rows</function>.
</para>
</refsect1>
</refentry>
@ -1687,8 +1708,8 @@ field3
</funcsynopsis>
<para>
<function>fbsql_num_rows</function> returns the number of rows in
a result set. This command is only valid for SELECT statements.
To retrieve the number of rows returned from a INSERT, UPDATE or
a result set. This command is only valid for SELECT statements.
To retrieve the number of rows returned from a INSERT, UPDATE or
DELETE query, use <function>fbsql_affected_rows</function>.
<example>
<title><function>fbsql_num_rows</function> example</title>
@ -1708,10 +1729,9 @@ echo "$num_rows Rows\n";
</example>
</para>
<para>
See also:
<function>fbsql_affected_rows</function>,
<function>fbsql_connect</function>,
<function>fbsql_select_db</function> and
See also: <function>fbsql_affected_rows</function>,
<function>fbsql_connect</function>,
<function>fbsql_select_db</function>, and
<function>fbsql_query</function>.
</para>
</refsect1>
@ -1741,8 +1761,8 @@ echo "$num_rows Rows\n";
</funcprototype>
</funcsynopsis>
<para>
Returns: A positive FrontBase persistent link identifier on success,
or &false; on error.
Returns: A positive FrontBase persistent link identifier on
success, or &false; on error.
</para>
<para>
<function>fbsql_pconnect</function> establishes a connection
@ -1756,7 +1776,8 @@ echo "$num_rows Rows\n";
<function>fbsql_connect</function> with two major differences.
</para>
<para>
To set Frontbase server port number, use <function>fbsql_select_db</function>.
To set Frontbase server port number, use
<function>fbsql_select_db</function>.
</para>
<para>
First, when connecting, the function would first try to find a
@ -1842,9 +1863,9 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
</example>
</para>
<para>
<function>fbsql_query</function> will also fail and return &false;
if you don't have permission to access the table(s) referenced by
the query.
<function>fbsql_query</function> will also fail and return
&false; if you don't have permission to access the table(s)
referenced by the query.
</para>
<para>
Assuming the query succeeds, you can call
@ -1868,7 +1889,7 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<function>fbsql_db_query</function>,
<function>fbsql_free_result</function>,
<function>fbsql_result</function>,
<function>fbsql_select_db</function> and
<function>fbsql_select_db</function>, and
<function>fbsql_connect</function>.
</para>
</refsect1>
@ -1896,13 +1917,14 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
Returns: A string containing the BLOB specified by blob_handle.
</para>
<para>
<function>fbsql_read_blob</function> reads BLOB data from the database.
If a select statement contains BLOB and/or BLOB columns FrontBase
will return the data directly when data is fetched. This default
behavior can be changed with <function>fbsql_set_lob_mode</function> so
the fetch functions will return handles to BLOB and CLOB data.
If a handle is fetched a user must call <function>fbsql_read_blob</function>
to get the actual BLOB data from the database.
<function>fbsql_read_blob</function> reads BLOB data from the
database. If a select statement contains BLOB and/or BLOB
columns FrontBase will return the data directly when data is
fetched. This default behavior can be changed with
<function>fbsql_set_lob_mode</function> so the fetch functions
will return handles to BLOB and CLOB data. If a handle is
fetched a user must call <function>fbsql_read_blob</function> to
get the actual BLOB data from the database.
</para>
<example>
<title><function>fbsql_read_blob</function> example</title>
@ -1926,11 +1948,11 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
?&gt;
</programlisting>
</example>
<para>See also:
<function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>,
<function>fbsql_set_lob_mode</function>
<para>
See also: <function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>, and
<function>fbsql_set_lob_mode</function>.
</para>
</refsect1>
</refentry>
@ -1957,13 +1979,14 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
Returns: A string containing the CLOB specified by clob_handle.
</para>
<para>
<function>fbsql_read_clob</function> reads CLOB data from the database.
If a select statement contains BLOB and/or CLOB columns FrontBase
will return the data directly when data is fetched. This default
behavior can be changed with <function>fbsql_set_lob_mode</function> so
the fetch functions will return handles to BLOB and CLOB data.
If a handle is fetched a user must call <function>fbsql_read_clob</function>
to get the actual CLOB data from the database.
<function>fbsql_read_clob</function> reads CLOB data from the
database. If a select statement contains BLOB and/or CLOB
columns FrontBase will return the data directly when data is
fetched. This default behavior can be changed with
<function>fbsql_set_lob_mode</function> so the fetch functions
will return handles to BLOB and CLOB data. If a handle is
fetched a user must call <function>fbsql_read_clob</function> to
get the actual CLOB data from the database.
</para>
<example>
<title><function>fbsql_read_clob</function> example</title>
@ -1987,11 +2010,11 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
?&gt;
</programlisting>
</example>
<para>See also:
<function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>,
<function>fbsql_set_lob_mode</function>
<para>
See also: <function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>,
<function>fbsql_read_clob</function>, and
<function>fbsql_set_lob_mode</function>.
</para>
</refsect1>
</refentry>
@ -2039,7 +2062,7 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<para>
Recommended high-performance alternatives:
<function>fbsql_fetch_row</function>,
<function>fbsql_fetch_array</function> and
<function>fbsql_fetch_array</function>, and
<function>fbsql_fetch_object</function>.
</para>
</refsect1>
@ -2080,7 +2103,9 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<refentry id="function.fbsql-set-lob-mode">
<refnamediv>
<refname>fbsql_set_lob_mode</refname>
<refpurpose>Set the LOB retreive mode for a FrontBase result set</refpurpose>
<refpurpose>
Set the LOB retreive mode for a FrontBase result set
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -2096,30 +2121,31 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
</para>
<para>
<function>fbsql_set_lob_mode</function> sets the mode for
retreiving LOB data from the database. When BLOB and CLOB data
is stored in FrontBase it can be stored direct or indirect.
Direct stored LOB data will allways be fetched no matter the setting
of the lob mode. If the LOB data is less than 512 bytes it will allways
be stored directly.
retreiving LOB data from the database. When BLOB and CLOB data is
stored in FrontBase it can be stored direct or indirect. Direct
stored LOB data will allways be fetched no matter the setting of
the lob mode. If the LOB data is less than 512 bytes it will
allways be stored directly.
<itemizedlist>
<listitem>
<simpara>
FBSQL_LOB_DIRECT - LOB data is retreived directly. When data is
fetched from the database with <function>fbsql_fetch_row</function>,
and other fetch functions, all CLOB and BLOB columns will be returned
as ordinary coluimns.
This is the default value on a new FrontBase resutl.
FBSQL_LOB_DIRECT - LOB data is retreived directly. When data
is fetched from the database with
<function>fbsql_fetch_row</function>, and other fetch
functions, all CLOB and BLOB columns will be returned as
ordinary columns. This is the default value on a new
FrontBase result.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_LOB_HANDLE - LOB data is retreived as handles to the data.
When data is fetched from the database with <function>fbsql_fetch_row
</function>, and other fetch functions, LOB data will be returned as
a handle to the data if the data is stored indirect or the data if it
is stored direct.
If a handle is returned it will be a 27 byte string formated as
"@'000000000000000000000000'".
FBSQL_LOB_HANDLE - LOB data is retreived as handles to the
data. When data is fetched from the database with
<function>fbsql_fetch_row </function>, and other fetch
functions, LOB data will be returned as a handle to the data
if the data is stored indirect or the data if it is stored
direct. If a handle is returned it will be a 27 byte string
formated as "@'000000000000000000000000'".
</simpara>
</listitem>
</itemizedlist>
@ -2127,8 +2153,8 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<para> See also:
<function>fbsql_create_blob</function>,
<function>fbsql_create_clob</function>,
<function>fbsql_read_blob</function> and
<function>fbsql_read_clob</function>
<function>fbsql_read_blob</function>, and
<function>fbsql_read_clob</function>.
</para>
</refsect1>
</refentry>
@ -2164,11 +2190,11 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
</para>
<para>
The client contacts FBExec to obtain the port number to use for
the connection to the database. if the database name is a number
the connection to the database. If the database name is a number
the system will use that as a port number and it will not ask
FBExec for the port number.
The FrontBase server can be stared as
FRontBase -FBExec=No -port=&lt;port number&gt; &lt;database name&gt;.
FBExec for the port number. The FrontBase server can be stared
as FRontBase -FBExec=No -port=&lt;port number&gt; &lt;database
name&gt;.
</para>
<para>
Every subsequent call to <function>fbsql_query</function> will be
@ -2176,7 +2202,7 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
</para>
<para> See also:
<function>fbsql_connect</function>,
<function>fbsql_pconnect</function> and
<function>fbsql_pconnect</function>, and
<function>fbsql_query</function>.
</para>
</refsect1>
@ -2206,9 +2232,9 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<para>
<function>fbsql_start_db</function>
</para>
<para> See also:
<function>fbsql_db_status</function> and
<function>fbsql_stop_db</function>
<para>
See also: <function>fbsql_db_status</function> and
<function>fbsql_stop_db</function>.
</para>
</refsect1>
</refentry>
@ -2237,9 +2263,9 @@ $result = fbsql_query ("SELECT my_col FROM my_tbl")
<para>
<function>fbsql_stop_db</function>
</para>
<para> See also:
<function>fbsql_db_status</function> and
<function>fbsql_start_db</function>
<para>
See also: <function>fbsql_db_status</function> and
<function>fbsql_start_db</function>.
</para>
</refsect1>
</refentry>