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

WS, prepare for new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@231114 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-03-04 00:37:56 +00:00
parent 97ebf35968
commit 8914c66fc5
47 changed files with 1172 additions and 1176 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
reference/dbplus/functions/dbplus-add.xml
View file

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-add">
<refnamediv>
<refname>dbplus_add</refname>
<refpurpose>Add a tuple to a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_add</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This function will add a tuple to a relation. The
<parameter>tuple</parameter> data is an array of attribute/value
pairs to be inserted into the given
<parameter>relation</parameter>. After successful execution the
<parameter>tuple</parameter> array will contain the complete data
of the newly created tuple, including all implicitly set domain
fields like sequences.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-add">
<refnamediv>
<refname>dbplus_add</refname>
<refpurpose>Add a tuple to a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_add</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This function will add a tuple to a relation. The
<parameter>tuple</parameter> data is an array of attribute/value
pairs to be inserted into the given
<parameter>relation</parameter>. After successful execution the
<parameter>tuple</parameter> array will contain the complete data
of the newly created tuple, including all implicitly set domain
fields like sequences.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-aql.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-aql">
<refnamediv>
<refname>dbplus_aql</refname>
<refpurpose>Perform AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_aql</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_aql</function> will execute an AQL
<parameter>query</parameter> on the given
<parameter>server</parameter> and
<parameter>dbpath</parameter>.
</para>
<para>
On success it will return a relation handle. The result data may
be fetched from this relation by calling
<function>dbplus_next</function> and
<function>dbplus_current</function>. Other relation access
functions will not work on a result relation.
</para>
<para>
Further information on the AQL A... Query Language is provided in
the original db++ manual.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-aql">
<refnamediv>
<refname>dbplus_aql</refname>
<refpurpose>Perform AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_aql</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_aql</function> will execute an AQL
<parameter>query</parameter> on the given
<parameter>server</parameter> and
<parameter>dbpath</parameter>.
</para>
<para>
On success it will return a relation handle. The result data may
be fetched from this relation by calling
<function>dbplus_next</function> and
<function>dbplus_current</function>. Other relation access
functions will not work on a result relation.
</para>
<para>
Further information on the AQL A... Query Language is provided in
the original db++ manual.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/dbplus/functions/dbplus-chdir.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-chdir">
<refnamediv>
<refname>dbplus_chdir</refname>
<refpurpose>Get/Set database virtual current directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_chdir</methodname>
<methodparam choice="opt"><type>string</type><parameter>newdir</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_chdir</function> will change the virtual current
directory where relation files will be looked for by
<function>dbplus_open</function>.
<function>dbplus_chdir</function> will return the absolute path
of the current directory. Calling
<function>dbplus_chdir</function> without giving any
<parameter>newdir</parameter> may be used to query the current
working directory.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-chdir">
<refnamediv>
<refname>dbplus_chdir</refname>
<refpurpose>Get/Set database virtual current directory</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_chdir</methodname>
<methodparam choice="opt"><type>string</type><parameter>newdir</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_chdir</function> will change the virtual current
directory where relation files will be looked for by
<function>dbplus_open</function>.
<function>dbplus_chdir</function> will return the absolute path
of the current directory. Calling
<function>dbplus_chdir</function> without giving any
<parameter>newdir</parameter> may be used to query the current
working directory.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

46
reference/dbplus/functions/dbplus-close.xml
View file

@ -1,28 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-close">
<refnamediv>
<refname>dbplus_close</refname>
<refpurpose>Close a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_close</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Calling <function>dbplus_close</function> will close a relation
previously opened by <function>dbplus_open</function>.
</para>
<para>
Returns &true; on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-close">
<refnamediv>
<refname>dbplus_close</refname>
<refpurpose>Close a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_close</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Calling <function>dbplus_close</function> will close a relation
previously opened by <function>dbplus_open</function>.
</para>
<para>
Returns &true; on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-curr.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-curr">
<refnamediv>
<refname>dbplus_curr</refname>
<refpurpose>Get current tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_curr</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the
current tuple for the given <parameter>relation</parameter> and
will pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_prev</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-curr">
<refnamediv>
<refname>dbplus_curr</refname>
<refpurpose>Get current tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_curr</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the
current tuple for the given <parameter>relation</parameter> and
will pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_prev</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/dbplus/functions/dbplus-errcode.xml
View file

