From 8bd63a961a91ef3050853774ac81940386b2d0e6 Mon Sep 17 00:00:00 2001 From: Hartmut Holzgraefe Date: Sun, 26 Aug 2001 14:32:50 +0000 Subject: [PATCH] catching up with implementation 'unimplemented' section removed, functions are now all in alphabetical order plus possibly some whitspace ... git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@56003 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/dbplus.xml | 831 ++++++++++++++++++++++++------------------- 1 file changed, 461 insertions(+), 370 deletions(-) diff --git a/functions/dbplus.xml b/functions/dbplus.xml index 6eda3b5341..6dc8883955 100644 --- a/functions/dbplus.xml +++ b/functions/dbplus.xml @@ -1,12 +1,12 @@ - + DB++ functions - + &warn.experimental; - +
Experimental support for db++ database @@ -16,14 +16,14 @@ db++ and to read and process the output of a db++ query.
- +
Requirenments ??? Download where
- +
Installation @@ -49,11 +49,11 @@ db++ error codes - - PHP Constant - db++ constant - meaning - + + PHP Constant + db++ constant + meaning + @@ -257,7 +257,7 @@
- + dbplus_add @@ -290,7 +290,7 @@ - + dbplus_aql @@ -414,11 +414,15 @@ string dbplus_errcode - int err + int errno &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. @@ -436,7 +440,55 @@ + &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 + + + int dbplus_find + int handle + array constraints + mixed tuple + + + &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. @@ -469,7 +521,7 @@ chapter for more information on db++ error codes. - See also dbplus_current, + See also dbplus_curr, dbplus_prev, dbplus_next, and dbplus_last. @@ -519,16 +571,49 @@ &warn.experimental.func; - dbplus_freeaalllocks will free all locks + dbplus_freeaalllocks 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 + + + int dbplus_freelock + int handle + string tname + + + &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 locks on given relation + Free all tuple locks on given relation Description @@ -540,9 +625,73 @@ &warn.experimental.func; - dbplus_freerlocks will free all locks held + 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 + + + int dbplus_getlock + int handle + string tname + + + &warn.experimental.func; + + dbplus_getlock will request a write lock on + the speified 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 a id number unique to a relation + + + Description + + + int dbplus_getunique + int handle + int uniqueid + + + &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. + @@ -596,7 +745,7 @@ See also dbplus_first, - dbplus_current, + dbplus_curr, dbplus_prev, and dbplus_next. @@ -606,7 +755,7 @@ dbplus_lockrel - Request read-lock on relation + Request write lock on relation Description @@ -617,6 +766,11 @@ &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. + @@ -651,7 +805,7 @@ See also dbplus_first, - dbplus_current, + dbplus_curr, dbplus_prev, and dbplus_last. @@ -682,6 +836,8 @@ On success a relation file handle (cursor) is returned which must be used in any subsequent commanads referencing the relation. + Failure leads to a zero return value, the actual error code may + be asked for by calling dbplus_errno. @@ -715,13 +871,160 @@ See also dbplus_first, - dbplus_current, + dbplus_curr, dbplus_next, and dbplus_last. + + + dbplus_rchperm + Change relation permissions + + + Description + + + int dbplus_rchperm + int relation + int mask + string user + string group + + + &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 + + + + Description + + + int dbplus_rcreate + string name + string domlist + int flag + + + &warn.experimental.func; + + Not implemented yet. + + + + + + + dbplus_rcrtexact + + + + Description + + + int dbplus_rcrtexact + string name + int handle + int flag + + + &warn.experimental.func; + + Not implemented yet. + + + + + + + dbplus_rcrtlike + + + + Description + + + int dbplus_rcrtlike + string name + int handle + int flag + + + &warn.experimental.func; + + Not implemented yet. + + + + + + + dbplus_resolve + Resolve host information for relation + + + Description + + + int dbplus_resolve + string relation_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_rkeys + Specify new primary key for a relation + + + Description + + + int dbplus_rkeys + int relation + mixed domlist + + + &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 an array of + domain name strings or as a space separated list of names in a + single string. + + + + dbplus_restorepos ??? @@ -760,6 +1063,77 @@ + + + dbplus_rquery + + + + Description + + + int dbplus_rquery + + + + &warn.experimental.func; + + + + + + + + dbplus_rrename + Rename a relation + + + Description + + + int dbplus_rrename + int relation + string name + + + &warn.experimental.func; + + dbplus_rrename will change the name of + relation to name. + + + + + + + dbplus_rsecindex + Create a new secondary index for a relation + + + Description + + + int dbplus_rsecindex + int relation + mixed domlist + int type + + + &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 an array of + domain name strings or as a space separated list of names in a + single string. + + + + dbplus_runlink @@ -775,6 +1149,7 @@ &warn.experimental.func; + dbplus_unlink will close and remove the relation. @@ -790,11 +1165,12 @@ int dbplus_rzap int relation - int truncate &warn.experimental.func; + dbplus_rzap will remove all tuples from + relation. @@ -879,6 +1255,41 @@ + + + dbplus_tcl + Execute TCL code on server side + + + Description + + + int dbplus_tcl + int sid + string script + + + &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 @@ -890,7 +1301,7 @@ int dbplus_tremove int relation - array old + array tuple array current @@ -898,6 +1309,11 @@ &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. @@ -943,7 +1359,7 @@ dbplus_unlockrel - Give up read-lock on relation + Give up write lock on relation Description @@ -955,6 +1371,8 @@ &warn.experimental.func; + dbplus_unlockrel will release a write lock + previously obtained by dbplus_lockrel. @@ -962,7 +1380,7 @@ dbplus_unselect - ??? + Remove a constraint from relation Description @@ -974,6 +1392,9 @@ &warn.experimental.func; + Calling dbplus_unselect will remove a + constraint previously set by dbplus_find on + relation. @@ -995,6 +1416,11 @@ &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. @@ -1002,7 +1428,7 @@ dbplus_xlockrel - Request exclusive write lock on relation + Request exclusive lock on relation Description @@ -1014,6 +1440,12 @@ &warn.experimental.func; + dbplus_xlockrel will request an exclusive + lock on relation preventing even read + access from other clients. + + + See also dbplus_xunlockrel. @@ -1021,7 +1453,7 @@ dbplus_xunlockrel - Free exclusive write lock on relation + Free exclusive lock on relation Description @@ -1033,354 +1465,13 @@ &warn.experimental.func; + dbplus_xunlockrel will release an exclusive + lock on relation previously obtained by dbplus_xlockrel. - - - - - - dbplus_change - - - - Description - - - int dbplus_change - int handle - string domain - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_find - - - - Description - - - int dbplus_find - int handle - string constr - string tname - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_freelock - - - - Description - - - int dbplus_freelock - int handle - string tname - - - &warn.experimental.func; - - dbplus_freelock will release a write lock on - the given tuple previously obtained by - dbplus_getlock. - - - - - - - dbplus_getlock - - - - Description - - - int dbplus_getlock - int handle - string tname - - - &warn.experimental.func; - - dbplus_getlock will request a write lock on - the speified 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 - - - - Description - - - int dbplus_getunique - int handle - int uniqueid - - - &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_rchperm - - - - Description - - - int dbplus_rchperm - int handle - int mask - string user - string group - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rcreate - - - - Description - - - int dbplus_rcreate - string name - string domlist - int flag - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rcrtexact - - - - Description - - - int dbplus_rcrtexact - string name - int handle - int flag - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rcrtlike - - - - Description - - - int dbplus_rcrtlike - string name - int handle - int flag - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_resolve - - - - Description - - - int dbplus_resolve - string name - string vname - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rkeys - - - - Description - - - int dbplus_rkeys - int handle - string domlist - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rquery - - - - Description - - - int dbplus_rquery - - - - &warn.experimental.func; - - - - - - - - dbplus_rrename - - - - Description - - - int dbplus_rrename - int handle - string name - int flag - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_rsecindex - - - - Description - - - int dbplus_rsecindex - int handle - string domlist - int compact - - - &warn.experimental.func; - - Not implemented yet. - - - - - - - dbplus_tcl - - - - Description - - - int dbplus_tcl - int sid - string script - - - &warn.experimental.func; - - Not implemented yet. - - - -