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

ref.fbsql: switch to new style

Browse source 
and document 7 functions


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227795 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-01-22 00:22:11 +00:00
parent dedf883206
commit 40243d10c9
57 changed files with 2500 additions and 721 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
reference/fbsql/functions/fbsql-affected-rows.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-affected-rows">
<refnamediv>
<refname>fbsql_affected_rows</refname>
<refpurpose>Get number of affected rows in previous FrontBase operation</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_affected_rows</methodname>
@ -14,9 +15,7 @@
<para>
<function>fbsql_affected_rows</function> returns the number
of rows affected by the last INSERT, UPDATE or DELETE query
associated with <parameter>link_identifier</parameter>. If the
link identifier isn't specified, the last link opened by
<function>fbsql_connect</function> is assumed.
associated with <parameter>link_identifier</parameter>.
</para>
<note>
<para>
@ -39,11 +38,30 @@
rows that were literally affected by the query.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If the last query failed, this function will return -1.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>fbsql_num_rows</function>.
<simplelist>
<member><function>fbsql_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

63
reference/fbsql/functions/fbsql-autocommit.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-autocommit">
<refnamediv>
<refname>fbsql_autocommit</refname>
<refpurpose>Enable or disable autocommit</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_autocommit</methodname>
@ -13,20 +14,54 @@
<methodparam choice="opt"><type>bool</type><parameter>OnOff</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_autocommit</function> returns the current
autocommit status. If the optional OnOff parameter is
given the auto commit status will be changed.
With OnOff set to &true; each statement will be committed
automatically, if no errors was found.
With OnOff set to &false; the user must commit or rollback
the transaction using either <function>fbsql_commit</function> or
<function>fbsql_rollback</function>.
</para>
<para>
See also: <function>fbsql_commit</function> and
<function>fbsql_rollback</function>
Returns the current autocommit status.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>OnOff</parameter></term>
<listitem>
<para>
If this optional parameter is given the auto commit status will be
changed.
</para>
<para>
With <parameter>OnOff</parameter> set to &true; each statement will be
committed automatically, if no errors was found.
</para>
<para>
With OnOff set to &false; the user must commit or rollback the
transaction using either <function>fbsql_commit</function> or
<function>fbsql_rollback</function>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current autocommit status, as a boolean.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_commit</function></member>
<member><function>fbsql_rollback</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/fbsql/functions/fbsql-blob-size.xml
View file

@ -1,21 +1,56 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.fbsql-blob-size">
<refnamediv>
<refname>fbsql_blob_size</refname>
<refpurpose>Get the size of a BLOB</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_blob_size</methodname>
<methodparam><type>string</type><parameter>blob_handle</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the size of the given BLOB.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A BLOB handle, returned by <function>fbsql_create_blob</function>.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the BLOB size as an integer, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_clob_size</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

57
reference/fbsql/functions/fbsql-change-user.xml
View file

@ -1,26 +1,65 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-change-user">
<refnamediv>
<refname>fbsql_change_user</refname>
<refpurpose>Change logged in user of the active connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_change_user</methodname>
<type>bool</type><methodname>fbsql_change_user</methodname>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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.
<function>fbsql_change_user</function> changes the logged in user of the
specified connection. If the new user and password authorization fails,
the current connected user stays active.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The new user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The new user password.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
If specified, this will be the default or current database after the
user has been changed.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

45
reference/fbsql/functions/fbsql-clob-size.xml
View file

@ -1,21 +1,56 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.fbsql-clob-size">
<refnamediv>
<refname>fbsql_clob_size</refname>
<refpurpose>Get the size of a CLOB</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_clob_size</methodname>
<methodparam><type>string</type><parameter>clob_handle</parameter></methodparam>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Returns the size of the given CLOB.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>clob_handle</parameter></term>
<listitem>
<para>
A CLOB handle, returned by <function>fbsql_create_clob</function>.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the CLOB size as an integer, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_blob_size</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

73
reference/fbsql/functions/fbsql-close.xml
View file

@ -1,48 +1,73 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-close">
<refnamediv>
<refname>fbsql_close</refname>
<refpurpose>Close FrontBase connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_close</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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.
Closes the connection to the FrontBase server that's associated with the
specified link identifier.
</para>
<para>
Using <function>fbsql_close</function> isn't usually necessary,
as non-persistent open links are automatically closed at the end
of the script's execution.
</para>
<example>
<title><function>fbsql_close</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_connect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
echo "Connected successfully";
fbsql_close($link);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also: <function>fbsql_connect</function> and
<function>fbsql_pconnect</function>.
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_close</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_connect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
echo "Connected successfully";
fbsql_close($link);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_connect</function></member>
<member><function>fbsql_pconnect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

46
reference/fbsql/functions/fbsql-commit.xml
View file

@ -1,30 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-commit">
<refnamediv>
<refname>fbsql_commit</refname>
<refpurpose>Commits a transaction to the database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_commit</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>fbsql_commit</function> ends the current transaction by
writing all inserts, updates and deletes to the disk and
unlocking 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
<function>fbsql_rollback</function>
Ends the current transaction by writing all inserts, updates and deletes
to the disk and unlocking all row and table locks held by the transaction.
This command is only needed if autocommit is set to false.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_autocommit</function></member>
<member><function>fbsql_rollback</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

93
reference/fbsql/functions/fbsql-connect.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-connect">
<refnamediv>
<refname>fbsql_connect</refname>
<refpurpose>Open a connection to a FrontBase Server</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_connect</methodname>
@ -13,16 +14,9 @@
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
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
<parameter>password</parameter> = empty password.
FrontBase server.
</para>
<para>
If a second call is made to <function>fbsql_connect</function>
@ -35,27 +29,80 @@
the script ends, unless it's closed earlier by explicitly calling
<function>fbsql_close</function>.
</para>
<example>
<title><function>fbsql_connect</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The server host name. Defaults to '&null;'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The user name for the connection. Defaults to
<literal>_SYSTEM</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The user name for the connection. Defaults to the empty string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive FrontBase link identifier on success, or &false; on
errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_connect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
echo "Connected successfully";
fbsql_close($link);
$link = fbsql_connect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
echo "Connected successfully";
fbsql_close($link);
?>
]]>
</programlisting>
</example>
<para>
See also
<function>fbsql_pconnect</function> and
<function>fbsql_close</function>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_pconnect</function></member>
<member><function>fbsql_close</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

66
reference/fbsql/functions/fbsql-create-blob.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-create-blob">
<refnamediv>
<refname>fbsql_create_blob</refname>
<refpurpose>Create a BLOB</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_create_blob</methodname>
@ -13,16 +14,41 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A resource handle to the newly created blob.
Creates a BLOB from the given data.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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.
<variablelist>
<varlistentry>
<term><parameter>blob_data</parameter></term>
<listitem>
<para>
The BLOB data.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
<example>
<title><function>fbsql_create_blob</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a resource handle to the newly created BLOB, which can be used
with insert and update commands to store the BLOB in the database.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_create_blob</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -38,15 +64,23 @@ $sql = "INSERT INTO BLOB_TABLE (BLOB_COLUMN) VALUES ($blobHandle);";
$rs = fbsql_query($sql, $link);
?>
]]>
</programlisting>
</example>
<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>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_clob</function></member>
<member><function>fbsql_read_blob</function></member>
<member><function>fbsql_read_clob</function></member>
<member><function>fbsql_set_lob_mode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