@ -1,28 +1,26 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-errcode">
<refnamediv>
<refname>dbplus_errcode</refname>
<refpurpose>
Get error string for given errorcode or last error
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_errcode</methodname>
<methodparam choice="opt"><type>int</type><parameter>errno</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errcode</function> returns a cleartext error
string for the error code passed as <parameter>errno</parameter>
of for the result code of the last db++ operation if no parameter
is given.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-errcode">
<refnamediv>
<refname>dbplus_errcode</refname>
<refpurpose>Get error string for given errorcode or last error</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_errcode</methodname>
<methodparam choice="opt"><type>int</type><parameter>errno</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errcode</function> returns a cleartext error
string for the error code passed as <parameter>errno</parameter>
of for the result code of the last db++ operation if no parameter
is given.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/dbplus/functions/dbplus-errno.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 -->
<refentry id="function.dbplus-errno">
<refnamediv>
<refname>dbplus_errno</refname>
<refpurpose>Get error code for last operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_errno</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errno</function> will return the error code
returned by the last db++ operation.
</para>
<para>
See also <function>dbplus_errcode</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-errno">
<refnamediv>
<refname>dbplus_errno</refname>
<refpurpose>Get error code for last operation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_errno</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_errno</function> will return the error code
returned by the last db++ operation.
</para>
<para>
See also <function>dbplus_errcode</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/dbplus/functions/dbplus-find.xml
View file

@ -1,45 +1,45 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.5 -->
<refentry id="function.dbplus-find">
<refnamediv>
<refname>dbplus_find</refname>
<refpurpose>Set a constraint on a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_find</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>constraints</parameter></methodparam>
<methodparam><type>mixed</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_find</function> will place a constraint on the
given relation. Further calls to functions like
<function>dbplus_curr</function> or
<function>dbplus_next</function> will only return tuples matching
the given constraints.
</para>
<para>
Constraints are triplets of strings containing of a domain name,
a comparison operator and a comparison value. The
<parameter>constraints</parameter> parameter array may consist of
a collection of string arrays, each of which contains a domain, an
operator and a value, or of a single string array containing a
multiple of three elements.
</para>
<para>
The comparison operator may be one of the following strings:
'==', '&gt;', '&gt;=', '&lt;', '&lt;=', '!=', '~' for a regular
expression match and 'BAND' or 'BOR' for bitwise operations.
</para>
<para>
See also <function>dbplus_unselect</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-find">
<refnamediv>
<refname>dbplus_find</refname>
<refpurpose>Set a constraint on a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_find</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>constraints</parameter></methodparam>
<methodparam><type>mixed</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_find</function> will place a constraint on the
given relation. Further calls to functions like
<function>dbplus_curr</function> or
<function>dbplus_next</function> will only return tuples matching
the given constraints.
</para>
<para>
Constraints are triplets of strings containing of a domain name,
a comparison operator and a comparison value. The
<parameter>constraints</parameter> parameter array may consist of
a collection of string arrays, each of which contains a domain, an
operator and a value, or of a single string array containing a
multiple of three elements.
</para>
<para>
The comparison operator may be one of the following strings:
'==', '&gt;', '&gt;=', '&lt;', '&lt;=', '!=', '~' for a regular
expression match and 'BAND' or 'BOR' for bitwise operations.
</para>
<para>
See also <function>dbplus_unselect</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-first.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-first">
<refnamediv>
<refname>dbplus_first</refname>
<refpurpose>Get first tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_first</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the first
tuple for the given <parameter>relation</parameter>, make it the
current tuple and pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_curr</function>,
<function>dbplus_prev</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-first">
<refnamediv>
<refname>dbplus_first</refname>
<refpurpose>Get first tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_first</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the first
tuple for the given <parameter>relation</parameter>, make it the
current tuple and pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_curr</function>,
<function>dbplus_prev</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/dbplus/functions/dbplus-flush.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-flush">
<refnamediv>
<refname>dbplus_flush</refname>
<refpurpose>Flush all changes made on a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_flush</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_flush</function> will write all changes applied
to <parameter>relation</parameter> since the last flush to disk.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-flush">
<refnamediv>
<refname>dbplus_flush</refname>
<refpurpose>Flush all changes made on a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_flush</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_flush</function> will write all changes applied
to <parameter>relation</parameter> since the last flush to disk.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/dbplus/functions/dbplus-freealllocks.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 -->
<refentry id="function.dbplus-freealllocks">
<refnamediv>
<refname>dbplus_freealllocks</refname>
<refpurpose>Free all locks held by this client</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freealllocks</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freealllocks</function> will free all tuple locks
held by this client.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freelock</function>, and
<function>dbplus_freerlocks</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-freealllocks">
<refnamediv>
<refname>dbplus_freealllocks</refname>
<refpurpose>Free all locks held by this client</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freealllocks</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freealllocks</function> will free all tuple locks
held by this client.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freelock</function>, and
<function>dbplus_freerlocks</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

