diff --git a/functions/dbplus.xml b/functions/dbplus.xml new file mode 100644 index 0000000000..cc7d80fe16 --- /dev/null +++ b/functions/dbplus.xml @@ -0,0 +1,987 @@ + + DB++ functions + + + + +
+ Experimental support for db++ database + + This paper describes the the db++ extension which enables + PHP to access db++ relation files through all of the + search and update methods available in the client/server "C" + library interface of db++ and to read and process the output of a + db++ query. + +
+ +
+ Requirenments + + ??? Download where + +
+ +
+ Installation + + Creation and installation of this extension requires the db++ + client libraries and header files to be installed on your system + as described above. You have to run configure + with option to build this extension. + + + configure looks for the client libraries and + header files under the default + path/usr/dbplus/. + If you have installed db++ in a different place you have add the + installation path to the configure option like + this: . + +
+ + + + + + dbplus_add + Add a tuple to a relation + + + Description + + + int dbplus_add + int relation + array tuple + + + + + + + + + + dbplus_aql + Perform AQL query + + + Description + + + int dbplus_aql + string query + string + server + + string + dbpath + + + + + + + + + + + dbplus_chdir + Get/Set database virtual current directory + + + Description + + + string dbplus_chdir + string + newdir + + + + + + + + + + + dbplus_close + Close a relation + + + Description + + + int dbplus_close + int relation + + + + + + + + + + dbplus_curr + Get current tuple from relation + + + Description + + + int dbplus_curr + int relation + array tuple + + + + + + + + + + dbplus_errcode + Get error string for given errorcode or last error + + + Description + + + string dbplus_errcode + int err + + + + + + + + + + dbplus_first + Get first tuple from relation + + + Description + + + int dbplus_first + int relation + array tuple + + + + + + + + + + dbplus_flush + ??? + + + Description + + + int dbplus_flush + int relation + + + + + + + + + + dbplus_freealllocks + Free all locks held by this client + + + Description + + + int dbplus_freealllocks + void + + + + + + + + + + dbplus_freerlocks + Free all locks on given relation + + + Description + + + int dbplus_freerlocks + int relation + + + + + + + + + + dbplus_info + ??? + + + Description + + + int dbplus_info + int relation + string key + array + + + + + + + + + + dbplus_last + Get last tuple from relation + + + Description + + + int dbplus_last + int relation + array tuple + + + + + + + + + + dbplus_lockrel + Request read-lock on relation + + + Description + + + int dbplus_lockrel + int relation + + + + + + + + + + dbplus_next + Get next tuple from relation + + + Description + + + int dbplus_next + int relation + array + + + + + + + + + + dbplus_open + Open relation file + + + Description + + + int dbplus_open + string name + + + + 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 handle (cursor) is returned which must be used in any subsequent + commanads referencing the relation. + + + + + + + dbplus_prev + Get previous tuple from relation + + + Description + + + int dbplus_prev + int relation + array tuple + + + + + + + + + + dbplus_restorepos + ??? + + + Description + + + int dbplus_restorepos + int relation + array tuple + + + + + + + + + + dbplus_ropen + Open relation file ... ??? + + + Description + + + int dbplus_ropen + string name + + + + + + + + + + dbplus_runlink + Remove relation from filesystem + + + Description + + + int dbplus_runlink + int relation + + + + + + + + + + dbplus_rzap + Remove all tuples from relation + + + Description + + + int dbplus_rzap + int relation + int truncate + + + + + + + + + + dbplus_savepos + ??? + + + Description + + + int dbplus_savepos + int relation + + + + + + + + + + dbplus_setindex + ??? + + + Description + + + int dbplus_setindex + int relation + string idx_name + + + + + + + + + + dbplus_setindexbynumber + ??? + + + Description + + + int dbplus_setindexbynumber + int relation + int idx_number + + + + + + + + + + dbplus_sql + Perform SQL query + + + Description + + + int dbplus_sql + string query + string server + string dbpath + + + + + + + + + + dbplus_tremove + Remove tuple and return new current tuple + + + Description + + + int dbplus_tremove + int relation + array old + array + current + + + + + + + + + + + dbplus_undo + ??? + + + Description + + + int dbplus_undo + int relation + + + + + + + + + + dbplus_undoprepare + ??? + + + Description + + + int dbplus_undoprepare + int relation + + + + + + + + + + dbplus_unlockrel + Give up read-lock on relation + + + Description + + + int dbplus_unlockrel + int relation + + + + + + + + + + dbplus_unselect + ??? + + + Description + + + int dbplus_unselect + int relation + + + + + + + + + + dbplus_update + Update specified tuple in relation + + + Description + + + int dbplus_update + int relation + array old + array new + + + + + + + + + + dbplus_xlockrel + Request exclusive write lock on relation + + + Description + + + int dbplus_xlockrel + int relation + + + + + + + + + + dbplus_xunlockrel + Free exclusive write lock on relation + + + Description + + + int dbplus_xunlockrel + int relation + + + + + + + + + + + + + + dbplus_change + + + + Description + + + int dbplus_change + int handle + string domain + + + + Not implemented yet. + + + + + + + dbplus_find + + + + Description + + + int dbplus_find + int handle + string constr + string tname + + + + Not implemented yet. + + + + + + + dbplus_freelock + + + + Description + + + int dbplus_freelock + int handle + string tname + + + + Not implemented yet. + + + + + + + dbplus_getlock + + + + Description + + + int dbplus_getlock + int handle + string tname + + + + Not implemented yet. + + + + + + + dbplus_getunique + + + + Description + + + int dbplus_getunique + int handle + string varname + int flush + + + + Not implemented yet. + + + + + + + dbplus_rchperm + + + + Description + + + int dbplus_rchperm + int handle + int mask + string user + string group + + + + Not implemented yet. + + + + + + + dbplus_rcreate + + + + Description + + + int dbplus_rcreate + string name + string domlist + int flag + + + + Not implemented yet. + + + + + + + dbplus_rcrtexact + + + + Description + + + int dbplus_rcrtexact + string name + int handle + int flag + + + + Not implemented yet. + + + + + + + dbplus_rcrtlike + + + + Description + + + int dbplus_rcrtlike + string name + int handle + int flag + + + + Not implemented yet. + + + + + + + dbplus_resolve + + + + Description + + + int dbplus_resolve + string name + string vname + + + + Not implemented yet. + + + + + + + dbplus_rkeys + + + + Description + + + int dbplus_rkeys + int handle + string domlist + + + + Not implemented yet. + + + + + + + dbplus_rquery + + + + Description + + + int dbplus_rquery + + + + + + + + + + + dbplus_rrename + + + + Description + + + int dbplus_rrename + int handle + string name + int flag + + + + Not implemented yet. + + + + + + + dbplus_rsecindex + + + + Description + + + int dbplus_rsecindex + int handle + string domlist + int compact + + + + Not implemented yet. + + + + + + + dbplus_tcl + + + + Description + + + int dbplus_tcl + int sid + string script + + + + Not implemented yet. + + + + + + + +