From 8914c66fc57ac14f3db26a62868fff3413d7ebb8 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sun, 4 Mar 2007 00:37:56 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@231114 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/dbplus/functions/dbplus-add.xml | 62 +++++++------- reference/dbplus/functions/dbplus-aql.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-chdir.xml | 50 ++++++------ reference/dbplus/functions/dbplus-close.xml | 46 +++++------ reference/dbplus/functions/dbplus-curr.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-errcode.xml | 44 +++++----- reference/dbplus/functions/dbplus-errno.xml | 44 +++++----- reference/dbplus/functions/dbplus-find.xml | 80 +++++++++---------- reference/dbplus/functions/dbplus-first.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-flush.xml | 50 ++++++------ .../dbplus/functions/dbplus-freealllocks.xml | 48 +++++------ .../dbplus/functions/dbplus-freelock.xml | 52 ++++++------ .../dbplus/functions/dbplus-freerlocks.xml | 48 +++++------ reference/dbplus/functions/dbplus-getlock.xml | 54 ++++++------- .../dbplus/functions/dbplus-getunique.xml | 56 ++++++------- reference/dbplus/functions/dbplus-info.xml | 36 ++++----- reference/dbplus/functions/dbplus-last.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-lockrel.xml | 40 +++++----- reference/dbplus/functions/dbplus-next.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-open.xml | 56 ++++++------- reference/dbplus/functions/dbplus-prev.xml | 68 ++++++++-------- reference/dbplus/functions/dbplus-rchperm.xml | 48 +++++------ reference/dbplus/functions/dbplus-rcreate.xml | 70 ++++++++-------- .../dbplus/functions/dbplus-rcrtexact.xml | 58 +++++++------- .../dbplus/functions/dbplus-rcrtlike.xml | 58 +++++++------- reference/dbplus/functions/dbplus-resolve.xml | 50 ++++++------ .../dbplus/functions/dbplus-restorepos.xml | 34 ++++---- reference/dbplus/functions/dbplus-rkeys.xml | 58 +++++++------- reference/dbplus/functions/dbplus-ropen.xml | 46 +++++------ reference/dbplus/functions/dbplus-rquery.xml | 44 +++++----- reference/dbplus/functions/dbplus-rrename.xml | 40 +++++----- .../dbplus/functions/dbplus-rsecindex.xml | 64 +++++++-------- reference/dbplus/functions/dbplus-runlink.xml | 38 ++++----- reference/dbplus/functions/dbplus-rzap.xml | 38 ++++----- reference/dbplus/functions/dbplus-savepos.xml | 32 ++++---- .../dbplus/functions/dbplus-setindex.xml | 34 ++++---- .../functions/dbplus-setindexbynumber.xml | 34 ++++---- reference/dbplus/functions/dbplus-sql.xml | 36 ++++----- reference/dbplus/functions/dbplus-tcl.xml | 66 +++++++-------- reference/dbplus/functions/dbplus-tremove.xml | 50 ++++++------ reference/dbplus/functions/dbplus-undo.xml | 32 ++++---- .../dbplus/functions/dbplus-undoprepare.xml | 32 ++++---- .../dbplus/functions/dbplus-unlockrel.xml | 38 ++++----- .../dbplus/functions/dbplus-unselect.xml | 40 +++++----- reference/dbplus/functions/dbplus-update.xml | 48 +++++------ .../dbplus/functions/dbplus-xlockrel.xml | 46 +++++------ .../dbplus/functions/dbplus-xunlockrel.xml | 40 +++++----- 47 files changed, 1172 insertions(+), 1176 deletions(-) diff --git a/reference/dbplus/functions/dbplus-add.xml b/reference/dbplus/functions/dbplus-add.xml index 3a4e7c0245..86a456af18 100644 --- a/reference/dbplus/functions/dbplus-add.xml +++ b/reference/dbplus/functions/dbplus-add.xml @@ -1,36 +1,36 @@ - + - - - dbplus_add - Add a tuple to a relation - - - Description - - intdbplus_add - resourcerelation - arraytuple - - &warn.experimental.func; - - This function will add a tuple to a relation. The - tuple data is an array of attribute/value - pairs to be inserted into the given - relation. After successful execution the - tuple array will contain the complete data - of the newly created tuple, including all implicitly set domain - fields like sequences. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - + + + dbplus_add + Add a tuple to a relation + + + Description + + intdbplus_add + resourcerelation + arraytuple + + &warn.experimental.func; + + This function will add a tuple to a relation. The + tuple data is an array of attribute/value + pairs to be inserted into the given + relation. After successful execution the + tuple array will contain the complete data + of the newly created tuple, including all implicitly set domain + fields like sequences. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + + - - - dbplus_aql - Perform AQL query - - - Description - - resourcedbplus_aql - stringquery - stringserver - stringdbpath - - &warn.experimental.func; - - dbplus_aql will execute an AQL - query on the given - server and - dbpath. - - - On success it will return a relation handle. The result data may - be fetched from this relation by calling - dbplus_next and - dbplus_current. Other relation access - functions will not work on a result relation. - - - Further information on the AQL A... Query Language is provided in - the original db++ manual. - - - + + + dbplus_aql + Perform AQL query + + + Description + + resourcedbplus_aql + stringquery + stringserver + stringdbpath + + &warn.experimental.func; + + dbplus_aql will execute an AQL + query on the given + server and + dbpath. + + + On success it will return a relation handle. The result data may + be fetched from this relation by calling + dbplus_next and + dbplus_current. Other relation access + functions will not work on a result relation. + + + Further information on the AQL A... Query Language is provided in + the original db++ manual. + + + + - - - dbplus_chdir - Get/Set database virtual current directory - - - Description - - stringdbplus_chdir - stringnewdir - - &warn.experimental.func; - - dbplus_chdir will change the virtual current - directory where relation files will be looked for by - dbplus_open. - dbplus_chdir will return the absolute path - of the current directory. Calling - dbplus_chdir without giving any - newdir may be used to query the current - working directory. - - - + + + dbplus_chdir + Get/Set database virtual current directory + + + Description + + stringdbplus_chdir + stringnewdir + + &warn.experimental.func; + + dbplus_chdir will change the virtual current + directory where relation files will be looked for by + dbplus_open. + dbplus_chdir will return the absolute path + of the current directory. Calling + dbplus_chdir without giving any + newdir may be used to query the current + working directory. + + + + - - - dbplus_close - Close a relation - - - Description - - mixeddbplus_close - resourcerelation - - &warn.experimental.func; - - Calling dbplus_close will close a relation - previously opened by dbplus_open. - - - Returns &true; on success or DBPLUS_ERR_UNKNOWN on - failure. - - - + + + dbplus_close + Close a relation + + + Description + + mixeddbplus_close + resourcerelation + + &warn.experimental.func; + + Calling dbplus_close will close a relation + previously opened by dbplus_open. + + + Returns &true; on success or DBPLUS_ERR_UNKNOWN on + failure. + + + + - - - dbplus_curr - Get current tuple from relation - - - Description - - intdbplus_curr - resourcerelation - arraytuple - - &warn.experimental.func; - - dbplus_curr will read the data for the - current tuple for the given relation and - will pass it back as an associative array in - tuple. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - See also dbplus_first, - dbplus_prev, - dbplus_next, and - dbplus_last. - - - + + + dbplus_curr + Get current tuple from relation + + + Description + + intdbplus_curr + resourcerelation + arraytuple + + &warn.experimental.func; + + dbplus_curr will read the data for the + current tuple for the given relation and + will pass it back as an associative array in + tuple. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + See also dbplus_first, + dbplus_prev, + dbplus_next, and + dbplus_last. + + + + - - - dbplus_errcode - - Get error string for given errorcode or last error - - - - Description - - stringdbplus_errcode - interrno - - &warn.experimental.func; - - dbplus_errcode returns a cleartext error - string for the error code passed as errno - of for the result code of the last db++ operation if no parameter - is given. - - - + + + dbplus_errcode + Get error string for given errorcode or last error + + + Description + + stringdbplus_errcode + interrno + + &warn.experimental.func; + + dbplus_errcode returns a cleartext error + string for the error code passed as errno + of for the result code of the last db++ operation if no parameter + is given. + + + + - - - dbplus_errno - Get error code for last operation - - - Description - - intdbplus_errno - - - &warn.experimental.func; - - dbplus_errno will return the error code - returned by the last db++ operation. - - - See also dbplus_errcode. - - - + + + dbplus_errno + Get error code for last operation + + + Description + + intdbplus_errno + + + &warn.experimental.func; + + dbplus_errno will return the error code + returned by the last db++ operation. + + + See also dbplus_errcode. + + + + - - - dbplus_find - Set a constraint on a relation - - - Description - - intdbplus_find - resourcerelation - arrayconstraints - mixedtuple - - &warn.experimental.func; - - dbplus_find will place a constraint on the - given relation. Further calls to functions like - dbplus_curr or - dbplus_next will only return tuples matching - the given constraints. - - - Constraints are triplets of strings containing of a domain name, - a comparison operator and a comparison value. The - constraints 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. - - - The comparison operator may be one of the following strings: - '==', '>', '>=', '<', '<=', '!=', '~' for a regular - expression match and 'BAND' or 'BOR' for bitwise operations. - - - See also dbplus_unselect. - - - + + + dbplus_find + Set a constraint on a relation + + + Description + + intdbplus_find + resourcerelation + arrayconstraints + mixedtuple + + &warn.experimental.func; + + dbplus_find will place a constraint on the + given relation. Further calls to functions like + dbplus_curr or + dbplus_next will only return tuples matching + the given constraints. + + + Constraints are triplets of strings containing of a domain name, + a comparison operator and a comparison value. The + constraints 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. + + + The comparison operator may be one of the following strings: + '==', '>', '>=', '<', '<=', '!=', '~' for a regular + expression match and 'BAND' or 'BOR' for bitwise operations. + + + See also dbplus_unselect. + + + + - - - dbplus_first - Get first tuple from relation - - - Description - - intdbplus_first - resourcerelation - arraytuple - - &warn.experimental.func; - - dbplus_curr will read the data for the first - tuple for the given relation, make it the - current tuple and pass it back as an associative array in - tuple. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - See also dbplus_curr, - dbplus_prev, - dbplus_next, and - dbplus_last. - - - + + + dbplus_first + Get first tuple from relation + + + Description + + intdbplus_first + resourcerelation + arraytuple + + &warn.experimental.func; + + dbplus_curr will read the data for the first + tuple for the given relation, make it the + current tuple and pass it back as an associative array in + tuple. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + See also dbplus_curr, + dbplus_prev, + dbplus_next, and + dbplus_last. + + + + - - - dbplus_flush - Flush all changes made on a relation - - - Description - - intdbplus_flush - resourcerelation - - &warn.experimental.func; - - dbplus_flush will write all changes applied - to relation since the last flush to disk. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - + + + dbplus_flush + Flush all changes made on a relation + + + Description + + intdbplus_flush + resourcerelation + + &warn.experimental.func; + + dbplus_flush will write all changes applied + to relation since the last flush to disk. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + + - - - dbplus_freealllocks - Free all locks held by this client - - - Description - - intdbplus_freealllocks - - - &warn.experimental.func; - - dbplus_freealllocks will free all tuple locks - held by this client. - - - See also dbplus_getlock, - dbplus_freelock, and - dbplus_freerlocks. - - - + + + dbplus_freealllocks + Free all locks held by this client + + + Description + + intdbplus_freealllocks + + + &warn.experimental.func; + + dbplus_freealllocks will free all tuple locks + held by this client. + + + See also dbplus_getlock, + dbplus_freelock, and + dbplus_freerlocks. + + + + - - - dbplus_freelock - Release write lock on tuple - - - Description - - intdbplus_freelock - resourcerelation - stringtname - - &warn.experimental.func; - - dbplus_freelock will release a write lock on - the given tuple previously obtained by - dbplus_getlock. - - - See also dbplus_getlock, - dbplus_freerlocks, and - dbplus_freealllocks. - - - + + + dbplus_freelock + Release write lock on tuple + + + Description + + intdbplus_freelock + resourcerelation + stringtname + + &warn.experimental.func; + + dbplus_freelock will release a write lock on + the given tuple previously obtained by + dbplus_getlock. + + + See also dbplus_getlock, + dbplus_freerlocks, and + dbplus_freealllocks. + + + + - - - dbplus_freerlocks - Free all tuple locks on given relation - - - Description - - intdbplus_freerlocks - resourcerelation - - &warn.experimental.func; - - dbplus_freerlocks will free all tuple locks held - on the given relation. - - - See also dbplus_getlock, - dbplus_freelock, and - dbplus_freealllocks. - - - + + + dbplus_freerlocks + Free all tuple locks on given relation + + + Description + + intdbplus_freerlocks + resourcerelation + + &warn.experimental.func; + + dbplus_freerlocks will free all tuple locks held + on the given relation. + + + See also dbplus_getlock, + dbplus_freelock, and + dbplus_freealllocks. + + + + - - - dbplus_getlock - Get a write lock on a tuple - - - Description - - intdbplus_getlock - resourcerelation - stringtname - - &warn.experimental.func; - - dbplus_getlock will request a write lock on - the specified tuple. It will return zero on - success or a non-zero error code, especially DBPLUS_ERR_WLOCKED, - on failure. - - - See also dbplus_freelock, - dbplus_freerlocks, and - dbplus_freealllocks. - - - + + + dbplus_getlock + Get a write lock on a tuple + + + Description + + intdbplus_getlock + resourcerelation + stringtname + + &warn.experimental.func; + + dbplus_getlock will request a write lock on + the specified tuple. It will return zero on + success or a non-zero error code, especially DBPLUS_ERR_WLOCKED, + on failure. + + + See also dbplus_freelock, + dbplus_freerlocks, and + dbplus_freealllocks. + + + + - - - dbplus_getunique - Get an id number unique to a relation - - - Description - - intdbplus_getunique - resourcerelation - intuniqueid - - &warn.experimental.func; - - dbplus_getunique will obtain a number - guaranteed to be unique for the given - relation and will pass it back in the - variable given as uniqueid. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - + + + dbplus_getunique + Get an id number unique to a relation + + + Description + + intdbplus_getunique + resourcerelation + intuniqueid + + &warn.experimental.func; + + dbplus_getunique will obtain a number + guaranteed to be unique for the given + relation and will pass it back in the + variable given as uniqueid. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + + - - - dbplus_info - Get information about a relation - - - Description - - intdbplus_info - resourcerelation - stringkey - arrayresult - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_info + Get information about a relation + + + Description + + intdbplus_info + resourcerelation + stringkey + arrayresult + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_last - Get last tuple from relation - - - Description - - intdbplus_last - resourcerelation - arraytuple - - &warn.experimental.func; - - dbplus_curr will read the data for the last - tuple for the given relation, make it the - current tuple and pass it back as an associative array in - tuple. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - See also dbplus_first, - dbplus_curr, - dbplus_prev, and - dbplus_next. - - - + + + dbplus_last + Get last tuple from relation + + + Description + + intdbplus_last + resourcerelation + arraytuple + + &warn.experimental.func; + + dbplus_curr will read the data for the last + tuple for the given relation, make it the + current tuple and pass it back as an associative array in + tuple. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + See also dbplus_first, + dbplus_curr, + dbplus_prev, and + dbplus_next. + + + + - - - dbplus_lockrel - Request write lock on relation - - - Description - - intdbplus_lockrel - resourcerelation - - &warn.experimental.func; - - dbplus_lockrel 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. - - - + + + dbplus_lockrel + Request write lock on relation + + + Description + + intdbplus_lockrel + resourcerelation + + &warn.experimental.func; + + dbplus_lockrel 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. + + + + - - - dbplus_next - Get next tuple from relation - - - Description - - intdbplus_next - resourcerelation - arraytuple - - &warn.experimental.func; - - dbplus_curr will read the data for the next - tuple for the given relation, will make it - the current tuple and will pass it back as an associative array - in tuple. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - See also dbplus_first, - dbplus_curr, - dbplus_prev, and - dbplus_last. - - - + + + dbplus_next + Get next tuple from relation + + + Description + + intdbplus_next + resourcerelation + arraytuple + + &warn.experimental.func; + + dbplus_curr will read the data for the next + tuple for the given relation, will make it + the current tuple and will pass it back as an associative array + in tuple. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + See also dbplus_first, + dbplus_curr, + dbplus_prev, and + dbplus_last. + + + + - - - dbplus_open - Open relation file - - - Description - - resourcedbplus_open - stringname - - &warn.experimental.func; - - The relation file name will be opened. - name 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. - - - 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 dbplus_errno. - - - + + + dbplus_open + Open relation file + + + Description + + resourcedbplus_open + stringname + + &warn.experimental.func; + + The relation file name will be opened. + name 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. + + + 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 dbplus_errno. + + + + - - - dbplus_prev - Get previous tuple from relation - - - Description - - intdbplus_prev - resourcerelation - arraytuple - - &warn.experimental.func; - - dbplus_curr will read the data for the previous - tuple for the given relation, will make it - the current tuple and will pass it back as an associative array - in tuple. - - - The function will return zero (aka. DBPLUS_ERR_NOERR) on success - or a db++ error code on failure. See - dbplus_errcode or the introduction to this - chapter for more information on db++ error codes. - - - See also dbplus_first, - dbplus_curr, - dbplus_next, and - dbplus_last. - - - + + + dbplus_prev + Get previous tuple from relation + + + Description + + intdbplus_prev + resourcerelation + arraytuple + + &warn.experimental.func; + + dbplus_curr will read the data for the previous + tuple for the given relation, will make it + the current tuple and will pass it back as an associative array + in tuple. + + + The function will return zero (aka. DBPLUS_ERR_NOERR) on success + or a db++ error code on failure. See + dbplus_errcode or the introduction to this + chapter for more information on db++ error codes. + + + See also dbplus_first, + dbplus_curr, + dbplus_next, and + dbplus_last. + + + + - - - dbplus_rchperm - Change relation permissions - - - Description - - intdbplus_rchperm - resourcerelation - intmask - stringuser - stringgroup - - &warn.experimental.func; - - dbplus_rchperm will change access - permissions as specified by mask, - user and group. The - values for these are operating system specific. - - - + + + dbplus_rchperm + Change relation permissions + + + Description + + intdbplus_rchperm + resourcerelation + intmask + stringuser + stringgroup + + &warn.experimental.func; + + dbplus_rchperm will change access + permissions as specified by mask, + user and group. The + values for these are operating system specific. + + + + - - - dbplus_rcreate - Creates a new DB++ relation - - - Description - - resourcedbplus_rcreate - stringname - mixeddomlist - booloverwrite - - &warn.experimental.func; - - dbplus_rcreate will create a new relation - named name. An existing relation by the - same name will only be overwritten if the relation is currently - not in use and overwrite is set to TRUE. - - - domlist should contain the domain - specification for the new relation within an array of domain - description strings. ( dbplus_rcreate 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. - - - - + + + dbplus_rcreate + Creates a new DB++ relation + + + Description + + resourcedbplus_rcreate + stringname + mixeddomlist + booloverwrite + + &warn.experimental.func; + + dbplus_rcreate will create a new relation + named name. An existing relation by the + same name will only be overwritten if the relation is currently + not in use and overwrite is set to TRUE. + + + domlist should contain the domain + specification for the new relation within an array of domain + description strings. ( dbplus_rcreate 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. + + + + + - - - dbplus_rcrtexact - Creates an exact but empty copy of a relation including indices - - - Description - - mixeddbplus_rcrtexact - stringname - resourcerelation - booloverwrite - - &warn.experimental.func; - - dbplus_rcrtexact will create an exact but - empty copy of the given relation under a - new name. An existing relation by the same - name will only be overwritten if - overwrite is &true; and no other process is - currently using the relation. - - - Returns resource on success or DBPLUS_ERR_UNKNOWN on - failure. - - - + + + dbplus_rcrtexact + Creates an exact but empty copy of a relation including indices + + + Description + + mixeddbplus_rcrtexact + stringname + resourcerelation + booloverwrite + + &warn.experimental.func; + + dbplus_rcrtexact will create an exact but + empty copy of the given relation under a + new name. An existing relation by the same + name will only be overwritten if + overwrite is &true; and no other process is + currently using the relation. + + + Returns resource on success or DBPLUS_ERR_UNKNOWN on + failure. + + + + - - - dbplus_rcrtlike - Creates an empty copy of a relation with default indices - - - Description - - mixeddbplus_rcrtlike - stringname - resourcerelation - intoverwrite - - &warn.experimental.func; - - dbplus_rcrtexact will create an empty copy - of the given relation under a new - name, but with default indices. An - existing relation by the same name will - only be overwritten if overwrite is &true; - and no other process is currently using the relation. - - - Returns resource on success or DBPLUS_ERR_UNKNOWN on - failure. - - - + + + dbplus_rcrtlike + Creates an empty copy of a relation with default indices + + + Description + + mixeddbplus_rcrtlike + stringname + resourcerelation + intoverwrite + + &warn.experimental.func; + + dbplus_rcrtexact will create an empty copy + of the given relation under a new + name, but with default indices. An + existing relation by the same name will + only be overwritten if overwrite is &true; + and no other process is currently using the relation. + + + Returns resource on success or DBPLUS_ERR_UNKNOWN on + failure. + + + + - - - dbplus_resolve - Resolve host information for relation - - - Description - - arraydbplus_resolve - stringrelation_name - - &warn.experimental.func; - - dbplus_resolve will try to resolve the given - relation_name 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. - - - See also dbplus_tcl. - - - + + + dbplus_resolve + Resolve host information for relation + + + Description + + arraydbplus_resolve + stringrelation_name + + &warn.experimental.func; + + dbplus_resolve will try to resolve the given + relation_name 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. + + + See also dbplus_tcl. + + + + - - - dbplus_restorepos - Restore position - - - Description - - intdbplus_restorepos - resourcerelation - arraytuple - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_restorepos + Restore position + + + Description + + intdbplus_restorepos + resourcerelation + arraytuple + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_rkeys - Specify new primary key for a relation - - - Description - - mixeddbplus_rkeys - resourcerelation - mixeddomlist - - &warn.experimental.func; - - dbplus_rkeys will replace the current - primary key for relation with the - combination of domains specified by domlist. - - - domlist may be passed as a single domain name - string or as an array of domain names. - - - Returns resource on success or DBPLUS_ERR_UNKNOWN on - failure. - - - + + + dbplus_rkeys + Specify new primary key for a relation + + + Description + + mixeddbplus_rkeys + resourcerelation + mixeddomlist + + &warn.experimental.func; + + dbplus_rkeys will replace the current + primary key for relation with the + combination of domains specified by domlist. + + + domlist may be passed as a single domain name + string or as an array of domain names. + + + Returns resource on success or DBPLUS_ERR_UNKNOWN on + failure. + + + + - - - dbplus_ropen - Open relation file local - - - Description - - resourcedbplus_ropen - stringname - - &warn.experimental.func; - - dbplus_ropen will open the relation - file locally for quick access without any - client/server overhead. Access is read only and only - dbplus_current and - dbplus_next may be applied to the returned - relation. - - - + + + dbplus_ropen + Open relation file local + + + Description + + resourcedbplus_ropen + stringname + + &warn.experimental.func; + + dbplus_ropen will open the relation + file locally for quick access without any + client/server overhead. Access is read only and only + dbplus_current and + dbplus_next may be applied to the returned + relation. + + + + - - - dbplus_rquery - Perform local (raw) AQL query - - - Description - - resourcedbplus_rquery - stringquery - stringdbpath - - &warn.experimental.func; - - dbplus_rquery performs a local (raw) AQL - query using an AQL interpreter embedded into the db++ client - library. dbplus_rquery is faster than - dbplus_aql but will work on local data only. - - - + + + dbplus_rquery + Perform local (raw) AQL query + + + Description + + resourcedbplus_rquery + stringquery + stringdbpath + + &warn.experimental.func; + + dbplus_rquery performs a local (raw) AQL + query using an AQL interpreter embedded into the db++ client + library. dbplus_rquery is faster than + dbplus_aql but will work on local data only. + + + + - - - dbplus_rrename - Rename a relation - - - Description - - intdbplus_rrename - resourcerelation - stringname - - &warn.experimental.func; - - dbplus_rrename will change the name of - relation to name. - - - + + + dbplus_rrename + Rename a relation + + + Description + + intdbplus_rrename + resourcerelation + stringname + + &warn.experimental.func; + + dbplus_rrename will change the name of + relation to name. + + + + - - - dbplus_rsecindex - - Create a new secondary index for a relation - - - - Description - - mixeddbplus_rsecindex - resourcerelation - mixeddomlist - inttype - - &warn.experimental.func; - - dbplus_rsecindex will create a new secondary - index for relation with consists of the - domains specified by domlist and is of - type type - - - domlist may be passed as a single domain name - string or as an array of domain names. - - - Returns resource on success or DBPLUS_ERR_UNKNOWN on - failure. - - - + + + dbplus_rsecindex + Create a new secondary index for a relation + + + Description + + mixeddbplus_rsecindex + resourcerelation + mixeddomlist + inttype + + &warn.experimental.func; + + dbplus_rsecindex will create a new secondary + index for relation with consists of the + domains specified by domlist and is of + type type + + + domlist may be passed as a single domain name + string or as an array of domain names. + + + Returns resource on success or DBPLUS_ERR_UNKNOWN on + failure. + + + + - - - dbplus_runlink - Remove relation from filesystem - - - Description - - intdbplus_runlink - resourcerelation - - &warn.experimental.func; - - dbplus_unlink will close and remove the - relation. - - - + + + dbplus_runlink + Remove relation from filesystem + + + Description + + intdbplus_runlink + resourcerelation + + &warn.experimental.func; + + dbplus_unlink will close and remove the + relation. + + + + - - - dbplus_rzap - Remove all tuples from relation - - - Description - - intdbplus_rzap - resourcerelation - - &warn.experimental.func; - - dbplus_rzap will remove all tuples from - relation. - - - + + + dbplus_rzap + Remove all tuples from relation + + + Description + + intdbplus_rzap + resourcerelation + + &warn.experimental.func; + + dbplus_rzap will remove all tuples from + relation. + + + + - - - dbplus_savepos - Save position - - - Description - - intdbplus_savepos - resourcerelation - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_savepos + Save position + + + Description + + intdbplus_savepos + resourcerelation + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_setindex - Set index - - - Description - - intdbplus_setindex - resourcerelation - stringidx_name - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_setindex + Set index + + + Description + + intdbplus_setindex + resourcerelation + stringidx_name + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_setindexbynumber - Set index by number - - - Description - - intdbplus_setindexbynumber - resourcerelation - intidx_number - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_setindexbynumber + Set index by number + + + Description + + intdbplus_setindexbynumber + resourcerelation + intidx_number + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_sql - Perform SQL query - - - Description - - resourcedbplus_sql - stringquery - stringserver - stringdbpath - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_sql + Perform SQL query + + + Description + + resourcedbplus_sql + stringquery + stringserver + stringdbpath + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_tcl - Execute TCL code on server side - - - Description - - stringdbplus_tcl - intsid - stringscript - - &warn.experimental.func; - - 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. - - - dbplus_tcl needs to pass the client - connection id the TCL script code should - be executed by. dbplus_resolve will provide - this connection id. The function will return whatever the TCL - code returns or a TCL error message if the TCL code fails. - - - See also dbplus_resolve. - - - + + + dbplus_tcl + Execute TCL code on server side + + + Description + + stringdbplus_tcl + intsid + stringscript + + &warn.experimental.func; + + 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. + + + dbplus_tcl needs to pass the client + connection id the TCL script code should + be executed by. dbplus_resolve will provide + this connection id. The function will return whatever the TCL + code returns or a TCL error message if the TCL code fails. + + + See also dbplus_resolve. + + + + - - - dbplus_tremove - Remove tuple and return new current tuple - - - Description - - intdbplus_tremove - resourcerelation - arraytuple - arraycurrent - - &warn.experimental.func; - - dbplus_tremove removes - tuple from relation - if it perfectly matches a tuple within the - relation. current, if given, will contain - the data of the new current tuple after calling - dbplus_tremove. - - - + + + dbplus_tremove + Remove tuple and return new current tuple + + + Description + + intdbplus_tremove + resourcerelation + arraytuple + arraycurrent + + &warn.experimental.func; + + dbplus_tremove removes + tuple from relation + if it perfectly matches a tuple within the + relation. current, if given, will contain + the data of the new current tuple after calling + dbplus_tremove. + + + + - - - dbplus_undo - Undo - - - Description - - intdbplus_undo - resourcerelation - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_undo + Undo + + + Description + + intdbplus_undo + resourcerelation + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_undoprepare - Prepare undo - - - Description - - intdbplus_undoprepare - resourcerelation - - &warn.experimental.func; - &warn.undocumented.func; - - + + + dbplus_undoprepare + Prepare undo + + + Description + + intdbplus_undoprepare + resourcerelation + + &warn.experimental.func; + &warn.undocumented.func; + + + - - - dbplus_unlockrel - Give up write lock on relation - - - Description - - intdbplus_unlockrel - resourcerelation - - &warn.experimental.func; - - dbplus_unlockrel will release a write lock - previously obtained by dbplus_lockrel. - - - + + + dbplus_unlockrel + Give up write lock on relation + + + Description + + intdbplus_unlockrel + resourcerelation + + &warn.experimental.func; + + dbplus_unlockrel will release a write lock + previously obtained by dbplus_lockrel. + + + + - - - dbplus_unselect - Remove a constraint from relation - - - Description - - intdbplus_unselect - resourcerelation - - &warn.experimental.func; - - Calling dbplus_unselect will remove a - constraint previously set by dbplus_find on - relation. - - - + + + dbplus_unselect + Remove a constraint from relation + + + Description + + intdbplus_unselect + resourcerelation + + &warn.experimental.func; + + Calling dbplus_unselect will remove a + constraint previously set by dbplus_find on + relation. + + + + - - - dbplus_update - Update specified tuple in relation - - - Description - - intdbplus_update - resourcerelation - arrayold - arraynew - - &warn.experimental.func; - - dbplus_update replaces the tuple given by - old with the data from - new if and only if - old completely matches a tuple within - relation. - - - + + + dbplus_update + Update specified tuple in relation + + + Description + + intdbplus_update + resourcerelation + arrayold + arraynew + + &warn.experimental.func; + + dbplus_update replaces the tuple given by + old with the data from + new if and only if + old completely matches a tuple within + relation. + + + + - - - dbplus_xlockrel - Request exclusive lock on relation - - - Description - - intdbplus_xlockrel - resourcerelation - - &warn.experimental.func; - - dbplus_xlockrel will request an exclusive - lock on relation preventing even read - access from other clients. - - - See also dbplus_xunlockrel. - - - + + + dbplus_xlockrel + Request exclusive lock on relation + + + Description + + intdbplus_xlockrel + resourcerelation + + &warn.experimental.func; + + dbplus_xlockrel will request an exclusive + lock on relation preventing even read + access from other clients. + + + See also dbplus_xunlockrel. + + + + - - - dbplus_xunlockrel - Free exclusive lock on relation - - - Description - - intdbplus_xunlockrel - resourcerelation - - &warn.experimental.func; - - dbplus_xunlockrel will release an exclusive - lock on relation previously obtained by - dbplus_xlockrel. - - - + + + dbplus_xunlockrel + Free exclusive lock on relation + + + Description + + intdbplus_xunlockrel + resourcerelation + + &warn.experimental.func; + + dbplus_xunlockrel will release an exclusive + lock on relation previously obtained by + dbplus_xlockrel. + + +