52
reference/dbplus/functions/dbplus-freelock.xml
View file

@ -1,31 +1,31 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-freelock">
<refnamediv>
<refname>dbplus_freelock</refname>
<refpurpose>Release write lock on tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freelock</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>tname</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freelock</function> will release a write lock on
the given <parameter>tuple</parameter> previously obtained by
<function>dbplus_getlock</function>.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freerlocks</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-freelock">
<refnamediv>
<refname>dbplus_freelock</refname>
<refpurpose>Release write lock on tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freelock</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>tname</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freelock</function> will release a write lock on
the given <parameter>tuple</parameter> previously obtained by
<function>dbplus_getlock</function>.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freerlocks</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/dbplus/functions/dbplus-freerlocks.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 -->
<refentry id="function.dbplus-freerlocks">
<refnamediv>
<refname>dbplus_freerlocks</refname>
<refpurpose>Free all tuple locks on given relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freerlocks</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freerlocks</function> will free all tuple locks held
on the given <parameter>relation</parameter>.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freelock</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-freerlocks">
<refnamediv>
<refname>dbplus_freerlocks</refname>
<refpurpose>Free all tuple locks on given relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_freerlocks</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_freerlocks</function> will free all tuple locks held
on the given <parameter>relation</parameter>.
</para>
<para>
See also <function>dbplus_getlock</function>,
<function>dbplus_freelock</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/dbplus/functions/dbplus-getlock.xml
View file

@ -1,32 +1,32 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.10 -->
<refentry id="function.dbplus-getlock">
<refnamediv>
<refname>dbplus_getlock</refname>
<refpurpose>Get a write lock on a tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_getlock</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>tname</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getlock</function> will request a write lock on
the specified <parameter>tuple</parameter>. It will return zero on
success or a non-zero error code, especially DBPLUS_ERR_WLOCKED,
on failure.
</para>
<para>
See also <function>dbplus_freelock</function>,
<function>dbplus_freerlocks</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-getlock">
<refnamediv>
<refname>dbplus_getlock</refname>
<refpurpose>Get a write lock on a tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_getlock</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>tname</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getlock</function> will request a write lock on
the specified <parameter>tuple</parameter>. It will return zero on
success or a non-zero error code, especially DBPLUS_ERR_WLOCKED,
on failure.
</para>
<para>
See also <function>dbplus_freelock</function>,
<function>dbplus_freerlocks</function>, and
<function>dbplus_freealllocks</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/dbplus/functions/dbplus-getunique.xml
View file

@ -1,33 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-getunique">
<refnamediv>
<refname>dbplus_getunique</refname>
<refpurpose>Get an id number unique to a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_getunique</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>uniqueid</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getunique</function> will obtain a number
guaranteed to be unique for the given
<parameter>relation</parameter> and will pass it back in the
variable given as <parameter>uniqueid</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-getunique">
<refnamediv>
<refname>dbplus_getunique</refname>
<refpurpose>Get an id number unique to a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_getunique</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>uniqueid</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_getunique</function> will obtain a number
guaranteed to be unique for the given
<parameter>relation</parameter> and will pass it back in the
variable given as <parameter>uniqueid</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/dbplus/functions/dbplus-info.xml
View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-info">
<refnamediv>
<refname>dbplus_info</refname>
<refpurpose>Get information about a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_info</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">result</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-info">
<refnamediv>
<refname>dbplus_info</refname>
<refpurpose>Get information about a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_info</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">result</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-last.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-last">
<refnamediv>
<refname>dbplus_last</refname>
<refpurpose>Get last tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_last</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the last
tuple for the given <parameter>relation</parameter>, make it the
current tuple and pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_prev</function>, and
<function>dbplus_next</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-last">
<refnamediv>
<refname>dbplus_last</refname>
<refpurpose>Get last tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_last</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the last
tuple for the given <parameter>relation</parameter>, make it the
current tuple and pass it back as an associative array in
<parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_prev</function>, and
<function>dbplus_next</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/dbplus/functions/dbplus-lockrel.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-lockrel">
<refnamediv>
<refname>dbplus_lockrel</refname>
<refpurpose>Request write lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_lockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_lockrel</function> will request a write lock
on the given relation. Other clients may still query the
relation, but can't alter it while it is locked.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-lockrel">
<refnamediv>
<refname>dbplus_lockrel</refname>
<refpurpose>Request write lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_lockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_lockrel</function> will request a write lock
on the given relation. Other clients may still query the
relation, but can't alter it while it is locked.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-next.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-next">
<refnamediv>
<refname>dbplus_next</refname>
<refpurpose>Get next tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_next</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the next
tuple for the given <parameter>relation</parameter>, will make it
the current tuple and will pass it back as an associative array
in <parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_prev</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-next">
<refnamediv>
<refname>dbplus_next</refname>
<refpurpose>Get next tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_next</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the next
tuple for the given <parameter>relation</parameter>, will make it
the current tuple and will pass it back as an associative array
in <parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_prev</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