66
reference/fbsql/functions/fbsql-create-clob.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-create-clob">
<refnamediv>
<refname>fbsql_create_clob</refname>
<refpurpose>Create a CLOB</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_create_clob</methodname>
@ -13,16 +14,41 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A resource handle to the newly created CLOB.
Creates a CLOB from the given data.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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.
<variablelist>
<varlistentry>
<term><parameter>clob_data</parameter></term>
<listitem>
<para>
The CLOB data.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
<example>
<title><function>fbsql_create_clob</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a resource handle to the newly created CLOB, which can be used
with insert and update commands to store the CLOB in the database.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_create_clob</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -38,15 +64,23 @@ $sql = "INSERT INTO CLOB_TABLE (CLOB_COLUMN) VALUES ($clobHandle);";
$rs = fbsql_query($sql, $link);
?>
]]>
</programlisting>
</example>
<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>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_blob</function></member>
<member><function>fbsql_read_blob</function></member>
<member><function>fbsql_read_clob</function></member>
<member><function>fbsql_set_lob_mode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

79
reference/fbsql/functions/fbsql-create-db.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<!-- $Revision: 1.10 $ -->
<refentry id="function.fbsql-create-db">
<refnamediv>
<refname>fbsql_create_db</refname>
<refpurpose>Create a FrontBase database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_create_db</methodname>
@ -14,29 +15,69 @@
<methodparam choice="opt"><type>string</type><parameter>database_options</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_create_db</function> attempts to create a new
database named <parameter>database_name</parameter> on the server
associated with the specified connection
<parameter>link_identifier</parameter>.
Attempts to create a new database on the specied server.
</para>
<example>
<title><function>fbsql_create_db</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name, as a string.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>database_options</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_create_db</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
if (fbsql_create_db("my_db")) {
echo "Database created successfully\n";
} else {
printf("Error creating database: %s\n", fbsql_error());
}
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
or die("Could not connect");
if (fbsql_create_db("my_db")) {
echo "Database created successfully\n";
} else {
printf("Error creating database: %s\n", fbsql_error());
}
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>fbsql_drop_db</function>.
<simplelist>
<member><function>fbsql_drop_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

55
reference/fbsql/functions/fbsql-data-seek.xml
View file

@ -1,33 +1,58 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-data-seek">
<refnamediv>
<refname>fbsql_data_seek</refname>
<refpurpose>Move internal result pointer</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_data_seek</methodname>
<methodparam><type>resource</type><parameter>result_identifier</parameter></methodparam>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>row_number</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
Moves the internal row pointer of the FrontBase result associated with the
specified result identifier to point to the specified row number.
</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
The next call to <function>fbsql_fetch_row</function> would return that
row.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<parameter>Row_number</parameter> starts at 0.
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>row_number</parameter></term>
<listitem>
<para>
The row number. Starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<example>
<title><function>fbsql_data_seek</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_data_seek</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -57,9 +82,11 @@ for ($i = fbsql_num_rows($result) - 1; $i >=0; $i--) {
fbsql_free_result($result);
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

74
reference/fbsql/functions/fbsql-database-password.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-database-password">
<refnamediv>
<refname>fbsql_database_password</refname>
<refpurpose>Sets or retrieves the password for a FrontBase database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_database_password</methodname>
@ -13,26 +14,51 @@
<methodparam choice="opt"><type>string</type><parameter>database_password</parameter></methodparam>
</methodsynopsis>
<para>
Returns: The database password associated with the link identifier.
Sets and retrieves the database password used by the connection. If a
database is protected by a database password, the user must call this
function before calling <function>fbsql_select_db</function>.
</para>
<para>
<function>fbsql_database_password</function> sets and retrieves
the database password used by the connection. if a database is
protected by a database password, the user must call this function
before calling <function>fbsql_select_db</function>. if the second
optional parameter is given the function sets the database
password for 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
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>
This function does not change the database password in the database
nor can it be used to retrieve the database password for a database.
</para>
<example>
<title><function>fbsql_create_clob</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>database_password</parameter></term>
<listitem>
<para>
The database password, as a string. If given, the function sets the
database password for the specified link identifier.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the database password associated with the link identifier.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_create_clob</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -41,14 +67,22 @@ fbsql_database_password($link, "secret db password");
fbsql_select_db($database, $link);
?>
]]>
</programlisting>
</example>
<para>
See also: <function>fbsql_connect</function>,
<function>fbsql_pconnect</function> and
<function>fbsql_select_db</function>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_connect</function></member>
<member><function>fbsql_pconnect</function></member>
<member><function>fbsql_select_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

32
reference/fbsql/functions/fbsql-database.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-database'>
<refnamediv>
<refname>fbsql_database</refname>
<refpurpose>Get or set the database name used with a connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_database</methodname>
@ -13,7 +14,32 @@
<methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
</methodsynopsis>
<para>
&warn.undocumented.func;
Get or set the database name used with the connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database name. If given, the default database of the connexion
will be changed to <parameter>database</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the database used with this connection.
</para>
</refsect1>
</refentry>

59
reference/fbsql/functions/fbsql-db-query.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-db-query">
<refnamediv>
<refname>fbsql_db_query</refname>
<refpurpose>Send a FrontBase query</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_db_query</methodname>
@ -14,19 +15,55 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A positive FrontBase result identifier to the query
result, or &false; on error.
Selects a database and executes a query on it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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
arguments
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database to be selected.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The SQL query to be executed.
</para>
<note>
<para>
The query string shall always end with a semicolon.
</para>
</note>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
See also <function>fbsql_connect</function>.
Returns a positive FrontBase result identifier to the query result, or
&false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_query</function></member>
<member><function>fbsql_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

69
reference/fbsql/functions/fbsql-db-status.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-db-status">
<refnamediv>
<refname>fbsql_db_status</refname>
<refpurpose>Get the status for a given database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_db_status</methodname>
@ -13,66 +14,88 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: An integer value with the current status.
Gets the current status of the specified database.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<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
link_identifier will be used.
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The return value can be one of the following constants:
Returns an integer value with the current status. This can be one of the
following constants:
<itemizedlist>
<listitem>
<simpara>
&false; - The exec handler for the host was invalid. This
error will occur 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.
&false; - The exec handler for the host was invalid. This error will
occur when the <parameter>link_identifier</parameter> 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.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_UNKNOWN - The Status is unknown.
<constant>FBSQL_UNKNOWN</constant> - The Status is unknown.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STOPPED - The database is not running. Use
<constant>FBSQL_STOPPED</constant> - The database is not running. Use
<function>fbsql_start_db</function> to start the database.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STARTING - The database is starting.
<constant>FBSQL_STARTING</constant> - The database is starting.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_RUNNING - The database is running and can be used to
perform SQL operations.
<constant>FBSQL_RUNNING</constant> - The database is running and can be
used to perform SQL operations.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_STOPPING - The database is stopping.
<constant>FBSQL_STOPPING</constant> - The database is stopping.
</simpara>
</listitem>
<listitem>
<simpara>
FBSQL_NOEXEC - FBExec is not running on the server and it is not
possible to get the status of the database.
<constant>FBSQL_NOEXEC</constant> - FBExec is not running on the server
and it is not possible to get the status of the database.
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>fbsql_start_db</function> and
<function>fbsql_stop_db</function>.
<simplelist>
<member><function>fbsql_start_db</function></member>
<member><function>fbsql_stop_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

