1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<reference id="ref.dbplus">
<title>DB++ Functions</title>
<titleabbrev>DB++</titleabbrev>
<partintro>
&warn.experimental;
<section id="dbplus.intro">
<title>DB++ Database Functions</title>
<para>
db++, made by the german company <ulink
url="&url.dbplus.company;">Concept asa</ulink>, is a relational
database system with high performance and low memory and disk
usage in mind. While providing SQL as an additional language
interface it is not really a SQL database in the first place but
provides its own AQL query language which is much more influenced
by the relational algebra then SQL is.
</para>
<para>
Concept asa always had an interest in supporting open source
languages, db++ has had Perl and Tcl call interfaces for years
now and uses Tcl as its internal stored procedure language.
</para>
</section>
<section id="dbplus.requirenments">
<title>Requirements</title>
<para>
You need the developement libraries and header files included in
every db++ installaion archive. <ulink
url="&url.dbplus.company;">Concept asa</ulink> provides
additional <ulink
url="&url.dbplus.documentation;">documentation</ulink> and <ulink
url="&url.dbplus.download;">Demo versions</ulink> of db++ for
Linux, some other UNIX versions and Windows95/NT.
</para>
</section>
<section id="dbplus.installation">
<title>Installation</title>
<para>
Creation and installation of this extension requires the db++
client libraries and header files to be installed on your system.
You have to run <command>configure</command> with option
<option>--with-dbplus</option> to build this extension.
</para>
<para>
<command>configure</command> looks for the client libraries and
header files under the default pathes
<filename>/usr/dbplus</filename>,
<filename>/usr/local/dbplus</filename> and
<filename>/opt/dblus</filename>. If you have installed db++ in a
different place you have add the installation path to the
<command>configure</command> option like this:
<option>--with-dbplus=/your/installation/path</option>.
</para>
</section>
<section id="dbplus.errorcodes">
<title>db++ error codes</title>
<para>
<table>
<title>DB++ Error Codes</title>
<tgroup cols="3">
<thead>
<row>
<entry>PHP Constant</entry>
<entry>db++ constant</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry>DBPLUS_ERR_NOERR</entry>
<entry>ERR_NOERR</entry>
<entry>Null error condition</entry>
</row>
<row>
<entry>DBPLUS_ERR_DUPLICATE</entry>
<entry>ERR_DUPLICATE</entry>
<entry>Tried to insert a duplicate tuple</entry>
</row>
<row>
<entry>DBPLUS_ERR_EOSCAN</entry>
<entry>ERR_EOSCAN</entry>
<entry>End of scan from rget()</entry>
</row>
<row>
<entry>DBPLUS_ERR_EMPTY</entry>
<entry>ERR_EMPTY</entry>
<entry>Relation is empty (server)</entry>
</row>
<row>
<entry>DBPLUS_ERR_CLOSE</entry>
<entry>ERR_CLOSE</entry>
<entry>The server can't close</entry>
</row>
<row>
<entry>DBPLUS_ERR_WLOCKED</entry>
<entry>ERR_WLOCKED</entry>
<entry>The record is write locked</entry>
</row>
<row>
<entry>DBPLUS_ERR_LOCKED</entry>
<entry>ERR_LOCKED</entry>
<entry>Relation was already locked</entry>
</row>
<row>
<entry>DBPLUS_ERR_NOLOCK</entry>
<entry>ERR_NOLOCK</entry>
<entry>Relation cannot be locked</entry>
</row>
<row>
<entry>DBPLUS_ERR_READ</entry>
<entry>ERR_READ</entry>
<entry>Read error on relation</entry>
</row>
<row>
<entry>DBPLUS_ERR_WRITE</entry>
<entry>ERR_WRITE</entry>
<entry>Write error on relation</entry>
</row>
<row>
<entry>DBPLUS_ERR_CREATE</entry>
<entry>ERR_CREATE</entry>
<entry>Create() system call failed</entry>
</row>
<row>
<entry>DBPLUS_ERR_LSEEK</entry>
<entry>ERR_LSEEK</entry>
<entry>Lseek() system call failed</entry>
</row>
<row>
<entry>DBPLUS_ERR_LENGTH</entry>
<entry>ERR_LENGTH</entry>
<entry>Tuple exceeds maximum length</entry>
</row>
<row>
<entry>DBPLUS_ERR_OPEN</entry>
<entry>ERR_OPEN</entry>
<entry>Open() system call failed</entry>
</row>
<row>
<entry>DBPLUS_ERR_WOPEN</entry>
<entry>ERR_WOPEN</entry>
<entry>Relation already opened for writing</entry>
</row>
<row>
<entry>DBPLUS_ERR_MAGIC</entry>
<entry>ERR_MAGIC</entry>
<entry>File is not a relation</entry>
</row>
<row>
<entry>DBPLUS_ERR_VERSION</entry>
<entry>ERR_VERSION</entry>
<entry>File is a very old relation</entry>
</row>
<row>
<entry>DBPLUS_ERR_PGSIZE</entry>
<entry>ERR_PGSIZE</entry>
<entry>Relation uses a different page size</entry>
</row>
<row>
<entry>DBPLUS_ERR_CRC</entry>
<entry>ERR_CRC</entry>
<entry>Invalid crc in the superpage</entry>
</row>
<row>
<entry>DBPLUS_ERR_PIPE</entry>
<entry>ERR_PIPE</entry>
<entry>Piped relation requires lseek()</entry>
</row>
<row>
<entry>DBPLUS_ERR_NIDX</entry>
<entry>ERR_NIDX</entry>
<entry>Too many secondary indices</entry>
</row>
<row>
<entry>DBPLUS_ERR_MALLOC</entry>
<entry>ERR_MALLOC</entry>
<entry>Malloc() call failed</entry>
</row>
<row>
<entry>DBPLUS_ERR_NUSERS</entry>
<entry>ERR_NUSERS</entry>
<entry>Error use of max users</entry>
</row>
<row>
<entry>DBPLUS_ERR_PREEXIT</entry>
<entry>ERR_PREEXIT</entry>
<entry>Caused by invalid usage</entry>
</row>
<row>
<entry>DBPLUS_ERR_ONTRAP</entry>
<entry>ERR_ONTRAP</entry>
<entry>Caused by a signal</entry>
</row>
<row>
<entry>DBPLUS_ERR_PREPROC</entry>
<entry>ERR_PREPROC</entry>
<entry>Error in the preprocessor</entry>
</row>
<row>
<entry>DBPLUS_ERR_DBPARSE</entry>
<entry>ERR_DBPARSE</entry>
<entry>Error in the parser</entry>
</row>
<row>
<entry>DBPLUS_ERR_DBRUNERR</entry>
<entry>ERR_DBRUNERR</entry>
<entry>Run error in db</entry>
</row>
<row>
<entry>DBPLUS_ERR_DBPREEXIT</entry>
<entry>ERR_DBPREEXIT</entry>
<entry>Exit condition caused by prexit() * procedure</entry>
</row>
<row>
<entry>DBPLUS_ERR_WAIT</entry>
<entry>ERR_WAIT</entry>
<entry>Wait a little (Simple only)</entry>
</row>
<row>
<entry>DBPLUS_ERR_CORRUPT_TUPLE</entry>
<entry>ERR_CORRUPT_TUPLE</entry>
<entry>A client sent a corrupt tuple</entry>
</row>
<row>
<entry>DBPLUS_ERR_WARNING0</entry>
<entry>ERR_WARNING0</entry>
<entry>
The Simple routines encountered a non fatal error which was
corrected
</entry>
</row>
<row>
<entry>DBPLUS_ERR_PANIC</entry>
<entry>ERR_PANIC</entry>
<entry>
The server should not really die but after a disaster
send ERR_PANIC to all its clients
</entry>
</row>
<row>
<entry>DBPLUS_ERR_FIFO</entry>
<entry>ERR_FIFO</entry>
<entry>Can't create a fifo</entry>
</row>
<row>
<entry>DBPLUS_ERR_PERM</entry>
<entry>ERR_PERM</entry>
<entry>Permission denied</entry>
</row>
<row>
<entry>DBPLUS_ERR_TCL</entry>
<entry>ERR_TCL</entry>
<entry>TCL_error</entry>
</row>
<row>
<entry>DBPLUS_ERR_RESTRICTED</entry>
<entry>ERR_RESTRICTED</entry>
<entry>Only two users</entry>
</row>
<row>
<entry>DBPLUS_ERR_USER</entry>
<entry>ERR_USER</entry>
<entry>
An error in the use of the library by an application
programmer
</entry>
</row>
<row>
<entry>DBPLUS_ERR_UNKNOWN</entry>
<entry>ERR_UNKNOWN</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
</partintro>
<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 successfull 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-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 opriginal db++ manual.
</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>
<refentry id="function.dbplus-close">
<refnamediv>
<refname>dbplus_close</refname>
<refpurpose>Close a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</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>
</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>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-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><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-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-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:
'==', '>', '>=', '<', '<=', '!=', '~' 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-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>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-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-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_freeaalllocks</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-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-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-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 speified <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-getunique">
<refnamediv>
<refname>dbplus_getunique</refname>
<refpurpose>Get a 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-info">
<refnamediv>
<refname>dbplus_info</refname>
<refpurpose>???</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/></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
</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>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-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-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/></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-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 commanads 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-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>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_next</function>, and
<function>dbplus_last</function>.
</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>
<refentry id="function.dbplus-rcreate">
<refnamediv>
<refname>dbplus_rcreate</refname>
<refpurpose></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>boolean</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++ documentatiion, especially the dbcreate(1) manpage, for a
description of available type specifiers and their meanings.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-rcrtexact">
<refnamediv>
<refname>dbplus_rcrtexact</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rcrtexact</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>boolean</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>
</refsect1>
</refentry>
<refentry id="function.dbplus-rcrtlike">
<refnamediv>
<refname>dbplus_rcrtlike</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</type><methodname>dbplus_rcrtlike</methodname>
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam><type>resource</type><parameter>relation</parameter></methodparam>
<methodparam><type>int</type><parameter>flag</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>
</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>int</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-rkeys">
<refnamediv>
<refname>dbplus_rkeys</refname>
<refpurpose>Specify new primary key for a relation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</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>
</refsect1>
</refentry>
<refentry id="function.dbplus-restorepos">
<refnamediv>
<refname>dbplus_restorepos</refname> <refpurpose>???</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;
<para>
Not implemented yet.
</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> localy 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-rquery">
<refnamediv>
<refname>dbplus_rquery</refname>
<refpurpose>Perform local (raw) AQL query</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>dbplus_rquery</methodname>
<methodparam><type>string</type><parameter>query</parameter></methodparam>
<methodparam><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-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-rsecindex">
<refnamediv>
<refname>dbplus_rsecindex</refname>
<refpurpose>
Create a new secondary index for a relation
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>resource</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>
</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>
<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-savepos">
<refnamediv>
<refname>dbplus_savepos</refname>
<refpurpose>???</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;
<para>
Not implemented yet.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-setindex">
<refnamediv>
<refname>dbplus_setindex</refname>
<refpurpose>???</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;
<para>
Not implemented yet.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-setindexbynumber">
<refnamediv>
<refname>dbplus_setindexbynumber</refname>
<refpurpose>???</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;
<para>
Not implemented yet.
</para>
</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><type>string</type><parameter>server</parameter></methodparam>
<methodparam><type>string</type><parameter>dbpath</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Not implemented yet.
</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>int</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-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>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-undo">
<refnamediv>
<refname>dbplus_undo</refname>
<refpurpose>???</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;
<para>
Not implemented yet.
</para>
</refsect1>
</refentry>
<refentry id="function.dbplus-undoprepare">
<refnamediv>
<refname>dbplus_undoprepare</refname>
<refpurpose>???</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;
<para>
Not implemented yet.
</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>
<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-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-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-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>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|