56
reference/dbplus/functions/dbplus-open.xml
View file

@ -1,33 +1,33 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-open">
<refnamediv>
<refname>dbplus_open</refname>
<refpurpose>Open relation file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_open</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
The relation file <parameter>name</parameter> will be opened.
<parameter>name</parameter> can be either a file name or a
relative or absolute path name. This will be mapped in any case
to an absolute relation file path on a specific host machine and
server.
</para>
<para>
On success a relation file resource (cursor) is returned which must
be used in any subsequent commands referencing the relation.
Failure leads to a zero return value, the actual error code may
be asked for by calling <function>dbplus_errno</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-open">
<refnamediv>
<refname>dbplus_open</refname>
<refpurpose>Open relation file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_open</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
The relation file <parameter>name</parameter> will be opened.
<parameter>name</parameter> can be either a file name or a
relative or absolute path name. This will be mapped in any case
to an absolute relation file path on a specific host machine and
server.
</para>
<para>
On success a relation file resource (cursor) is returned which must
be used in any subsequent commands referencing the relation.
Failure leads to a zero return value, the actual error code may
be asked for by calling <function>dbplus_errno</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

68
reference/dbplus/functions/dbplus-prev.xml
View file

@ -1,39 +1,39 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-prev">
<refnamediv>
<refname>dbplus_prev</refname>
<refpurpose>Get previous tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_prev</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the previous
tuple for the given <parameter>relation</parameter>, will make it
the current tuple and will pass it back as an associative array
in <parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-prev">
<refnamediv>
<refname>dbplus_prev</refname>
<refpurpose>Get previous tuple from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_prev</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_curr</function> will read the data for the previous
tuple for the given <parameter>relation</parameter>, will make it
the current tuple and will pass it back as an associative array
in <parameter>tuple</parameter>.
</para>
<para>
The function will return zero (aka. DBPLUS_ERR_NOERR) on success
or a db++ error code on failure. See
<function>dbplus_errcode</function> or the introduction to this
chapter for more information on db++ error codes.
</para>
<para>
See also <function>dbplus_first</function>,
<function>dbplus_curr</function>,
<function>dbplus_next</function>, and
<function>dbplus_last</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/dbplus/functions/dbplus-rchperm.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rchperm">
<refnamediv>
<refname>dbplus_rchperm</refname>
<refpurpose>Change relation permissions</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rchperm</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>mask</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>group</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rchperm</function> will change access
permissions as specified by <parameter>mask</parameter>,
<parameter>user</parameter> and <parameter>group</parameter>. The
values for these are operating system specific.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rchperm">
<refnamediv>
<refname>dbplus_rchperm</refname>
<refpurpose>Change relation permissions</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rchperm</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>mask</parameter></methodparam>
<methodparam><type>string</type><parameter>user</parameter></methodparam>
<methodparam><type>string</type><parameter>group</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rchperm</function> will change access
permissions as specified by <parameter>mask</parameter>,
<parameter>user</parameter> and <parameter>group</parameter>. The
values for these are operating system specific.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/dbplus/functions/dbplus-rcreate.xml
View file