47
reference/fbsql/functions/fbsql-drop-db.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-drop-db">
<refnamediv>
<refname>fbsql_drop_db</refname>
<refpurpose>Drop (delete) a FrontBase database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_drop_db</methodname>
@ -13,14 +14,44 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>fbsql_drop_db</function> attempts to drop (remove) an
entire database from the server associated with the specified
link identifier.
<function>fbsql_drop_db</function> attempts to drop (remove) an entire
database from the server associated with the specified link identifier.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name, as a string.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

63
reference/fbsql/functions/fbsql-errno.xml
View file

@ -1,29 +1,53 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<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 error number from previous operation</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_errno</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the numerical value of the error message from previous FrontBase
operation.
</para>
<para>
Errors coming back from the fbsql database backend don't 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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error number from the last fbsql function, or
<literal>0</literal> (zero) if no error occurred.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Errors coming back from the fbsql database backend don't 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.
<informalexample>
<example>
<title><function>fbsql_errno</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -36,13 +60,20 @@ echo fbsql_errno() . ": " . fbsql_error() . "<br />";
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>fbsql_error</function> and
<function>fbsql_warnings</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_error</function></member>
<member><function>fbsql_warnings</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

62
reference/fbsql/functions/fbsql-error.xml
View file

@ -1,29 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<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 error message from previous operation</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_error</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns the error message from previous FrontBase operation.
</para>
<para>
Errors coming back from the fbsql database backend don't issue warnings.
Instead, use <function>fbsql_error</function> to retrieve the error text.
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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the error text from the last fbsql function, or
<literal>''</literal> (the empty string) if no error occurred.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
Errors coming back from the fbsql database backend don't 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
<function>fbsql_errno</function>), so if you want to use it, make
sure you check the value before calling another fbsql function.
<informalexample>
<example>
<title><function>fbsql_error</function> Example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -36,13 +59,20 @@ echo fbsql_errno() . ": " . fbsql_error() . "<br />";
?>
]]>
</programlisting>
</informalexample>
</para>
<para>
See also: <function>fbsql_errno</function> and
<function>fbsql_warnings</function>.
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_errno</function></member>
<member><function>fbsql_warnings</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

