leon Fri Feb 7 19:57:14 2003 EDT
Added files:
/phpdoc/en/reference/sybase/functions
sybase-deadlock-retry-count.xml
sybase-fetch-assoc.xml
sybase-set-message-handler.xml
sybase-unbuffered-query.xml
Log:
Adding descriptions for missing Sybase functions
Index: phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml
+++ phpdoc/en/reference/sybase/functions/sybase-deadlock-retry-count.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sybase-deadlock-retry-count">
<refnamediv>
<refname>sybase_deadlock_retry_count</refname>
<refpurpose>set the deadlock retry count</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>sybase_deadlock_retry_count</methodname>
<methodparam><type>int</type><parameter>retry_count</parameter></methodparam>
</methodsynopsis>
<para>
Using <function>sybase_deadlock_retry_count</function>, the number of retries
can be defined in cases of deadlocks. By default, every deadlock is retried
an infinite number of times or until the process is killed by Sybase, the
executing script is killed (for instance, by <function>set_time_limit</function>)
or the query succeeds.
</para>
<para>
<table>
<title>Values for retry_count</title>
<tgroup cols="2">
<tbody>
<row>
<entry>-1</entry>
<entry>Retry forever (default)</entry>
</row>
<row>
<entry>0</entry>
<entry>Do not retry</entry>
</row>
<row>
<entry>n</entry>
<entry>Retry n times</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<note>
<para>
This function is only available using the CT library interface
to Sybase, and not the DB library.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml
+++ phpdoc/en/reference/sybase/functions/sybase-fetch-assoc.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sybase-fetch-assoc">
<refnamediv>
<refname>sybase_fetch_assoc</refname>
<refpurpose>fetch row as associative array</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>sybase_fetch_assoc</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>sybase_fetch_assoc</function> is a version of
<function>sybase_fetch_row</function> that uses column names
instead of integers for indices in the result array. Columns from
different tables with the same names are returned as
name, name1, name2, ..., nameN.
</para>
<para>
An important thing to note is that using
<function>sybase_fetch_assoc</function> is NOT significantly
slower than using <function>sybase_fetch_row</function>, while it
provides a significant added value.
</para>
<para>
Also see <function>sybase_fetch_array</function>,
<function>sybase_fetch_object</function>, and
<function>sybase_fetch_row</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml
+++ phpdoc/en/reference/sybase/functions/sybase-set-message-handler.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sybase-set-message-handler">
<refnamediv>
<refname>sybase_set_message_handler</refname>
<refpurpose>set handler called when a server message is raised</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>sybase_set_message_handler</methodname>
<methodparam><type>callback</type><parameter>handler</parameter></methodparam>
</methodsynopsis>
<para>
<function>sybase_set_message_handler</function> sets a user function to
handle messages generated by the server. You may specify the name of a
global function, or use an array to specify an object reference and a
method name.
</para>
<para>
The handler expects five arguments in the following order: message
number, severity, state, line number and description. The first four are
integers. The last is a string. If the function returns FALSE, PHP
generates an ordinary error message.
</para>
<para>
&return.success;
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Index: phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml
+++ phpdoc/en/reference/sybase/functions/sybase-unbuffered-query.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sybase-unbuffered-query">
<refnamediv>
<refname>sybase_unbuffered_query</refname>
<refpurpose>send Sybase query and do not block</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>sybase_unbuffered_query</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><type>int</type><parameter>link_identifier</parameter></methodparam>
</methodsynopsis>
<para> Returns: A positive Sybase result identifier on success, or
&false; on error.
</para>
<para>
<function>sybase_unbuffered_query</function> sends a query to the
currently active database on the server that's associated with the specified
link identifier. If the link identifier isn't specified, the last
opened link is assumed. If no link is open, the function tries to
establish a link as if <function>sybase_connect</function> was
called, and use it.
</para>
<para>
Unlike <function>sybase_query</function>,
<function>sybase_unbuffered_query</function> reads only the first
row of the result set. <function>sybase_fetch_array</function> and similar
function read more rows as needed. <function>sybase_data_seek</function>
reads up to the target row. The behavior may produce better performance
for large result sets.
</para>
<para>
<function>sybase_num_rows</function> will only return the correct number
of rows if all result sets have been read. To Sybase, the number of rows
is not known and is therefore computed by the client implementation.
</para>
<para>
It is not possible to fire up another query directly after starting an
unbuffered query and only if all rows have been read or the
remainding rows have been cancelled. This can be acheived by using
<function>sybase_free_result</function> on the return value of
<function>sybase_unbuffered_query</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