@ -1,40 +1,40 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rcreate">
<refnamediv>
<refname>dbplus_rcreate</refname>
<refpurpose>Creates a new DB++ relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rcreate</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcreate</function> will create a new relation
named <parameter>name</parameter>. An existing relation by the
same name will only be overwritten if the relation is currently
not in use and <parameter>overwrite</parameter> is set to TRUE.
</para>
<para>
<parameter>domlist</parameter> should contain the domain
specification for the new relation within an array of domain
description strings. ( <function>dbplus_rcreate</function> will
also accept a string with space delimited domain description
strings, but it is recommended to use an array). A domain
description string consists of a domain name unique to this
relation, a slash and a type specification character. See the
db++ documentation, especially the dbcreate(1) manpage, for a
description of available type specifiers and their meanings.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rcreate">
<refnamediv>
<refname>dbplus_rcreate</refname>
<refpurpose>Creates a new DB++ relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rcreate</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcreate</function> will create a new relation
named <parameter>name</parameter>. An existing relation by the
same name will only be overwritten if the relation is currently
not in use and <parameter>overwrite</parameter> is set to TRUE.
</para>
<para>
<parameter>domlist</parameter> should contain the domain
specification for the new relation within an array of domain
description strings. ( <function>dbplus_rcreate</function> will
also accept a string with space delimited domain description
strings, but it is recommended to use an array). A domain
description string consists of a domain name unique to this
relation, a slash and a type specification character. See the
db++ documentation, especially the dbcreate(1) manpage, for a
description of available type specifiers and their meanings.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/dbplus/functions/dbplus-rcrtexact.xml
View file

@ -1,34 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rcrtexact">
<refnamediv>
<refname>dbplus_rcrtexact</refname>
<refpurpose>Creates an exact but empty copy of a relation including indices</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rcrtexact</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an exact but
empty copy of the given <parameter>relation</parameter> under a
new <parameter>name</parameter>. An existing relation by the same
<parameter>name</parameter> will only be overwritten if
<parameter>overwrite</parameter> is &true; and no other process is
currently using the relation.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rcrtexact">
<refnamediv>
<refname>dbplus_rcrtexact</refname>
<refpurpose>Creates an exact but empty copy of a relation including indices</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rcrtexact</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an exact but
empty copy of the given <parameter>relation</parameter> under a
new <parameter>name</parameter>. An existing relation by the same
<parameter>name</parameter> will only be overwritten if
<parameter>overwrite</parameter> is &true; and no other process is
currently using the relation.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/dbplus/functions/dbplus-rcrtlike.xml
View file

@ -1,34 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rcrtlike">
<refnamediv>
<refname>dbplus_rcrtlike</refname>
<refpurpose>Creates an empty copy of a relation with default indices</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rcrtlike</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an empty copy
of the given <parameter>relation</parameter> under a new
<parameter>name</parameter>, but with default indices. An
existing relation by the same <parameter>name</parameter> will
only be overwritten if <parameter>overwrite</parameter> is &true;
and no other process is currently using the relation.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rcrtlike">
<refnamediv>
<refname>dbplus_rcrtlike</refname>
<refpurpose>Creates an empty copy of a relation with default indices</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rcrtlike</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>overwrite</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rcrtexact</function> will create an empty copy
of the given <parameter>relation</parameter> under a new
<parameter>name</parameter>, but with default indices. An
existing relation by the same <parameter>name</parameter> will
only be overwritten if <parameter>overwrite</parameter> is &true;
and no other process is currently using the relation.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/dbplus/functions/dbplus-resolve.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-resolve">
<refnamediv>
<refname>dbplus_resolve</refname>
<refpurpose>Resolve host information for relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>dbplus_resolve</methodname>
<methodparam><type>string</type><parameter>relation_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_resolve</function> will try to resolve the given
<parameter>relation_name</parameter> and find out internal server
id, real hostname and the database path on this host. The
function will return an array containing these values under the
keys 'sid', 'host' and 'host_path' or &false; on error.
</para>
<para>
See also <function>dbplus_tcl</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-resolve">
<refnamediv>
<refname>dbplus_resolve</refname>
<refpurpose>Resolve host information for relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>dbplus_resolve</methodname>
<methodparam><type>string</type><parameter>relation_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_resolve</function> will try to resolve the given
<parameter>relation_name</parameter> and find out internal server
id, real hostname and the database path on this host. The
function will return an array containing these values under the
keys 'sid', 'host' and 'host_path' or &false; on error.
</para>
<para>
See also <function>dbplus_tcl</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

34
reference/dbplus/functions/dbplus-restorepos.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-restorepos">
<refnamediv>
<refname>dbplus_restorepos</refname>
<refpurpose>Restore position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_restorepos</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-restorepos">
<refnamediv>
<refname>dbplus_restorepos</refname>
<refpurpose>Restore position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_restorepos</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/dbplus/functions/dbplus-rkeys.xml
View file