93
reference/fbsql/functions/fbsql-fetch-array.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-fetch-array">
<refnamediv>
<refname>fbsql_fetch_array</refname>
<refpurpose>Fetch a result row as an associative array, a numeric array, or both</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fbsql_fetch_array</methodname>
@ -13,14 +14,47 @@
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<para>
Returns an array that corresponds to the fetched row, or &false;
if there are no more rows.
<function>fbsql_fetch_array</function> is a combination of
<function>fbsql_fetch_row</function> and
<function>fbsql_fetch_assoc</function>.
</para>
<para>
<function>fbsql_fetch_array</function> is an extended version of
<function>fbsql_fetch_row</function>. In addition to storing the
data in the numeric indices of the result array, it also stores
the data in associative indices, using the field names as keys.
An important thing to note is that using
<function>fbsql_fetch_array</function> is NOT significantly
slower than using <function>fbsql_fetch_row</function>, while it
provides a significant added value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>result_type</parameter></term>
<listitem>
<para>
A constant and can take the following values:
<constant>FBSQL_ASSOC</constant>, <constant>FBSQL_NUM</constant>, or
<constant>FBSQL_BOTH</constant>.
</para>
<para>
When using <constant>FBSQL_BOTH</constant>, in addition to storing the
data in the numeric indices of the result array, it also stores the
data in associative indices, using the field names as keys.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row, or &false;
if there are no more rows.
</para>
<para>
If two or more columns of the result have the same field names,
@ -35,26 +69,14 @@ select t1.f1 as foo t2.f1 as bar from t1, t2
</programlisting>
</informalexample>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
An important thing to note is that using
<function>fbsql_fetch_array</function> is NOT significantly
slower than using <function>fbsql_fetch_row</function>, while it
provides a significant added value.
</para>
<para>
The optional second argument <parameter>result_type</parameter>
in <function>fbsql_fetch_array</function> is a constant and can
take the following values: FBSQL_ASSOC, FBSQL_NUM, and
FBSQL_BOTH.
</para>
<para>
For further details, see also
<function>fbsql_fetch_row</function> and
<function>fbsql_fetch_assoc</function>.
</para>
<example>
<title><function>fbsql_fetch_array</function> example</title>
<programlisting role="php">
<example>
<title><function>fbsql_fetch_array</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
fbsql_connect($host, $user, $password);
@ -68,9 +90,22 @@ while ($row = fbsql_fetch_array($result)) {
fbsql_free_result($result);
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_fetch_row</function></member>
<member><function>fbsql_fetch_assoc</function></member>
<member><function>fbsql_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

73
reference/fbsql/functions/fbsql-fetch-assoc.xml
View file

@ -1,47 +1,65 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-fetch-assoc">
<refnamediv>
<refname>fbsql_fetch_assoc</refname>
<refpurpose>Fetch a result row as an associative array</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fbsql_fetch_assoc</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns an associative array that corresponds to the fetched row,
or &false; if there are no more rows.</para>
Calling <function>fbsql_fetch_assoc</function> is equivalent to calling
<function>fbsql_fetch_array</function> with
<constant>FBSQL_ASSOC</constant> as second parameter. It only returns an
associative array.
</para>
<para>
<function>fbsql_fetch_assoc</function> is equivalent to calling
<function>fbsql_fetch_array</function> with FBSQL_ASSOC for the
optional second parameter. It only returns an associative array.
This is the way <function>fbsql_fetch_array</function> originally
worked. If you need the numeric indices as well as the
associative, use <function>fbsql_fetch_array</function>.
</para>
<para>
If two or more columns of the result have the same field names,
the last column will take precedence. To access the other column(s)
of the same name, you must use <function>fbsql_fetch_array</function> and
have it return the numeric indices as well.
</para>
<para>
An important thing to note is that using
<function>fbsql_fetch_assoc</function> is NOT significantly
slower than using <function>fbsql_fetch_row</function>, while it
provides a significant added value.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
For further details, see also
<function>fbsql_fetch_row</function> and
<function>fbsql_fetch_array</function>.
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
<example>
<title><function>fbsql_fetch_assoc</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array that corresponds to the fetched row, or
&false; if there are no more rows.
</para>
<para>
If two or more columns of the result have the same field names, the last
column will take precedence. To access the other column(s) of the same
name, you must use <function>fbsql_fetch_array</function> and have it
return the numeric indices as well.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_fetch_assoc</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
fbsql_connect($host, $user, $password);
@ -53,9 +71,22 @@ while ($row = fbsql_fetch_assoc($result)) {
fbsql_free_result($result);
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_fetch_row</function></member>
<member><function>fbsql_fetch_array</function></member>
<member><function>fbsql_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

59
reference/fbsql/functions/fbsql-fetch-field.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-fetch-field">
<refnamediv>
<refname>fbsql_fetch_field</refname>
<refpurpose>Get column information from a result and return as an object</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>fbsql_fetch_field</methodname>
@ -13,13 +14,33 @@
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
Returns an object containing field information.
Used in order to obtain information about fields in a certain query result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<function>fbsql_fetch_field</function> can be used in order to
obtain information about fields in a certain query result. If
the field offset isn't specified, the next field that wasn't yet
retrieved by <function>fbsql_fetch_field</function> is retrieved.
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
If not specified, the next field that wasn't yet retrieved by
<function>fbsql_fetch_field</function> is retrieved.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object containing field information, or &false; on errors.
</para>
<para>
The properties of the object are:
@ -51,9 +72,14 @@
</listitem>
</itemizedlist>
</para>
<example>
<title><function>fbsql_fetch_field</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_fetch_field</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
fbsql_connect($host, $user, $password)
@ -80,10 +106,17 @@ type: $meta->type
fbsql_free_result($result);
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also <function>fbsql_field_seek</function>.
<simplelist>
<member><function>fbsql_field_seek</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

44
reference/fbsql/functions/fbsql-fetch-lengths.xml
View file

@ -1,31 +1,49 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-fetch-lengths">
<refnamediv>
<refname>fbsql_fetch_lengths</refname>
<refpurpose>Get the length of each output in a result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fbsql_fetch_lengths</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns: An array that corresponds to the lengths of each field
in the last row fetched by <function>fbsql_fetch_row</function>,
Stores the lengths of each result column in the last row returned by
<function>fbsql_fetch_row</function>,
<function>fbsql_fetch_array</function> and
<function>fbsql_fetch_object</function> in an array.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array, starting at offset 0, that corresponds to the lengths of
each field in the last row fetched by <function>fbsql_fetch_row</function>,
or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<function>fbsql_fetch_lengths</function> stores the lengths of
each result column in the last row returned by
<function>fbsql_fetch_row</function>,
<function>fbsql_fetch_array</function> and
<function>fbsql_fetch_object</function> in an array, starting at
offset 0.
</para>
<para>
See also: <function>fbsql_fetch_row</function>.
<simplelist>
<member><function>fbsql_fetch_row</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

50
reference/fbsql/functions/fbsql-fetch-object.xml
View file

@ -1,21 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-fetch-object">
<refnamediv>
<refname>fbsql_fetch_object</refname>
<refpurpose>Fetch a result row as an object</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>fbsql_fetch_object</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>result_type</parameter></methodparam>
</methodsynopsis>
<para>
Returns an object with properties that correspond to the fetched
row, or &false; if there are no more rows.
</para>
<para>
<function>fbsql_fetch_object</function> is similar to
<function>fbsql_fetch_array</function>, with one difference - an
@ -23,16 +19,34 @@
that you can only access the data by the field names, and not by
their offsets (numbers are illegal property names).
</para>
<para>
The optional argument <parameter>result_type</parameter> is a
constant and can take the following values: FBSQL_ASSOC,
FBSQL_NUM, and FBSQL_BOTH.
</para>
<para>
Speed-wise, the function is identical to
<function>fbsql_fetch_array</function>, and almost as quick as
<function>fbsql_fetch_row</function> (the difference is
insignificant).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an object with properties that correspond to the fetched row, or
&false; if there are no more rows.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_fetch_object</function> example</title>
<programlisting role="php">
@ -50,11 +64,19 @@ fbsql_free_result($result);
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>fbsql_fetch_array</function> and
<function>fbsql_fetch_row</function>.
<simplelist>
<member><function>fbsql_fetch_array</function></member>
<member><function>fbsql_fetch_row</function></member>
<member><function>fbsql_fetch_assoc</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

49
reference/fbsql/functions/fbsql-fetch-row.xml
View file

@ -1,39 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-fetch-row">
<refnamediv>
<refname>fbsql_fetch_row</refname>
<refpurpose>Get a result row as an enumerated array</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fbsql_fetch_row</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
Returns: An array that corresponds to the fetched row, or &false;
if there are no more rows.
</para>
<para>
<function>fbsql_fetch_row</function> fetches one row of data from
the result associated with the specified result identifier. The
row is returned as an array. Each result column is stored in an
array offset, starting at offset 0.
the result associated with the specified result identifier.
</para>
<para>
Subsequent call to <function>fbsql_fetch_row</function> would
return the next row in the result set, or &false; if there are no
more rows.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
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_result</function>.
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an array that corresponds to the fetched row where each result
column is stored in an offset, starting at offset 0, or &false; if there
are no more rows.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_fetch_array</function></member>
<member><function>fbsql_fetch_assoc</function></member>
<member><function>fbsql_fetch_object</function></member>
<member><function>fbsql_data_seek</function></member>
<member><function>fbsql_fetch_lengths</function></member>
<member><function>fbsql_result</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/fbsql/functions/fbsql-field-flags.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-field-flags">
<refnamediv>
<refname>fbsql_field_flags</refname>
<refpurpose>Get the flags associated with the specified field in a result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_field_flags</methodname>
@ -13,10 +14,40 @@
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_field_flags</function> returns the field flags of
the specified field. The flags are reported as a single word
per flag separated by a single space, so that you can split the
returned value using <function>explode</function>.
Gets the flags associated with the specified field in a result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
A result pointer returned by <function>fbsql_list_fields</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field flags of the specified field as a single word per flag
separated by a single space, so that you can split the returned value
using <function>explode</function>.
</para>
</refsect1>
</refentry>

39
reference/fbsql/functions/fbsql-field-len.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-field-len">
<refnamediv>
<refname>fbsql_field_len</refname>
<refpurpose>Returns the length of the specified field</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_field_len</methodname>
@ -13,8 +14,38 @@
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_field_len</function> returns the length of the
specified field.
Returns the length of the specified field.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
A result pointer returned by <function>fbsql_list_fields</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the length of the specified field.
</para>
</refsect1>
</refentry>

64
reference/fbsql/functions/fbsql-field-name.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-field-name">
<refnamediv>
<refname>fbsql_field_name</refname>
<refpurpose>Get the name of the specified field in a result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_field_name</methodname>
@ -13,20 +14,43 @@
<methodparam choice="opt"><type>int</type><parameter>field_index</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_field_name</function> returns the name of the
specified field index. <parameter>result</parameter> must be a
valid result identifier and <parameter>field_index</parameter> is
the numerical offset of the field.
Returns the name of the specified field index.
</para>
<note>
<para>
<parameter>field_index</parameter> starts at 0.
</para>
<para>
e.g. The index of the third field would actually be 2, the index
of the fourth field would be 3 and so on.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
A result pointer returned by <function>fbsql_list_fields</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field_index</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name as a string, or &false; if the field doesn't exist.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_field_name</function> example</title>
@ -55,6 +79,16 @@ password
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_field_type</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/fbsql/functions/fbsql-field-seek.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-field-seek">
<refnamediv>
<refname>fbsql_field_seek</refname>
<refpurpose>Set result pointer to a specified field offset</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_field_seek</methodname>
@ -13,13 +14,43 @@
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
Seeks to the specified field offset. If the next call to
Seeks to the specified field offset. If the next call to
<function>fbsql_fetch_field</function> doesn't include a field
offset, the field offset specified in
<function>fbsql_field_seek</function> will be returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
See also: <function>fbsql_fetch_field</function>.
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_fetch_field</function></member>
</simplelist>
</para>
</refsect1>
</refentry>

32
reference/fbsql/functions/fbsql-field-table.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-field-table">
<refnamediv>
<refname>fbsql_field_table</refname>
<refpurpose>Get name of the table the specified field is in</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_field_table</methodname>
@ -13,8 +14,31 @@
<methodparam choice="opt"><type>int</type><parameter>field_offset</parameter></methodparam>
</methodsynopsis>
<para>
Returns the name of the table that the specified field is
in.
Returns the name of the table that the specified field is in.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the table, as a string.
</para>
</refsect1>
</refentry>

57
reference/fbsql/functions/fbsql-field-type.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-field-type">
<refnamediv>
<refname>fbsql_field_type</refname>
<refpurpose>Get the type of the specified field in a result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_field_type</methodname>
@ -14,11 +15,43 @@
</methodsynopsis>
<para>
<function>fbsql_field_type</function> is similar to the
<function>fbsql_field_name</function> function. The arguments are
identical, but the field type is returned instead. The field type
will be one of "int", "real", "string", "blob", and others as
detailed in the <ulink url="&url.fbsql.docs;">FrontBase
documentation</ulink>.
<function>fbsql_field_name</function> function, but the field type is
returned instead.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>field_offset</parameter></term>
<listitem>
<para>
The numerical offset of the field. The field index starts at 0.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the field type, as a string.
</para>
<para>
This can be one of <literal>int</literal>, <literal>real</literal>,
<literal>string</literal>, <literal>blob</literal>, and others as detailed
in the <ulink url="&url.fbsql.docs;">FrontBase documentation</ulink>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_field_type</function> example</title>
<programlisting role="php">
@ -50,6 +83,16 @@ fbsql_close();
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_field_name</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

25
reference/fbsql/functions/fbsql-free-result.xml
View file

@ -1,19 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-free-result">
<refnamediv>
<refname>fbsql_free_result</refname>
<refpurpose>Free result memory</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_free_result</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_free_result</function> will free all memory
associated with the result identifier <parameter>result</parameter>.
Frees all memory associated with the given <parameter>result</parameter>
identifier.
</para>
<para>
<function>fbsql_free_result</function> only needs to be called if
@ -22,6 +23,22 @@
automatically freed at the end of the script's execution.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

17
reference/fbsql/functions/fbsql-get-autostart-info.xml
View file

@ -1,20 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-get-autostart-info'>
<refnamediv>
<refname>fbsql_get_autostart_info</refname>
<refpurpose>No description given yet</refpurpose>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>fbsql_get_autostart_info</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
&warn.undocumented.func;
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

44
reference/fbsql/functions/fbsql-hostname.xml
View file

@ -1,19 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-hostname'>
<refnamediv>
<refname>fbsql_hostname</refname>
<refpurpose>Get or set the host name used with a connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_hostname</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>host_name</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Gets or sets the host name used with a connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>host_name</parameter></term>
<listitem>
<para>
If provided, this will be the new connection host name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current host name used for the connection.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_username</function></member>
<member><function>fbsql_password</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

54
reference/fbsql/functions/fbsql-insert-id.xml
View file

@ -1,38 +1,60 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-insert-id">
<refnamediv>
<refname>fbsql_insert_id</refname>
<refpurpose>Get the id generated from the previous INSERT operation</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_insert_id</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<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
<parameter>link_identifier</parameter> isn't specified, the last
opened link is assumed.
</para>
<para>
<function>fbsql_insert_id</function> returns 0 if the previous
query does not generate an DEFAULT UNIQUE value. If you need to
save the value for later, be sure to call fbsql_insert_id()
immediately after the query that generates the value.
Gets the id generated from the previous INSERT operation which created a
DEFAULT UNIQUE value.
</para>
<note>
<para>
The value of the FrontBase SQL function
<function>fbsql_insert_id</function> always contains the most
recently generated DEFAULT UNIQUE value, and is not reset
between queries.
<function>fbsql_insert_id</function> always contains the most recently
generated DEFAULT UNIQUE value, and is not reset between queries.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the ID generated from the previous INSERT query, or 0 if the
previous query does not generate an DEFAULT UNIQUE value.
</para>
<para>
If you need to save the value for later, be sure to call this function
immediately after the query that generates the value.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_affected_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

43
reference/fbsql/functions/fbsql-list-dbs.xml
View file

@ -1,22 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-list-dbs">
<refnamediv>
<refname>fbsql_list_dbs</refname>
<refpurpose>List databases available on a FrontBase server</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_list_dbs</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_list_dbs</function> will return a result pointer
containing the databases available from the current fbsql
daemon. Use the <function>fbsql_tablename</function> function to
Return a result pointer containing the databases available from the
current fbsql daemon. Use the <function>fbsql_tablename</function> to
traverse this result pointer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a result pointer or &false; on error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_list_dbs</function> example</title>
@ -30,7 +50,7 @@ while ($row = fbsql_fetch_object($db_list)) {
}
]]>
</programlisting>
&example.outputs;
&example.outputs.similar;
<screen>
<![CDATA[
database1
@ -48,6 +68,17 @@ database3
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_list_fields</function></member>
<member><function>fbsql_list_tables</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

78
reference/fbsql/functions/fbsql-list-fields.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.fbsql-list-fields">
<refnamediv>
<refname>fbsql_list_fields</refname>
<refpurpose>List FrontBase result fields</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_list_fields</methodname>
@ -14,21 +15,55 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_list_fields</function> retrieves information
about the given tablename. Arguments are the database name and
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_type</function>.
Retrieves information about the given table.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
A result identifier is a positive integer. The function returns
&false; if an error occurs. A string describing the error will be
placed in <literal>$phperrmsg</literal>, and unless the function
was called as <literal>@fbsql()</literal> then this error string
will also be printed out.
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>table_name</parameter></term>
<listitem>
<para>
The table name.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a result pointer which can be used with the
<literal>fbsql_field_xxx</literal> functions, or &false; on error.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
A string describing the error will be placed in
<literal>$phperrmsg</literal>, and unless the function was called as
<literal>@fbsql()</literal> then this error string will also be printed
out.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_list_fields</function> example</title>
@ -46,7 +81,7 @@ for ($i = 0; $i < $columns; $i++) {
?>
]]>
</programlisting>
&example.outputs;
&example.outputs.similar;
<screen>
<![CDATA[
field1
@ -58,6 +93,19 @@ field3
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_field_len</function></member>
<member><function>fbsql_field_name</function></member>
<member><function>fbsql_field_type</function></member>
<member><function>fbsql_field_flags</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

48
reference/fbsql/functions/fbsql-list-tables.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-list-tables">
<refnamediv>
<refname>fbsql_list_tables</refname>
<refpurpose>List tables in a FrontBase database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_list_tables</methodname>
@ -13,13 +14,46 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_list_tables</function> takes a database name and
returns a result pointer much like the
<function>fbsql_db_query</function> function. The
<function>fbsql_tablename</function> function should be used to
extract the actual table names from the result pointer.
Returns a result pointer describing the <parameter>database</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database</parameter></term>
<listitem>
<para>
The database name.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a result pointer which can be used with the
<function>fbsql_tablename</function> function to read the actual table
names, or &false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_list_fields</function></member>
<member><function>fbsql_list_dbs</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/fbsql/functions/fbsql-next-result.xml
View file

@ -1,15 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-next-result">
<refnamediv>
<refname>fbsql_next_result</refname>
<refpurpose>Move the internal result pointer to the next result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_next_result</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
When sending more than one SQL statement to the server or
@ -17,13 +18,33 @@
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.
and prepare to fetch the words from the new result set.
</para>
<example>
<title><function>fbsql_next_result</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if an additional result set was available or &false;
otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_next_result</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_connect("localhost", "_SYSTEM", "secret");
@ -38,9 +59,11 @@ fbsql_free_result($rs);
fbsql_close($link);
?>
]]>
</programlisting>
</example>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

45
reference/fbsql/functions/fbsql-num-fields.xml
View file

@ -1,28 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-num-fields">
<refnamediv>
<refname>fbsql_num_fields</refname>
<refpurpose>Get number of fields in result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_num_fields</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_num_fields</function> returns the number of
fields in a result set.
</para>
<para>
See also:
<function>fbsql_db_query</function>,
<function>fbsql_query</function>,
<function>fbsql_fetch_field</function>, and
<function>fbsql_num_rows</function>.
Returns the number of fields in the given <parameter>result</parameter>
set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of fields, as an integer.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_db_query</function></member>
<member><function>fbsql_query</function></member>
<member><function>fbsql_fetch_field</function></member>
<member><function>fbsql_num_rows</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

52
reference/fbsql/functions/fbsql-num-rows.xml
View file

@ -1,21 +1,46 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-num-rows">
<refnamediv>
<refname>fbsql_num_rows</refname>
<refpurpose>Get number of rows in result</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>fbsql_num_rows</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
</methodsynopsis>
<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
DELETE query, use <function>fbsql_affected_rows</function>.
Gets the number of rows in the given <parameter>result</parameter> set.
</para>
<para>
This function 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>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the number of rows returned by the last SELECT statement.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_num_rows</function> example</title>
<programlisting role="php">
@ -35,13 +60,20 @@ echo "$num_rows Rows\n";
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
See also: <function>fbsql_affected_rows</function>,
<function>fbsql_connect</function>,
<function>fbsql_select_db</function>, and
<function>fbsql_query</function>.
<simplelist>
<member><function>fbsql_affected_rows</function></member>
<member><function>fbsql_connect</function></member>
<member><function>fbsql_select_db</function></member>
<member><function>fbsql_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

44
reference/fbsql/functions/fbsql-password.xml
View file

@ -1,19 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-password'>
<refnamediv>
<refname>fbsql_password</refname>
<refpurpose>Get or set the user password used with a connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_password</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Get or set the user password used with a connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
If provided, this will be the new connection password.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current password used for the connection.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_username</function></member>
<member><function>fbsql_hostname</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

71
reference/fbsql/functions/fbsql-pconnect.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-pconnect">
<refnamediv>
<refname>fbsql_pconnect</refname>
<refpurpose>Open a persistent connection to a FrontBase Server</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_pconnect</methodname>
@ -14,23 +15,14 @@
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A positive FrontBase persistent link identifier on
success, or &false; on error.
Establishes a persistent connection to a FrontBase server.
</para>
<para>
<function>fbsql_pconnect</function> establishes a connection
to a FrontBase server. The following defaults are assumed for
missing optional parameters: <parameter>host</parameter> =
'localhost', <parameter>username</parameter> = "_SYSTEM"
and <parameter>password</parameter> = empty password.
</para>
<para>
To set Frontbase server port number, use
<function>fbsql_select_db</function>.
To set the server port number, use <function>fbsql_select_db</function>.
</para>
<para>
<function>fbsql_pconnect</function> acts very much like
<function>fbsql_connect</function> with two major differences.
<function>fbsql_connect</function> with two major differences:
</para>
<para>
First, when connecting, the function would first try to find a
@ -47,6 +39,57 @@
This type of links is therefore called 'persistent'.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
<para>
The server host name. Defaults to <literal>localhost</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
The user name for the connection. Defaults to
<literal>_SYSTEM</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The user name for the connection. Defaults to the empty string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a positive FrontBase persistent link identifier on success, or
&false; on error.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

113
reference/fbsql/functions/fbsql-query.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-query">
<refnamediv>
<refname>fbsql_query</refname>
<refpurpose>Send a FrontBase query</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>fbsql_query</methodname>
@ -14,19 +15,48 @@
<methodparam choice="opt"><type>int</type><parameter>batch_size</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_query</function> sends a query to the currently
active database on the server that's associated with the
specified link identifier. If
<parameter>link_identifier</parameter> isn't specified, the last
opened link is assumed. If no link is open, the function tries
to establish a link as if <function>fbsql_connect</function> was
called with no arguments, and use it.
Sends a <parameter>query</parameter> to the currently active database on
the server.
</para>
<note>
<para>
The query string shall always end with a semicolon.
</para>
</note>
<para>
If the query succeeds, you can call <function>fbsql_num_rows</function> to
find out how many rows were returned for a SELECT statement or
<function>fbsql_affected_rows</function> to find out how many rows were
affected by a DELETE, INSERT, REPLACE, or UPDATE statement.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>query</parameter></term>
<listitem>
<para>
The SQL query to be executed.
</para>
<note>
<para>
The query string shall always end with a semicolon.
</para>
</note>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>batch_size</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>fbsql_query</function> returns &true; (non-zero) or &false;
to indicate whether or not the query succeeded. A return value
@ -36,6 +66,18 @@
to succeed but affect no rows or return no rows.
</para>
<para>
For SELECT statements, <function>fbsql_query</function> returns a new
result identifier that you can pass to <function>fbsql_result</function>.
</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.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
The following query is syntactically invalid, so
<function>fbsql_query</function> fails and returns &false;:
<example>
@ -60,44 +102,29 @@ $result = fbsql_query("SELECT * WHERE 1=1")
<programlisting role="php">
<![CDATA[
<?php
$result = fbsql_query ("SELECT my_col FROM my_tbl")
$result = fbsql_query ("SELECT my_col FROM my_tbl;")
or die ("Invalid query");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<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.
</para>
<para>
Assuming the query succeeds, you can call
<function>fbsql_num_rows</function> to find out how many rows
were returned for a SELECT statement or
<function>fbsql_affected_rows</function> to find out how many
rows were affected by a DELETE, INSERT, REPLACE, or UPDATE
statement.
</para>
<para>
For SELECT statements, <function>fbsql_query</function> returns a
new result identifier that you can pass to
<function>fbsql_result</function>. When you are done with the
result set, you can free the resources associated with it by
calling <function>fbsql_free_result</function>. Although, the
memory will automatically be freed at the end of the script's
execution.
</para>
<para>
See also: <function>fbsql_affected_rows</function>,
<function>fbsql_db_query</function>,
<function>fbsql_free_result</function>,
<function>fbsql_result</function>,
<function>fbsql_select_db</function>, and
<function>fbsql_connect</function>.
<simplelist>
<member><function>fbsql_affected_rows</function></member>
<member><function>fbsql_db_query</function></member>
<member><function>fbsql_free_result</function></member>
<member><function>fbsql_result</function></member>
<member><function>fbsql_select_db</function></member>
<member><function>fbsql_connect</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

76
reference/fbsql/functions/fbsql-read-blob.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.fbsql-read-blob">
<refnamediv>
<refname>fbsql_read_blob</refname>
<refpurpose>Read a BLOB from the database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_read_blob</methodname>
@ -13,21 +14,48 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A string containing the BLOB specified by blob_handle.
Reads BLOB data from the database.
</para>
<para>
<function>fbsql_read_blob</function> reads BLOB 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_blob</function> to
get the actual BLOB 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_blob</function> to get the
actual BLOB data from the database.
</para>
<example>
<title><function>fbsql_read_blob</function> example</title>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>blob_handle</parameter></term>
<listitem>
<para>
A BLOB handle, returned by <function>fbsql_create_blob</function>.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the specified BLOB data.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_read_blob</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -47,14 +75,22 @@ fbsql_free_result($rs);
?>
]]>
</programlisting>
</example>
<para>
See also: <function>fbsql_create_blob</function>,
<function>fbsql_read_clob</function>, and
<function>fbsql_set_lob_mode</function>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_blob</function></member>
<member><function>fbsql_read_clob</function></member>
<member><function>fbsql_set_lob_mode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

76
reference/fbsql/functions/fbsql-read-clob.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- $Revision: 1.8 $ -->
<refentry id="function.fbsql-read-clob">
<refnamediv>
<refname>fbsql_read_clob</refname>
<refpurpose>Read a CLOB from the database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_read_clob</methodname>
@ -13,21 +14,48 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
Returns: A string containing the CLOB specified by clob_handle.
Reads CLOB data from the database.
</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.
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>
<programlisting role="php">
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>clob_handle</parameter></term>
<listitem>
<para>
A CLOB handle, returned by <function>fbsql_create_clob</function>.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string containing the specified CLOB data.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_read_clob</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$link = fbsql_pconnect("localhost", "_SYSTEM", "secret")
@ -47,14 +75,22 @@ fbsql_free_result($rs);
?>
]]>
</programlisting>
</example>
<para>
See also: <function>fbsql_create_blob</function>,
<function>fbsql_read_blob</function>, and
<function>fbsql_set_lob_mode</function>.
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_clob</function></member>
<member><function>fbsql_read_blob</function></member>
<member><function>fbsql_set_lob_mode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

