mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
Move docs to the new format
Added example and explained result for dba_handlers() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@178567 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
b0615875a9
commit
9a5eb3d545
10 changed files with 389 additions and 147 deletions
|
|
@ -1,34 +1,51 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.dba-close">
|
||||
<refnamediv>
|
||||
<refname>dba_close</refname>
|
||||
<refpurpose>Close a DBA database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>void</type><methodname>dba_close</methodname>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_close</function> closes the established database
|
||||
and frees all resources specified by
|
||||
<parameter>handle</parameter>.
|
||||
<function>dba_close</function> closes the established database and frees
|
||||
all resources of the specified database handle.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>dba_close</function> does not return any value.
|
||||
&return.void;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also
|
||||
<function>dba_open</function>, and
|
||||
<function>dba_popen</function>
|
||||
</para>
|
||||
<simplelist>
|
||||
<member><function>dba_open</function></member>
|
||||
<member><function>dba_popen</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,40 +1,60 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.dba-delete">
|
||||
<refnamediv>
|
||||
<refname>dba_delete</refname>
|
||||
<refpurpose>Delete DBA entry specified by key</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_delete</methodname>
|
||||
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_delete</function> deletes the entry specified by
|
||||
<parameter>key</parameter> from the database specified with
|
||||
<parameter>handle</parameter>.
|
||||
<function>dba_delete</function> deletes the specified entry from the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>key</parameter> is the key of the entry which is
|
||||
deleted.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The key of the entry which is deleted.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<function>dba_delete</function> returns &true; or &false;, if the entry is
|
||||
deleted or not deleted, respectively.
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>dba_exists</function>,
|
||||
<function>dba_fetch</function>, <function>dba_insert</function>,
|
||||
and <function>dba_replace</function>.
|
||||
<simplelist>
|
||||
<member><function>dba_exists</function></member>
|
||||
<member><function>dba_fetch</function></member>
|
||||
<member><function>dba_insert</function></member>
|
||||
<member><function>dba_replace</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id="function.dba-exists">
|
||||
<refnamediv>
|
||||
<refname>dba_exists</refname>
|
||||
<refpurpose>Check whether key exists</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_exists</methodname>
|
||||
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
||||
|
|
@ -15,24 +14,48 @@
|
|||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_exists</function> checks whether the specified
|
||||
<parameter>key</parameter> exists in the database specified by
|
||||
<parameter>handle</parameter>.
|
||||
<parameter>key</parameter> exists in the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>Key</parameter> is the key the check is performed for.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The key the check is performed for.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<parameter>Handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
Returns &true; if the key exists, &false; otherwise.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<function>dba_exists</function> returns &true; or &false;, if the key is found
|
||||
or not found, respectively.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>dba_fetch</function>,
|
||||
<function>dba_delete</function>, <function>dba_insert</function>,
|
||||
and <function>dba_replace</function>.
|
||||
<simplelist>
|
||||
<member><function>dba_delete</function></member>
|
||||
<member><function>dba_fetch</function></member>
|
||||
<member><function>dba_insert</function></member>
|
||||
<member><function>dba_replace</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,35 +1,52 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.dba-firstkey">
|
||||
<refnamediv>
|
||||
<refname>dba_firstkey</refname>
|
||||
<refpurpose>Fetch first key</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>dba_firstkey</methodname>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_firstkey</function> returns the first key of the
|
||||
database specified by <parameter>handle</parameter> and resets
|
||||
the internal key pointer. This permits a linear search through
|
||||
<function>dba_firstkey</function> returns the first key of the database
|
||||
and resets the internal key pointer. This permits a linear search through
|
||||
the whole database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>Handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>dba_firstkey</function> returns the key or &false;
|
||||
depending on whether it succeeds or fails, respectively.
|
||||
Returns the key on success, or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also
|
||||
<function>dba_nextkey</function>, <function>dba_key_split</function>
|
||||
and example 2 in the <link linkend="dba.examples">DBA examples</link>
|
||||
<simplelist>
|
||||
<member><function>dba_nextkey</function></member>
|
||||
<member><function>dba_key_split</function></member>
|
||||
<member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,26 +1,84 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.dba-handlers">
|
||||
<refnamediv>
|
||||
<refname>dba_handlers</refname>
|
||||
<refpurpose>List handlers available</refpurpose>
|
||||
<refpurpose>List all the handlers available</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>dba_handlers</methodname>
|
||||
<methodparam choice="opt"><type>bool</type><parameter>full_info</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_handlers</function> returns an array with all handlers
|
||||
supported by this extension.
|
||||
<function>dba_handlers</function> list all the handlers supported by this
|
||||
extension.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
When the internal cdb library is used you will see
|
||||
'<literal>cdb</literal>' and '<literal>cdb_make</literal>'.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>full_info</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Turns on/off full information display in the result. The default is
|
||||
&false;.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array of database handlers. If <parameter>full_info</parameter>
|
||||
is set to &true;, the array will be associative with the handlers names as
|
||||
keys, and their version information as value. Otherwise, the result will be
|
||||
an indexed array of handlers names.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
When the internal cdb library is used you will see
|
||||
<literal>cdb</literal> and <literal>cdb_make</literal>.
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title><function>dba_handlers</function> Example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
|
||||
echo "Available DBA handlers:\n";
|
||||
foreach (dba_handlers(true) as $handler_name => $handler_version) {
|
||||
// clean the versions
|
||||
$handler_version = str_replace('$', '', $handler_version);
|
||||
echo " - $handler_name: $handler_version\n";
|
||||
}
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs.similar;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
Available DBA handlers:
|
||||
- cdb: 0.75, Revision: 1.3.2.3
|
||||
- cdb_make: 0.75, Revision: 1.2.2.4
|
||||
- db2: Sleepycat Software: Berkeley DB 2.7.7: (08/20/99)
|
||||
- inifile: 1.0, Revision: 1.6.2.3
|
||||
- flatfile: 1.0, Revision: 1.5.2.4
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<refentry id="function.dba-insert">
|
||||
<refnamediv>
|
||||
<refname>dba_insert</refname>
|
||||
<refpurpose>Insert entry</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_insert</methodname>
|
||||
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
||||
|
|
@ -17,29 +16,58 @@
|
|||
<para>
|
||||
<function>dba_insert</function> inserts the entry described with
|
||||
<parameter>key</parameter> and <parameter>value</parameter> into the
|
||||
database specified by <parameter>handle</parameter>. It fails, if an entry
|
||||
with the same <parameter>key</parameter> already exists.
|
||||
database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>key</parameter> is the key of the entry to be inserted.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The key of the entry to be inserted. If this key already exist in the
|
||||
database, this function will fail. Use <function>dba_replace</function>
|
||||
if you need to replace an existent key.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value to be inserted.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<parameter>value</parameter> is the value to be inserted.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
</para>
|
||||
<para>
|
||||
<function>dba_insert</function> returns &true; or &false;, depending on
|
||||
whether it succeeds of fails, respectively.
|
||||
</para>
|
||||
<para>
|
||||
See also
|
||||
<function>dba_exists</function>
|
||||
<function>dba_delete</function>
|
||||
<function>dba_fetch</function>
|
||||
<function>dba_replace</function>
|
||||
<simplelist>
|
||||
<member><function>dba_exists</function></member>
|
||||
<member><function>dba_delete</function></member>
|
||||
<member><function>dba_fetch</function></member>
|
||||
<member><function>dba_replace</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,34 +1,51 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<refentry id="function.dba-nextkey">
|
||||
<refnamediv>
|
||||
<refname>dba_nextkey</refname>
|
||||
<refpurpose>Fetch next key</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>dba_nextkey</methodname>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_nextkey</function> returns the next key of the database
|
||||
specified by <parameter>handle</parameter> and advances the internal
|
||||
key pointer.
|
||||
and advances the internal key pointer.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>dba_nextkey</function> returns the key or &false; depending on
|
||||
whether it succeeds or fails, respectively.
|
||||
Returns the key on success, or &false; on failure.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also
|
||||
<function>dba_firstkey</function>, <function>dba_key_split</function>
|
||||
and example 2 in the <link linkend="dba.examples">DBA examples</link>
|
||||
<simplelist>
|
||||
<member><function>dba_firstkey</function></member>
|
||||
<member><function>dba_key_split</function></member>
|
||||
<member>Example 2 in the <link linkend="dba.examples">DBA examples</link></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,32 +1,48 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id="function.dba-optimize">
|
||||
<refnamediv>
|
||||
<refname>dba_optimize</refname>
|
||||
<refpurpose>Optimize database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_optimize</methodname>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_optimize</function> optimizes the underlying database
|
||||
specified by <parameter>handle</parameter>.
|
||||
<function>dba_optimize</function> optimizes the underlying database.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>dba_optimize</function> returns &true; or &false;, if the
|
||||
optimization succeeds or fails, respectively.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also:
|
||||
<function>dba_sync</function>
|
||||
<simplelist>
|
||||
<member><function>dba_sync</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,12 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id="function.dba-replace">
|
||||
<refnamediv>
|
||||
<refname>dba_replace</refname>
|
||||
<refpurpose>Replace or insert entry</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_replace</methodname>
|
||||
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
||||
|
|
@ -19,24 +18,54 @@
|
|||
with <parameter>key</parameter> and <parameter>value</parameter> into the
|
||||
database specified by <parameter>handle</parameter>.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>key</parameter> is the key of the entry to be inserted.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>key</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The key of the entry to be replaced.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>value</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The value to be replaced.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<parameter>value</parameter> is the value to be inserted.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
</para>
|
||||
<para>
|
||||
<function>dba_replace</function> returns &true; or &false;, depending on
|
||||
whether it succeeds of fails, respectively.
|
||||
</para>
|
||||
<para>
|
||||
See also: <function>dba_exists</function>,
|
||||
<function>dba_delete</function>, <function>dba_fetch</function>,
|
||||
and <function>dba_insert</function>.
|
||||
<simplelist>
|
||||
<member><function>dba_exists</function></member>
|
||||
<member><function>dba_delete</function></member>
|
||||
<member><function>dba_fetch</function></member>
|
||||
<member><function>dba_insert</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
|
|
@ -1,32 +1,49 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<refentry id="function.dba-sync">
|
||||
<refnamediv>
|
||||
<refname>dba_sync</refname>
|
||||
<refpurpose>Synchronize database</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>bool</type><methodname>dba_sync</methodname>
|
||||
<methodparam><type>resource</type><parameter>handle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>dba_sync</function> synchronizes the database specified by
|
||||
<parameter>handle</parameter>. This will probably trigger a physical write
|
||||
to disk, if supported.
|
||||
<function>dba_sync</function> synchronizes the database. This will probably
|
||||
trigger a physical write to the disk, if supported.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<parameter>handle</parameter> is a database handle returned by
|
||||
<function>dba_open</function>.
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>handle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The database handler, returned by <function>dba_open</function> or
|
||||
<function>dba_popen</function>.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
<function>dba_sync</function> returns &true; or &false;, if the
|
||||
synchronization succeeds or fails, respectively.
|
||||
&return.success;
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
See also: <function>dba_optimize</function>
|
||||
<simplelist>
|
||||
<member><function>dba_optimize</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
|
|
|||
Loading…
Reference in a new issue