@ -1,34 +1,34 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rkeys">
<refnamediv>
<refname>dbplus_rkeys</refname>
<refpurpose>Specify new primary key for a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rkeys</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rkeys</function> will replace the current
primary key for <parameter>relation</parameter> with the
combination of domains specified by <parameter>domlist</parameter>.
</para>
<para>
<parameter>domlist</parameter> may be passed as a single domain name
string or as an array of domain names.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rkeys">
<refnamediv>
<refname>dbplus_rkeys</refname>
<refpurpose>Specify new primary key for a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rkeys</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rkeys</function> will replace the current
primary key for <parameter>relation</parameter> with the
combination of domains specified by <parameter>domlist</parameter>.
</para>
<para>
<parameter>domlist</parameter> may be passed as a single domain name
string or as an array of domain names.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

46
reference/dbplus/functions/dbplus-ropen.xml
View file

@ -1,28 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-ropen">
<refnamediv>
<refname>dbplus_ropen</refname>
<refpurpose>Open relation file local</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_ropen</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_ropen</function> will open the relation
<parameter>file</parameter> locally for quick access without any
client/server overhead. Access is read only and only
<function>dbplus_current</function> and
<function>dbplus_next</function> may be applied to the returned
relation.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-ropen">
<refnamediv>
<refname>dbplus_ropen</refname>
<refpurpose>Open relation file local</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_ropen</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_ropen</function> will open the relation
<parameter>file</parameter> locally for quick access without any
client/server overhead. Access is read only and only
<function>dbplus_current</function> and
<function>dbplus_next</function> may be applied to the returned
relation.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/dbplus/functions/dbplus-rquery.xml
View file

@ -1,27 +1,27 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rquery">
<refnamediv>
<refname>dbplus_rquery</refname>
<refpurpose>Perform local (raw) AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rquery</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rquery</function> performs a local (raw) AQL
query using an AQL interpreter embedded into the db++ client
library. <function>dbplus_rquery</function> is faster than
<function>dbplus_aql</function> but will work on local data only.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rquery">
<refnamediv>
<refname>dbplus_rquery</refname>
<refpurpose>Perform local (raw) AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rquery</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rquery</function> performs a local (raw) AQL
query using an AQL interpreter embedded into the db++ client
library. <function>dbplus_rquery</function> is faster than
<function>dbplus_aql</function> but will work on local data only.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/dbplus/functions/dbplus-rrename.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rrename">
<refnamediv>
<refname>dbplus_rrename</refname>
<refpurpose>Rename a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rrename</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rrename</function> will change the name of
<parameter>relation</parameter> to <parameter>name</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rrename">
<refnamediv>
<refname>dbplus_rrename</refname>
<refpurpose>Rename a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rrename</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rrename</function> will change the name of
<parameter>relation</parameter> to <parameter>name</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/dbplus/functions/dbplus-rsecindex.xml
View file

@ -1,38 +1,36 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rsecindex">
<refnamediv>
<refname>dbplus_rsecindex</refname>
<refpurpose>
Create a new secondary index for a relation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rsecindex</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rsecindex</function> will create a new secondary
index for <parameter>relation</parameter> with consists of the
domains specified by <parameter>domlist</parameter> and is of
type <parameter>type</parameter>
</para>
<para>
<parameter>domlist</parameter> may be passed as a single domain name
string or as an array of domain names.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rsecindex">
<refnamediv>
<refname>dbplus_rsecindex</refname>
<refpurpose>Create a new secondary index for a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>dbplus_rsecindex</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>mixed</type><parameter>domlist</parameter></methodparam>
<methodparam><type>int</type><parameter>type</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rsecindex</function> will create a new secondary
index for <parameter>relation</parameter> with consists of the
domains specified by <parameter>domlist</parameter> and is of
type <parameter>type</parameter>
</para>
<para>
<parameter>domlist</parameter> may be passed as a single domain name
string or as an array of domain names.
</para>
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/dbplus/functions/dbplus-runlink.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-runlink">
<refnamediv>
<refname>dbplus_runlink</refname>
<refpurpose>Remove relation from filesystem</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_runlink</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlink</function> will close and remove the
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-runlink">
<refnamediv>
<refname>dbplus_runlink</refname>
<refpurpose>Remove relation from filesystem</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_runlink</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlink</function> will close and remove the
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/dbplus/functions/dbplus-rzap.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-rzap">
<refnamediv>
<refname>dbplus_rzap</refname>
<refpurpose>Remove all tuples from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rzap</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rzap</function> will remove all tuples from
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rzap">
<refnamediv>
<refname>dbplus_rzap</refname>
<refpurpose>Remove all tuples from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rzap</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_rzap</function> will remove all tuples from
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/dbplus/functions/dbplus-savepos.xml
View file