75
reference/fbsql/functions/fbsql-result.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-result">
<refnamediv>
<refname>fbsql_result</refname>
<refpurpose>Get result data</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>fbsql_result</methodname>
@ -14,33 +15,75 @@
<methodparam choice="opt"><type>mixed</type><parameter>field</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_result</function> returns the contents of one
cell from a FrontBase result set. The field argument can be the
field's offset, or the field's name, or the field's table dot
field's name (tabledname.fieldname). If the column name has been
aliased ('select foo as bar from...'), use the alias instead of
the column name.
Returns the contents of one cell from a FrontBase
<parameter>result</parameter> set.
</para>
<para>
When working on large result sets, you should consider using one
of the functions that fetch an entire row (specified below). As
these functions return the contents of multiple cells in one
function call, they're MUCH quicker than
<function>fbsql_result</function>. Also, note that specifying a
numeric offset for the field argument is much quicker than
specifying a fieldname or tablename.fieldname argument.
function call, they're MUCH quicker than <function>fbsql_result</function>.
</para>
<para>
Calls to <function>fbsql_result</function> should not be mixed
with calls to other functions that deal with the result set.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
Recommended high-performance alternatives:
<function>fbsql_fetch_row</function>,
<function>fbsql_fetch_array</function>, and
<function>fbsql_fetch_object</function>.
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>row</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>field</parameter></term>
<listitem>
<para>
Can be the field's offset, or the field's name, or the field's table
dot field's name (tabledname.fieldname).
</para>
<para>
If the column name has been aliased ('select foo as bar from...'), use
the alias instead of the column name.
</para>
<note>
<para>
Specifying a numeric offset for the field argument is much quicker
than specifying a fieldname or tablename.fieldname argument.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
Recommended high-performance alternatives:
<simplelist>
<member><function>fbsql_fetch_row</function></member>
<member><function>fbsql_fetch_array</function></member>
<member><function>fbsql_fetch_assoc</function></member>
<member><function>fbsql_fetch_object</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

39
reference/fbsql/functions/fbsql-rollback.xml
View file

@ -1,29 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-rollback">
<refnamediv>
<refname>fbsql_rollback</refname>
<refpurpose>Rollback a transaction to the database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_rollback</methodname>
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
Ends the current transaction by rolling back all statements issued since
last commit.
</para>
<para>
<function>fbsql_rollback</function> ends the current transaction by
rolling back all statements issued since last commit.
This command is only needed if autocommit is set to false.
</para>
<para> See also:
<function>fbsql_autocommit</function> and
<function>fbsql_commit</function>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_autocommit</function></member>
<member><function>fbsql_commit</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

66
reference/fbsql/functions/fbsql-select-db.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-select-db">
<refnamediv>
<refname>fbsql_select_db</refname>
<refpurpose>Select a FrontBase database</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_select_db</methodname>
@ -13,15 +14,7 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_select_db</function> sets the current active
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>
&return.success;
Sets the current active database on the given link identifier.
</para>
<para>
The client contacts FBExec to obtain the port number to use for
@ -35,19 +28,50 @@
Every subsequent call to <function>fbsql_query</function> will be
made on the active database.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
if the database is protected with a database password, the user must
call <function>fbsql_database_password</function> before selecting
the database.
</para>
<para>
See also
<function>fbsql_connect</function>,
<function>fbsql_pconnect</function>,
<function>fbsql_database_password</function>, and
<function>fbsql_query</function>.
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The name of the database to be selected.
</para>
<para>
If the database is protected with a database password, the you must
call <function>fbsql_database_password</function> before selecting the
database.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_connect</function></member>
<member><function>fbsql_pconnect</function></member>
<member><function>fbsql_database_password</function></member>
<member><function>fbsql_query</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

107
reference/fbsql/functions/fbsql-set-lob-mode.xml
View file

@ -1,58 +1,87 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-set-lob-mode">
<refnamediv>
<refname>fbsql_set_lob_mode</refname>
<refpurpose>Set the LOB retrieve mode for a FrontBase result set</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_set_lob_mode</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>string</type><parameter>database_name</parameter></methodparam>
<methodparam><type>int</type><parameter>lob_mode</parameter></methodparam>
</methodsynopsis>
<para>
Returns: &true; on success, &false; on error.
Sets the mode for retrieving LOB data from the database.
</para>
<para>
<function>fbsql_set_lob_mode</function> sets the mode for
retrieving 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 always be fetched no matter the setting of
the lob mode. If the LOB data is less than 512 bytes it will
always be stored directly.
<itemizedlist>
<listitem>
<simpara>
FBSQL_LOB_DIRECT - LOB data is retrieved 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 retrieved 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
formatted as "@'000000000000000000000000'".
</simpara>
</listitem>
</itemizedlist>
</para>
<para> See also:
<function>fbsql_create_blob</function>,
<function>fbsql_create_clob</function>,
<function>fbsql_read_blob</function>, and
<function>fbsql_read_clob</function>.
When BLOB and CLOB data is retrieved in FrontBase it can be retrieved
direct or indirect. Direct retrieved LOB data will always be fetched no
matter the setting of the lob mode. If the LOB data is less than 512 bytes
it will always be retrieved directly.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.result.description;
<varlistentry>
<term><parameter>lob_mode</parameter></term>
<listitem>
<para>
Can be one of:
<itemizedlist>
<listitem>
<simpara>
<constant>FBSQL_LOB_DIRECT</constant> - LOB data is retrieved
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>
<constant>FBSQL_LOB_HANDLE</constant> - LOB data is retrieved 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 formatted as
<literal>@'000000000000000000000000'</literal>.
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_create_blob</function></member>
<member><function>fbsql_create_clob</function></member>
<member><function>fbsql_read_blob</function></member>
<member><function>fbsql_read_clob</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

47
reference/fbsql/functions/fbsql-set-password.xml
View file

@ -1,11 +1,12 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<refentry id="function.fbsql-set-password">
<refnamediv>
<refname>fbsql_set_password</refname>
<refpurpose>Change the password for a given user</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_set_password</methodname>
@ -14,9 +15,49 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>string</type><parameter>old_password</parameter></methodparam>
</methodsynopsis>
<para>
Changes the password for the given <parameter>user</parameter>.
</para>
</refsect1>
&warn.undocumented.func;
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>user</parameter></term>
<listitem>
<para>
The user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
The new password to be set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>old_password</parameter></term>
<listitem>
<para>
The old password to be replaced.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
</refentry>

39
reference/fbsql/functions/fbsql-set-transaction.xml
View file

@ -1,20 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-set-transaction'>
<refnamediv>
<refname>fbsql_set_transaction</refname>
<refpurpose>Set the transaction locking and isolation</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>fbsql_set_transaction</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>Locking</parameter></methodparam>
<methodparam><type>int</type><parameter>Isolation</parameter></methodparam>
<methodparam><type>int</type><parameter>locking</parameter></methodparam>
<methodparam><type>int</type><parameter>isolation</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>locking</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>isolation</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

56
reference/fbsql/functions/fbsql-start-db.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<refentry id="function.fbsql-start-db">
<refnamediv>
<refname>fbsql_start_db</refname>
<refpurpose>Start a database on local or remote server</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_start_db</methodname>
@ -14,16 +15,51 @@
<methodparam choice="opt"><type>string</type><parameter>database_options</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>fbsql_start_db</function>
</para>
<para>
See also: <function>fbsql_db_status</function> and
<function>fbsql_stop_db</function>.
Start a database on local or remote server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>database_options</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_db_status</function></member>
<member><function>fbsql_stop_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

49
reference/fbsql/functions/fbsql-stop-db.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-stop-db">
<refnamediv>
<refname>fbsql_stop_db</refname>
<refpurpose>Stop a database on local or remote server</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_stop_db</methodname>
@ -13,16 +14,44 @@
<methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para>
&return.success;
</para>
<para>
<function>fbsql_stop_db</function>
</para>
<para>
See also: <function>fbsql_db_status</function> and
<function>fbsql_start_db</function>.
Stops a database on local or remote server.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>database_name</parameter></term>
<listitem>
<para>
The database name.
</para>
</listitem>
</varlistentry>
&fbsql.link-identifier.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_db_status</function></member>
<member><function>fbsql_start_db</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

54
reference/fbsql/functions/fbsql-tablename.xml
View file

@ -1,11 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<refentry id="function.fbsql-tablename">
<refnamediv>
<refname>fbsql_tablename</refname>
<refpurpose>Get table name of field</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_tablename</methodname>
@ -13,11 +14,49 @@
<methodparam><type>int</type><parameter>i</parameter></methodparam>
</methodsynopsis>
<para>
<function>fbsql_tablename</function> takes a result pointer
returned by the <function>fbsql_list_tables</function> function
as well as an integer index and returns the name of a table. The
<function>fbsql_num_rows</function> function may be used to
determine the number of tables in the result pointer.
<function>fbsql_tablename</function> gets the name of the current table in
the given <parameter>result</parameter> set.
</para>
<para>
The <function>fbsql_num_rows</function> function may be used to determine
the number of tables in the result pointer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
A result pointer returned by <function>fbsql_list_tables</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>i</parameter></term>
<listitem>
<para>
Integer index for the current table.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name of the table, as a string.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>fbsql_tablename</function> example</title>
<programlisting role="php">
@ -37,6 +76,7 @@ while ($i < fbsql_num_rows($result)) {
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

46
reference/fbsql/functions/fbsql-username.xml
View file

@ -1,19 +1,57 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id='function.fbsql-username'>
<refnamediv>
<refname>fbsql_username</refname>
<refpurpose>Get or set the host user used with a connection</refpurpose>
<refpurpose>Get or set the username for the connection</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fbsql_username</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
<para>
Get or set the username used for the connection.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&fbsql.link-identifier.description;
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
<para>
If provided, this is the new username to set.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the current username used with the connection, as a string.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_password</function></member>
<member><function>fbsql_hostname</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

46
reference/fbsql/functions/fbsql-warnings.xml
View file

@ -1,24 +1,56 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<refentry id="function.fbsql-warnings">
<refnamediv>
<refname>fbsql_warnings</refname>
<refpurpose>Enable or disable FrontBase warnings</refpurpose>
</refnamediv>
<refsect1>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fbsql_warnings</methodname>
<methodparam choice="opt"><type>bool</type><parameter>OnOff</parameter></methodparam>
</methodsynopsis>
<para>
Returns &true; if warnings is turned on otherwise &false;.
</para>
<para>
<function>fbsql_warnings</function> enables or disables FrontBase
warnings.
Enables or disables FrontBase warnings.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>OnOff</parameter></term>
<listitem>
<para>
Whether to enable warnings or no.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if warnings is turned on, &false; otherwise.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fbsql_errno</function></member>
<member><function>fbsql_error</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file