@ -1,21 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-savepos">
<refnamediv>
<refname>dbplus_savepos</refname>
<refpurpose>Save position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_savepos</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-savepos">
<refnamediv>
<refname>dbplus_savepos</refname>
<refpurpose>Save position</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_savepos</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

34
reference/dbplus/functions/dbplus-setindex.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-setindex">
<refnamediv>
<refname>dbplus_setindex</refname>
<refpurpose>Set index</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_setindex</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>idx_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-setindex">
<refnamediv>
<refname>dbplus_setindex</refname>
<refpurpose>Set index</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_setindex</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>string</type><parameter>idx_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

34
reference/dbplus/functions/dbplus-setindexbynumber.xml
View file

@ -1,22 +1,22 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-setindexbynumber">
<refnamediv>
<refname>dbplus_setindexbynumber</refname>
<refpurpose>Set index by number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_setindexbynumber</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>idx_number</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-setindexbynumber">
<refnamediv>
<refname>dbplus_setindexbynumber</refname>
<refpurpose>Set index by number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_setindexbynumber</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>idx_number</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

36
reference/dbplus/functions/dbplus-sql.xml
View file

@ -1,23 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-sql">
<refnamediv>
<refname>dbplus_sql</refname>
<refpurpose>Perform SQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_sql</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-sql">
<refnamediv>
<refname>dbplus_sql</refname>
<refpurpose>Perform SQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_sql</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>server</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/dbplus/functions/dbplus-tcl.xml
View file

@ -1,38 +1,38 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-tcl">
<refnamediv>
<refname>dbplus_tcl</refname>
<refpurpose>Execute TCL code on server side</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_tcl</methodname>
<methodparam><type>int</type><parameter>sid</parameter></methodparam>
<methodparam><type>string</type><parameter>script</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
A db++ server will prepare a TCL interpreter for each client
connection. This interpreter will enable the server to execute
TCL code provided by the client as a sort of stored procedures to
improve the performance of database operations by avoiding
client/server data transfers and context switches.
</para>
<para>
<function>dbplus_tcl</function> needs to pass the client
connection id the TCL <parameter>script</parameter> code should
be executed by. <function>dbplus_resolve</function> will provide
this connection id. The function will return whatever the TCL
code returns or a TCL error message if the TCL code fails.
</para>
<para>
See also <function>dbplus_resolve</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-tcl">
<refnamediv>
<refname>dbplus_tcl</refname>
<refpurpose>Execute TCL code on server side</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>dbplus_tcl</methodname>
<methodparam><type>int</type><parameter>sid</parameter></methodparam>
<methodparam><type>string</type><parameter>script</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
A db++ server will prepare a TCL interpreter for each client
connection. This interpreter will enable the server to execute
TCL code provided by the client as a sort of stored procedures to
improve the performance of database operations by avoiding
client/server data transfers and context switches.
</para>
<para>
<function>dbplus_tcl</function> needs to pass the client
connection id the TCL <parameter>script</parameter> code should
be executed by. <function>dbplus_resolve</function> will provide
this connection id. The function will return whatever the TCL
code returns or a TCL error message if the TCL code fails.
</para>
<para>
See also <function>dbplus_resolve</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

50
reference/dbplus/functions/dbplus-tremove.xml
View file

@ -1,30 +1,30 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-tremove">
<refnamediv>
<refname>dbplus_tremove</refname>
<refpurpose>Remove tuple and return new current tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_tremove</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">current</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_tremove</function> removes
<parameter>tuple</parameter> from <parameter>relation</parameter>
if it perfectly matches a tuple within the
relation. <parameter>current</parameter>, if given, will contain
the data of the new current tuple after calling
<function>dbplus_tremove</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-tremove">
<refnamediv>
<refname>dbplus_tremove</refname>
<refpurpose>Remove tuple and return new current tuple</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_tremove</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>tuple</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter role="reference">current</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_tremove</function> removes
<parameter>tuple</parameter> from <parameter>relation</parameter>
if it perfectly matches a tuple within the
relation. <parameter>current</parameter>, if given, will contain
the data of the new current tuple after calling
<function>dbplus_tremove</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/dbplus/functions/dbplus-undo.xml
View file

@ -1,21 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-undo">
<refnamediv>
<refname>dbplus_undo</refname>
<refpurpose>Undo</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_undo</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-undo">
<refnamediv>
<refname>dbplus_undo</refname>
<refpurpose>Undo</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_undo</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/dbplus/functions/dbplus-undoprepare.xml
View file

@ -1,21 +1,21 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-undoprepare">
<refnamediv>
<refname>dbplus_undoprepare</refname>
<refpurpose>Prepare undo</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_undoprepare</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<refentry id="function.dbplus-undoprepare">
<refnamediv>
<refname>dbplus_undoprepare</refname>
<refpurpose>Prepare undo</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_undoprepare</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
&warn.undocumented.func;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/dbplus/functions/dbplus-unlockrel.xml
View file

@ -1,24 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-unlockrel">
<refnamediv>
<refname>dbplus_unlockrel</refname>
<refpurpose>Give up write lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_unlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlockrel</function> will release a write lock
previously obtained by <function>dbplus_lockrel</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-unlockrel">
<refnamediv>
<refname>dbplus_unlockrel</refname>
<refpurpose>Give up write lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_unlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_unlockrel</function> will release a write lock
previously obtained by <function>dbplus_lockrel</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/dbplus/functions/dbplus-unselect.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-unselect">
<refnamediv>
<refname>dbplus_unselect</refname>
<refpurpose>Remove a constraint from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_unselect</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Calling <function>dbplus_unselect</function> will remove a
constraint previously set by <function>dbplus_find</function> on
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-unselect">
<refnamediv>
<refname>dbplus_unselect</refname>
<refpurpose>Remove a constraint from relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_unselect</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Calling <function>dbplus_unselect</function> will remove a
constraint previously set by <function>dbplus_find</function> on
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/dbplus/functions/dbplus-update.xml
View file

@ -1,29 +1,29 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-update">
<refnamediv>
<refname>dbplus_update</refname>
<refpurpose>Update specified tuple in relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_update</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>old</parameter></methodparam>
<methodparam><type>array</type><parameter>new</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_update</function> replaces the tuple given by
<parameter>old</parameter> with the data from
<parameter>new</parameter> if and only if
<parameter>old</parameter> completely matches a tuple within
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-update">
<refnamediv>
<refname>dbplus_update</refname>
<refpurpose>Update specified tuple in relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_update</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>array</type><parameter>old</parameter></methodparam>
<methodparam><type>array</type><parameter>new</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_update</function> replaces the tuple given by
<parameter>old</parameter> with the data from
<parameter>new</parameter> if and only if
<parameter>old</parameter> completely matches a tuple within
<parameter>relation</parameter>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

46
reference/dbplus/functions/dbplus-xlockrel.xml
View file

@ -1,28 +1,28 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-xlockrel">
<refnamediv>
<refname>dbplus_xlockrel</refname>
<refpurpose>Request exclusive lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_xlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xlockrel</function> will request an exclusive
lock on <parameter>relation</parameter> preventing even read
access from other clients.
</para>
<para>
See also <function>dbplus_xunlockrel</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-xlockrel">
<refnamediv>
<refname>dbplus_xlockrel</refname>
<refpurpose>Request exclusive lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_xlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xlockrel</function> will request an exclusive
lock on <parameter>relation</parameter> preventing even read
access from other clients.
</para>
<para>
See also <function>dbplus_xunlockrel</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

40
reference/dbplus/functions/dbplus-xunlockrel.xml
View file

@ -1,25 +1,25 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
<refentry id="function.dbplus-xunlockrel">
<refnamediv>
<refname>dbplus_xunlockrel</refname>
<refpurpose>Free exclusive lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_xunlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xunlockrel</function> will release an exclusive
lock on <parameter>relation</parameter> previously obtained by
<function>dbplus_xlockrel</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-xunlockrel">
<refnamediv>
<refname>dbplus_xunlockrel</refname>
<refpurpose>Free exclusive lock on relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_xunlockrel</methodname>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>dbplus_xunlockrel</function> will release an exclusive
lock on <parameter>relation</parameter> previously obtained by
<function>dbplus_xlockrel</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables: