/usr/share/doc/python-bsddb3/html/dbenv.html is in python-bsddb3-doc 6.0.1-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>DBEnv — PyBSDDB 6.0.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.0.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: false
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="PyBSDDB 6.0.0 documentation" href="index.html" />
<link rel="next" title="DB" href="db.html" />
<link rel="prev" title="Berkeley DB 4.3 thru 6.0 Python Extension Package" href="introduction.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="db.html" title="DB"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="introduction.html" title="Berkeley DB 4.3 thru 6.0 Python Extension Package"
accesskey="P">previous</a> |</li>
<li><a href="contents.html">PyBSDDB 6.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="dbenv">
<h1>DBEnv<a class="headerlink" href="#dbenv" title="Permalink to this headline">¶</a></h1>
<p>Read <a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/programmer_reference/index.html">Oracle documentation</a>
for better understanding.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/env.html">More info...</a></p>
<div class="section" id="dbenv-attributes">
<h2>DBEnv Attributes<a class="headerlink" href="#dbenv-attributes" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="DBEnv">
<tt class="descname">DBEnv</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#DBEnv" title="Permalink to this definition">¶</a></dt>
<dd><p>database home directory (read-only)</p>
</dd></dl>
</div>
<div class="section" id="dbenv-methods">
<h2>DBEnv Methods<a class="headerlink" href="#dbenv-methods" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt>
<tt class="descname">DBEnv</tt><big>(</big><em>flags=0</em><big>)</big></dt>
<dd><p>Constructor.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envcreate.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_rpc_server">
<tt class="descname">set_rpc_server</tt><big>(</big><em>host</em>, <em>cl_timeout=0</em>, <em>sv_timeout=0</em><big>)</big><a class="headerlink" href="#set_rpc_server" title="Permalink to this definition">¶</a></dt>
<dd><p>Establishes a connection for this dbenv to a RPC server.
This function is not available if linked to Berkeley DB 4.8 or up.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_rpc_server.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="close">
<tt class="descname">close</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#close" title="Permalink to this definition">¶</a></dt>
<dd><p>Close the database environment, freeing resources.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envclose.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="open">
<tt class="descname">open</tt><big>(</big><em>homedir</em>, <em>flags=0</em>, <em>mode=0660</em><big>)</big><a class="headerlink" href="#open" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare the database environment for use.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envopen.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_cursor">
<tt class="descname">log_cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#log_cursor" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a created log cursor.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logcursor.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="memp_stat">
<tt class="descname">memp_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#memp_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the memory pool (that is, the buffer cache) subsystem
statistics.</p>
<p>The returning value is a tuple. The first element is a dictionary
with the general stats. The second element is another dictionary,
keyed by filename, and the values are the stats for each file.</p>
<p>The first dictionary contains these data:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>gbytes</td>
<td>Gigabytes of cache (total cache size is
st_gbytes + st_bytes).</td>
</tr>
<tr class="row-even"><td>bytes</td>
<td>Bytes of cache (total cache size is
st_gbytes + st_bytes).</td>
</tr>
<tr class="row-odd"><td>ncache</td>
<td>Number of caches.</td>
</tr>
<tr class="row-even"><td>max_ncache</td>
<td>Maximum number of caches, as configured
with the DB_ENV->set_cache_max() method.</td>
</tr>
<tr class="row-odd"><td>regsize</td>
<td>Individual cache size, in bytes.</td>
</tr>
<tr class="row-even"><td>mmapsize</td>
<td>Maximum memory-mapped file size.</td>
</tr>
<tr class="row-odd"><td>maxopenfd</td>
<td>Maximum open file descriptors.</td>
</tr>
<tr class="row-even"><td>maxwrite</td>
<td>Maximum sequential buffer writes.</td>
</tr>
<tr class="row-odd"><td>maxwrite_sleep</td>
<td>Microseconds to pause after writing maximum
sequential buffers.</td>
</tr>
<tr class="row-even"><td>map</td>
<td>Requested pages mapped into the process’
address space (there is no available
information about whether or not this
request caused disk I/O, although examining
the application page fault rate may be
helpful).</td>
</tr>
<tr class="row-odd"><td>cache_hit</td>
<td>Requested pages found in the cache.</td>
</tr>
<tr class="row-even"><td>cache_miss</td>
<td>Requested pages not found in the cache.</td>
</tr>
<tr class="row-odd"><td>page_create</td>
<td>Pages created in the cache.</td>
</tr>
<tr class="row-even"><td>page_in</td>
<td>Pages read into the cache.</td>
</tr>
<tr class="row-odd"><td>page_out</td>
<td>Pages written from the cache to the backing
file.</td>
</tr>
<tr class="row-even"><td>ro_evict</td>
<td>Clean pages forced from the cache.</td>
</tr>
<tr class="row-odd"><td>rw_evict</td>
<td>Dirty pages forced from the cache.</td>
</tr>
<tr class="row-even"><td>page_trickle</td>
<td>Dirty pages written using the
DB_ENV->memp_trickle() method.</td>
</tr>
<tr class="row-odd"><td>pages</td>
<td>Pages in the cache.</td>
</tr>
<tr class="row-even"><td>page_clean</td>
<td>Clean pages currently in the cache.</td>
</tr>
<tr class="row-odd"><td>page_dirty</td>
<td>Dirty pages currently in the cache.</td>
</tr>
<tr class="row-even"><td>hash_buckets</td>
<td>Number of hash buckets in buffer hash
table.</td>
</tr>
<tr class="row-odd"><td>hash_searches</td>
<td>Total number of buffer hash table lookups.</td>
</tr>
<tr class="row-even"><td>hash_longest</td>
<td>Longest chain ever encountered in buffer
hash table lookups.</td>
</tr>
<tr class="row-odd"><td>hash_examined</td>
<td>Total number of hash elements traversed
during hash table lookups.</td>
</tr>
<tr class="row-even"><td>hash_nowait</td>
<td>Number of times that a thread of control
was able to obtain a hash bucket lock
without waiting.</td>
</tr>
<tr class="row-odd"><td>hash_wait</td>
<td>Number of times that a thread of control
was forced to wait before obtaining a hash
bucket lock.</td>
</tr>
<tr class="row-even"><td>hash_max_nowait</td>
<td>The number of times a thread of control was
able to obtain the hash bucket lock without
waiting on the bucket which had the maximum
number of times that a thread of control
needed to wait.</td>
</tr>
<tr class="row-odd"><td>hash_max_wait</td>
<td>Maximum number of times any hash bucket
lock was waited for by a thread of control.</td>
</tr>
<tr class="row-even"><td>region_wait</td>
<td>Number of times that a thread of control
was forced to wait before obtaining a cache
region mutex.</td>
</tr>
<tr class="row-odd"><td>region_nowait</td>
<td>Number of times that a thread of control
was able to obtain a cache region mutex
without waiting.</td>
</tr>
<tr class="row-even"><td>mvcc_frozen</td>
<td>Number of buffers frozen.</td>
</tr>
<tr class="row-odd"><td>mvcc_thawed</td>
<td>Number of buffers thawed.</td>
</tr>
<tr class="row-even"><td>mvcc_freed</td>
<td>Number of frozen buffers freed.</td>
</tr>
<tr class="row-odd"><td>alloc</td>
<td>Number of page allocations.</td>
</tr>
<tr class="row-even"><td>alloc_buckets</td>
<td>Number of hash buckets checked during
allocation.</td>
</tr>
<tr class="row-odd"><td>alloc_max_buckets</td>
<td>Maximum number of hash buckets checked
during an allocation.</td>
</tr>
<tr class="row-even"><td>alloc_pages</td>
<td>Number of pages checked during allocation.</td>
</tr>
<tr class="row-odd"><td>alloc_max_pages</td>
<td>Maximum number of pages checked during an
allocation.</td>
</tr>
<tr class="row-even"><td>io_wait</td>
<td>Number of operations blocked waiting for
I/O to complete.</td>
</tr>
<tr class="row-odd"><td>sync_interrupted</td>
<td>Number of mpool sync operations
interrupted.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>The second dictionary contains these data:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>pagesize</td>
<td>Page size in bytes.</td>
</tr>
<tr class="row-even"><td>cache_hit</td>
<td>Requested pages found in the cache.</td>
</tr>
<tr class="row-odd"><td>cache_miss</td>
<td>Requested pages not found in the cache.</td>
</tr>
<tr class="row-even"><td>map</td>
<td>Requested pages mapped into the process’
address space.</td>
</tr>
<tr class="row-odd"><td>page_create</td>
<td>Pages created in the cache.</td>
</tr>
<tr class="row-even"><td>page_in</td>
<td>Pages read into the cache.</td>
</tr>
<tr class="row-odd"><td>page_out</td>
<td>Pages written from the cache to the backing
file.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="memp_stat_print">
<tt class="descname">memp_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#memp_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays cache subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempstat_print.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="memp_sync">
<tt class="descname">memp_sync</tt><big>(</big><em>lsn=None</em><big>)</big><a class="headerlink" href="#memp_sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Flushes modified pages in the cache to their backing files. If
provided, lsn is a tuple: (file, offset).
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempsync.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="memp_trickle">
<tt class="descname">memp_trickle</tt><big>(</big><em>percent</em><big>)</big><a class="headerlink" href="#memp_trickle" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensures that a specified percent of the pages in the cache are clean,
by writing dirty pages to their backing files.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/memptrickle.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="remove">
<tt class="descname">remove</tt><big>(</big><em>homedir</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#remove" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove a database environment.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envremove.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="dbremove">
<tt class="descname">dbremove</tt><big>(</big><em>file</em>, <em>database=None</em>, <em>txn=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#dbremove" title="Permalink to this definition">¶</a></dt>
<dd><p>Removes the database specified by the file and database parameters.
If no database is specified, the underlying file represented by file
is removed, incidentally removing all of the databases it contained.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envdbremove.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="dbrename">
<tt class="descname">dbrename</tt><big>(</big><em>file</em>, <em>database=None</em>, <em>newname</em>, <em>txn=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#dbrename" title="Permalink to this definition">¶</a></dt>
<dd><p>Renames the database specified by the file and database parameters to
newname. If no database is specified, the underlying file represented
by file is renamed, incidentally renaming all of the databases it
contained.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envdbrename.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="fileid_reset">
<tt class="descname">fileid_reset</tt><big>(</big><em>file</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#fileid_reset" title="Permalink to this definition">¶</a></dt>
<dd><p>All databases contain an ID string used to identify the database in
the database environment cache. If a physical database file is
copied, and used in the same environment as another file with the
same ID strings, corruption can occur. The DB_ENV->fileid_reset
method creates new ID strings for all of the databases in the
physical file.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envfileid_reset.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_thread_count">
<tt class="descname">get_thread_count</tt><big>(</big><big>)</big><a class="headerlink" href="#get_thread_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the thread count as set by the DB_ENV->set_thread_count()
method.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_thread_count.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_thread_count">
<tt class="descname">set_thread_count</tt><big>(</big><em>count</em><big>)</big><a class="headerlink" href="#set_thread_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Declare an approximate number of threads in the database environment.
The DB_ENV->set_thread_count() method must be called prior to opening
the database environment if the DB_ENV->failchk() method will be
used. The DB_ENV->set_thread_count() method does not set the maximum
number of threads but is used to determine memory sizing and the
thread control block reclamation policy.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_thread_count.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_encrypt">
<tt class="descname">set_encrypt</tt><big>(</big><em>passwd</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#set_encrypt" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the password used by the Berkeley DB library to perform
encryption and decryption.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_encrypt.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_encrypt_flags">
<tt class="descname">get_encrypt_flags</tt><big>(</big><big>)</big><a class="headerlink" href="#get_encrypt_flags" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the encryption flags.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_encrypt_flags.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_intermediate_dir_mode">
<tt class="descname">get_intermediate_dir_mode</tt><big>(</big><big>)</big><a class="headerlink" href="#get_intermediate_dir_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the intermediate directory permissions.</p>
<p>Intermediate directories are directories needed for recovery.
Normally, Berkeley DB does not create these directories and will do
so only if the DB_ENV->set_intermediate_dir_mode() method is called.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_intermediate_dir_mode.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_intermediate_dir_mode">
<tt class="descname">set_intermediate_dir_mode</tt><big>(</big><em>mode</em><big>)</big><a class="headerlink" href="#set_intermediate_dir_mode" title="Permalink to this definition">¶</a></dt>
<dd><p>By default, Berkeley DB does not create intermediate directories
needed for recovery, that is, if the file /a/b/c/mydatabase is being
recovered, and the directory path b/c does not exist, recovery will
fail. This default behavior is because Berkeley DB does not know what
permissions are appropriate for intermediate directory creation, and
creating the directory might result in a security problem.</p>
<p>The DB_ENV->set_intermediate_dir_mode() method causes Berkeley DB to
create any intermediate directories needed during recovery, using the
specified permissions.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_intermediate_dir_mode.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_timeout">
<tt class="descname">get_timeout</tt><big>(</big><em>flags</em><big>)</big><a class="headerlink" href="#get_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a timeout value, in microseconds.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_timeout.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_timeout">
<tt class="descname">set_timeout</tt><big>(</big><em>timeout</em>, <em>flags</em><big>)</big><a class="headerlink" href="#set_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets timeout values for locks or transactions in the database
environment.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_timeout.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_mp_max_openfd">
<tt class="descname">get_mp_max_openfd</tt><big>(</big><big>)</big><a class="headerlink" href="#get_mp_max_openfd" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum number of file descriptors the library will open
concurrently when flushing dirty pages from the cache.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempget_mp_max_openfd.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_mp_max_openfd">
<tt class="descname">set_mp_max_openfd</tt><big>(</big><em>max_open_fd</em><big>)</big><a class="headerlink" href="#set_mp_max_openfd" title="Permalink to this definition">¶</a></dt>
<dd><p>Limits the number of file descriptors the library will open
concurrently when flushing dirty pages from the cache.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempset_mp_max_openfd.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_mp_max_write">
<tt class="descname">get_mp_max_write</tt><big>(</big><big>)</big><a class="headerlink" href="#get_mp_max_write" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a tuple with the current maximum number of sequential write
operations and microseconds to pause that the library can schedule
when flushing dirty pages from the cache.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempget_mp_max_write.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_mp_max_write">
<tt class="descname">set_mp_max_write</tt><big>(</big><em>maxwrite</em>, <em>maxwrite_sleep</em><big>)</big><a class="headerlink" href="#set_mp_max_write" title="Permalink to this definition">¶</a></dt>
<dd><p>Limits the number of sequential write operations scheduled by the
library when flushing dirty pages from the cache.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mempset_mp_max_write.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_shm_key">
<tt class="descname">set_shm_key</tt><big>(</big><em>key</em><big>)</big><a class="headerlink" href="#set_shm_key" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify a base segment ID for Berkeley DB environment shared memory
regions created in system memory on VxWorks or systems supporting
X/Open-style shared memory interfaces; for example, UNIX systems
supporting shmget(2) and related System V IPC interfaces.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_shm_key.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_shm_key">
<tt class="descname">get_shm_key</tt><big>(</big><big>)</big><a class="headerlink" href="#get_shm_key" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the base segment ID.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_shm_key.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_cache_max">
<tt class="descname">set_cache_max</tt><big>(</big><em>gbytes</em>, <em>bytes</em><big>)</big><a class="headerlink" href="#set_cache_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the maximum cache size, in bytes. The specified size is rounded
to the nearest multiple of the cache region size, which is the
initial cache size divided by the number of regions specified to the
DB_ENV->set_cachesize() method. If no value is specified, it defaults
to the initial cache size.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_cache_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_cache_max">
<tt class="descname">get_cache_max</tt><big>(</big><big>)</big><a class="headerlink" href="#get_cache_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum size of the cache as set using the
DB_ENV->set_cache_max() method.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_cache_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_cachesize">
<tt class="descname">set_cachesize</tt><big>(</big><em>gbytes</em>, <em>bytes</em>, <em>ncache=0</em><big>)</big><a class="headerlink" href="#set_cachesize" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the size of the shared memory buffer pool.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_cachesize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_cachesize">
<tt class="descname">get_cachesize</tt><big>(</big><big>)</big><a class="headerlink" href="#get_cachesize" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a tuple with the current size and composition of the cache.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_cachesize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_data_dir">
<tt class="descname">set_data_dir</tt><big>(</big><em>dir</em><big>)</big><a class="headerlink" href="#set_data_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the environment data directory. You can call this function
multiple times, adding new directories.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_data_dir.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_data_dirs">
<tt class="descname">get_data_dirs</tt><big>(</big><big>)</big><a class="headerlink" href="#get_data_dirs" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple with the directories.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_data_dirs.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_flags">
<tt class="descname">get_flags</tt><big>(</big><big>)</big><a class="headerlink" href="#get_flags" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the configuration flags set for a DB_ENV handle.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_flags.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_flags">
<tt class="descname">set_flags</tt><big>(</big><em>flags</em>, <em>onoff</em><big>)</big><a class="headerlink" href="#set_flags" title="Permalink to this definition">¶</a></dt>
<dd><p>Set additional flags for the DBEnv. The onoff parameter specifes if
the flag is set or cleared.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_flags.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_tmp_dir">
<tt class="descname">set_tmp_dir</tt><big>(</big><em>dir</em><big>)</big><a class="headerlink" href="#set_tmp_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the directory to be used for temporary files.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_tmp_dir.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_tmp_dir">
<tt class="descname">get_tmp_dir</tt><big>(</big><big>)</big><a class="headerlink" href="#get_tmp_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the database environment temporary file directory.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_tmp_dir.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_get_returns_none">
<tt class="descname">set_get_returns_none</tt><big>(</big><em>flag</em><big>)</big><a class="headerlink" href="#set_get_returns_none" title="Permalink to this definition">¶</a></dt>
<dd><p>By default when DB.get or DBCursor.get, get_both, first, last, next
or prev encounter a DB_NOTFOUND error they return None instead of
raising DBNotFoundError. This behaviour emulates Python dictionaries
and is convenient for looping.</p>
<p>You can use this method to toggle that behaviour for all of the
aformentioned methods or extend it to also apply to the DBCursor.set,
set_both, set_range, and set_recno methods. Supported values of
flag:</p>
<ul class="simple">
<li><strong>0</strong> all DB and DBCursor get and set methods will raise a
DBNotFoundError rather than returning None.</li>
<li><strong>1</strong> <em>Default in module version <4.2.4</em> The DB.get and
DBCursor.get, get_both, first, last, next and prev methods return
None.</li>
<li><strong>2</strong> <em>Default in module version >=4.2.4</em> Extends the behaviour of
<strong>1</strong> to the DBCursor set, set_both, set_range and set_recno
methods.</li>
</ul>
<p>The default of returning None makes it easy to do things like this
without having to catch DBNotFoundError (KeyError):</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">data</span> <span class="o">=</span> <span class="n">mydb</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
<span class="k">if</span> <span class="n">data</span><span class="p">:</span>
<span class="n">doSomething</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
</pre></div>
</div>
<p>or this:</p>
<div class="highlight-python"><pre>rec = cursor.first()
while rec:
print rec
rec = cursor.next()</pre>
</div>
<p>Making the cursor set methods return None is useful in order to do
this:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">rec</span> <span class="o">=</span> <span class="n">mydb</span><span class="o">.</span><span class="n">set</span><span class="p">()</span>
<span class="k">while</span> <span class="n">rec</span><span class="p">:</span>
<span class="n">key</span><span class="p">,</span> <span class="n">val</span> <span class="o">=</span> <span class="n">rec</span>
<span class="n">doSomething</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
<span class="n">rec</span> <span class="o">=</span> <span class="n">mydb</span><span class="o">.</span><span class="n">next</span><span class="p">()</span>
</pre></div>
</div>
<p>The downside to this it that it is inconsistent with the rest of the
package and noticeably diverges from the Oracle Berkeley DB API. If
you prefer to have the get and set methods raise an exception when a
key is not found, use this method to tell them to do so.</p>
<p>Calling this method on a DBEnv object will set the default for all
DB’s later created within that environment. Calling it on a DB
object sets the behaviour for that DB only.</p>
<p>The previous setting is returned.</p>
</dd></dl>
<dl class="function">
<dt id="set_private">
<tt class="descname">set_private</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#set_private" title="Permalink to this definition">¶</a></dt>
<dd><p>Link an object to the DBEnv object. This allows to pass around an
arbitrary object. For instance, for callback context.</p>
</dd></dl>
<dl class="function">
<dt id="get_private">
<tt class="descname">get_private</tt><big>(</big><big>)</big><a class="headerlink" href="#get_private" title="Permalink to this definition">¶</a></dt>
<dd><p>Give the object linked to the DBEnv.</p>
</dd></dl>
<dl class="function">
<dt id="get_open_flags">
<tt class="descname">get_open_flags</tt><big>(</big><big>)</big><a class="headerlink" href="#get_open_flags" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the current open method flags. That is, this method returns
the flags that were specified when DB_ENV->open() was called.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_open_flags.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lg_filemode">
<tt class="descname">get_lg_filemode</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lg_filemode" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the log file mode.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lg_filemode.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lg_filemode">
<tt class="descname">set_lg_filemode</tt><big>(</big><em>filemode</em><big>)</big><a class="headerlink" href="#set_lg_filemode" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the absolute file mode for created log files.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_filemode.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lg_bsize">
<tt class="descname">get_lg_bsize</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lg_bsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the size of the log buffer, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lg_bsize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lg_bsize">
<tt class="descname">set_lg_bsize</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#set_lg_bsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the size of the in-memory log buffer, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_bsize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lg_dir">
<tt class="descname">get_lg_dir</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lg_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the log directory, which is the location for logging files.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lg_dir.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lg_dir">
<tt class="descname">set_lg_dir</tt><big>(</big><em>dir</em><big>)</big><a class="headerlink" href="#set_lg_dir" title="Permalink to this definition">¶</a></dt>
<dd><p>The path of a directory to be used as the location of logging files.
Log files created by the Log Manager subsystem will be created in
this directory.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_dir.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lg_max">
<tt class="descname">set_lg_max</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#set_lg_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum size of a single file in the log, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lg_max">
<tt class="descname">get_lg_max</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#get_lg_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum log file size.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lg_regionmax">
<tt class="descname">get_lg_regionmax</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lg_regionmax" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the size of the underlying logging subsystem region.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lg_regionmax.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lg_regionmax">
<tt class="descname">set_lg_regionmax</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#set_lg_regionmax" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum size of a single region in the log, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lg_regionmax.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lk_partitions">
<tt class="descname">get_lk_partitions</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lk_partitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of lock table partitions used in the Berkeley DB
environment.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lk_partitions.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_partitions">
<tt class="descname">set_lk_partitions</tt><big>(</big><em>partitions</em><big>)</big><a class="headerlink" href="#set_lk_partitions" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the number of lock table partitions in the Berkeley DB
environment.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_partitions.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lk_detect">
<tt class="descname">get_lk_detect</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lk_detect" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the deadlock detector configuration.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lk_detect.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_detect">
<tt class="descname">set_lk_detect</tt><big>(</big><em>mode</em><big>)</big><a class="headerlink" href="#set_lk_detect" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the automatic deadlock detection mode.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_detect.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_max">
<tt class="descname">set_lk_max</tt><big>(</big><em>max</em><big>)</big><a class="headerlink" href="#set_lk_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of locks. (This method is deprecated.)
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lk_max_locks">
<tt class="descname">get_lk_max_locks</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lk_max_locks" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum number of potential locks.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lk_max_locks.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_max_locks">
<tt class="descname">set_lk_max_locks</tt><big>(</big><em>max</em><big>)</big><a class="headerlink" href="#set_lk_max_locks" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of locks supported by the Berkeley DB lock
subsystem.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_max_locks.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lk_max_lockers">
<tt class="descname">get_lk_max_lockers</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lk_max_lockers" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum number of potential lockers.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lk_max_lockers.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_max_lockers">
<tt class="descname">set_lk_max_lockers</tt><big>(</big><em>max</em><big>)</big><a class="headerlink" href="#set_lk_max_lockers" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of simultaneous locking entities supported by
the Berkeley DB lock subsystem.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_max_lockers.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_lk_max_objects">
<tt class="descname">get_lk_max_objects</tt><big>(</big><big>)</big><a class="headerlink" href="#get_lk_max_objects" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the maximum number of locked objects.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_lk_max_objects.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_lk_max_objects">
<tt class="descname">set_lk_max_objects</tt><big>(</big><em>max</em><big>)</big><a class="headerlink" href="#set_lk_max_objects" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of simultaneously locked objects supported by
the Berkeley DB lock subsystem.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_lk_max_lockers.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_mp_mmapsize">
<tt class="descname">get_mp_mmapsize</tt><big>(</big><big>)</big><a class="headerlink" href="#get_mp_mmapsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the the maximum file size, in bytes, for a file to be mapped
into the process address space.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_mp_mmapsize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_mp_mmapsize">
<tt class="descname">set_mp_mmapsize</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#set_mp_mmapsize" title="Permalink to this definition">¶</a></dt>
<dd><p>Files that are opened read-only in the memory pool (and that satisfy
a few other criteria) are, by default, mapped into the process
address space instead of being copied into the local cache. This can
result in better-than-usual performance, as available virtual memory
is normally much larger than the local cache, and page faults are
faster than page copying on many systems. However, in the presence
of limited virtual memory it can cause resource starvation, and in
the presence of large databases, it can result in immense process
sizes.</p>
<p>This method sets the maximum file size, in bytes, for a file to be
mapped into the process address space. If no value is specified, it
defaults to 10MB.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_mp_mmapsize.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="stat_print">
<tt class="descname">stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the default subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_file">
<tt class="descname">log_file</tt><big>(</big><em>lsn</em><big>)</big><a class="headerlink" href="#log_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Maps lsn to filenames, returning the name of the file
containing the named record.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logfile.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_printf">
<tt class="descname">log_printf</tt><big>(</big><em>string</em>, <em>txn=None</em><big>)</big><a class="headerlink" href="#log_printf" title="Permalink to this definition">¶</a></dt>
<dd><p>Appends an informational message to the Berkeley DB database
environment log files.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logprintf.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_archive">
<tt class="descname">log_archive</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#log_archive" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of log or database file names. By default,
log_archive returns the names of all of the log files that are no
longer in use (e.g., no longer involved in active transactions), and
that may safely be archived for catastrophic recovery and then
removed from the system.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logarchive.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_flush">
<tt class="descname">log_flush</tt><big>(</big><big>)</big><a class="headerlink" href="#log_flush" title="Permalink to this definition">¶</a></dt>
<dd><p>Force log records to disk. Useful if the environment, database or
transactions are used as ACI, instead of ACID. For example, if the
environment is opened as DB_TXN_NOSYNC.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logflush.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_get_config">
<tt class="descname">log_get_config</tt><big>(</big><em>which</em><big>)</big><a class="headerlink" href="#log_get_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether the specified which parameter is currently set or
not. You can manage this value using the DB_ENV->log_set_config()
method.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envlog_get_config.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_set_config">
<tt class="descname">log_set_config</tt><big>(</big><em>flags</em>, <em>onoff</em><big>)</big><a class="headerlink" href="#log_set_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Configures the Berkeley DB logging subsystem.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envlog_set_config.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_detect">
<tt class="descname">lock_detect</tt><big>(</big><em>atype</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#lock_detect" title="Permalink to this definition">¶</a></dt>
<dd><p>Run one iteration of the deadlock detector, returns the number of
transactions aborted.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockdetect.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_get">
<tt class="descname">lock_get</tt><big>(</big><em>locker</em>, <em>obj</em>, <em>lock_mode</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#lock_get" title="Permalink to this definition">¶</a></dt>
<dd><p>Acquires a lock and returns a handle to it as a DBLock object. The
locker parameter is an integer representing the entity doing the
locking, and obj is an object representing the item to be locked.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockget.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_id">
<tt class="descname">lock_id</tt><big>(</big><big>)</big><a class="headerlink" href="#lock_id" title="Permalink to this definition">¶</a></dt>
<dd><p>Acquires a locker id, guaranteed to be unique across all threads and
processes that have the DBEnv open.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockid.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_id_free">
<tt class="descname">lock_id_free</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#lock_id_free" title="Permalink to this definition">¶</a></dt>
<dd><p>Frees a locker ID allocated by the “dbenv.lock_id()” method.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockid_free.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_put">
<tt class="descname">lock_put</tt><big>(</big><em>lock</em><big>)</big><a class="headerlink" href="#lock_put" title="Permalink to this definition">¶</a></dt>
<dd><p>Release the lock.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockput.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_stat">
<tt class="descname">lock_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#lock_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary of locking subsystem statistics with the
following keys:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="74%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>id</td>
<td>Last allocated lock ID.</td>
</tr>
<tr class="row-even"><td>cur_maxid</td>
<td>The current maximum unused locker ID.</td>
</tr>
<tr class="row-odd"><td>nmodes</td>
<td>Number of lock modes.</td>
</tr>
<tr class="row-even"><td>maxlocks</td>
<td>Maximum number of locks possible.</td>
</tr>
<tr class="row-odd"><td>maxlockers</td>
<td>Maximum number of lockers possible.</td>
</tr>
<tr class="row-even"><td>maxobjects</td>
<td>Maximum number of objects possible.</td>
</tr>
<tr class="row-odd"><td>nlocks</td>
<td>Number of current locks.</td>
</tr>
<tr class="row-even"><td>maxnlocks</td>
<td>Maximum number of locks at once.</td>
</tr>
<tr class="row-odd"><td>nlockers</td>
<td>Number of current lockers.</td>
</tr>
<tr class="row-even"><td>nobjects</td>
<td>Number of current lock objects.</td>
</tr>
<tr class="row-odd"><td>maxnobjects</td>
<td>Maximum number of lock objects at once.</td>
</tr>
<tr class="row-even"><td>maxnlockers</td>
<td>Maximum number of lockers at once.</td>
</tr>
<tr class="row-odd"><td>nrequests</td>
<td>Total number of locks requested.</td>
</tr>
<tr class="row-even"><td>nreleases</td>
<td>Total number of locks released.</td>
</tr>
<tr class="row-odd"><td>nupgrade</td>
<td>Total number of locks upgraded.</td>
</tr>
<tr class="row-even"><td>ndowngrade</td>
<td>Total number of locks downgraded.</td>
</tr>
<tr class="row-odd"><td>lock_wait</td>
<td>The number of lock requests not immediately
available due to conflicts, for which the
thread of control waited.</td>
</tr>
<tr class="row-even"><td>lock_nowait</td>
<td>The number of lock requests not immediately
available due to conflicts, for which the
thread of control did not wait.</td>
</tr>
<tr class="row-odd"><td>ndeadlocks</td>
<td>Number of deadlocks.</td>
</tr>
<tr class="row-even"><td>locktimeout</td>
<td>Lock timeout value.</td>
</tr>
<tr class="row-odd"><td>nlocktimeouts</td>
<td>The number of lock requests that have timed
out.</td>
</tr>
<tr class="row-even"><td>txntimeout</td>
<td>Transaction timeout value.</td>
</tr>
<tr class="row-odd"><td>ntxntimeouts</td>
<td>The number of transactions that have timed
out. This value is also a component of
ndeadlocks, the total number of deadlocks
detected.</td>
</tr>
<tr class="row-even"><td>objs_wait</td>
<td>The number of requests to allocate or
deallocate an object for which the thread
of control waited.</td>
</tr>
<tr class="row-odd"><td>objs_nowait</td>
<td>The number of requests to allocate or
deallocate an object for which the thread
of control did not wait.</td>
</tr>
<tr class="row-even"><td>lockers_wait</td>
<td>The number of requests to allocate or
deallocate a locker for which the thread of
control waited.</td>
</tr>
<tr class="row-odd"><td>lockers_nowait</td>
<td>The number of requests to allocate or
deallocate a locker for which the thread of
control did not wait.</td>
</tr>
<tr class="row-even"><td>locks_wait</td>
<td>The number of requests to allocate or
deallocate a lock structure for which the
thread of control waited.</td>
</tr>
<tr class="row-odd"><td>locks_nowait</td>
<td>The number of requests to allocate or
deallocate a lock structure for which the
thread of control did not wait.</td>
</tr>
<tr class="row-even"><td>hash_len</td>
<td>Maximum length of a lock hash bucket.</td>
</tr>
<tr class="row-odd"><td>regsize</td>
<td>Size of the region.</td>
</tr>
<tr class="row-even"><td>region_wait</td>
<td>Number of times a thread of control was
forced to wait before obtaining the region
lock.</td>
</tr>
<tr class="row-odd"><td>region_nowait</td>
<td>Number of times a thread of control was
able to obtain the region lock without
waiting.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lock_stat_print">
<tt class="descname">lock_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#lock_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the locking subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/lockstat_print.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_tx_max">
<tt class="descname">get_tx_max</tt><big>(</big><big>)</big><a class="headerlink" href="#get_tx_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of active transactions.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_tx_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_tx_max">
<tt class="descname">set_tx_max</tt><big>(</big><em>max</em><big>)</big><a class="headerlink" href="#set_tx_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of active transactions.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_tx_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_tx_timestamp">
<tt class="descname">get_tx_timestamp</tt><big>(</big><big>)</big><a class="headerlink" href="#get_tx_timestamp" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the recovery timestamp.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_tx_timestamp.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_tx_timestamp">
<tt class="descname">set_tx_timestamp</tt><big>(</big><em>timestamp</em><big>)</big><a class="headerlink" href="#set_tx_timestamp" title="Permalink to this definition">¶</a></dt>
<dd><p>Recover to the time specified by timestamp rather than to the most
current possible date.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_tx_timestamp.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="txn_begin">
<tt class="descname">txn_begin</tt><big>(</big><em>parent=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#txn_begin" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates and begins a new transaction. A DBTxn object is returned.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/txnbegin.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="txn_checkpoint">
<tt class="descname">txn_checkpoint</tt><big>(</big><em>kbyte=0</em>, <em>min=0</em>, <em>flag=0</em><big>)</big><a class="headerlink" href="#txn_checkpoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Flushes the underlying memory pool, writes a checkpoint record to the
log and then flushes the log.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/txncheckpoint.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="txn_stat">
<tt class="descname">txn_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#txn_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dictionary of transaction statistics with the following
keys:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="24%" />
<col width="76%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>last_ckp</td>
<td>The LSN of the last checkpoint.</td>
</tr>
<tr class="row-even"><td>time_ckp</td>
<td>Time the last completed checkpoint finished
(as the number of seconds since the Epoch,
returned by the IEEE/ANSI Std 1003.1 POSIX
time interface).</td>
</tr>
<tr class="row-odd"><td>last_txnid</td>
<td>Last transaction ID allocated.</td>
</tr>
<tr class="row-even"><td>maxtxns</td>
<td>Max number of active transactions possible.</td>
</tr>
<tr class="row-odd"><td>nactive</td>
<td>Number of transactions currently active.</td>
</tr>
<tr class="row-even"><td>maxnactive</td>
<td>Max number of active transactions at once.</td>
</tr>
<tr class="row-odd"><td>nsnapshot</td>
<td>The number of transactions on the snapshot
list. These are transactions which modified
a database opened with DB_MULTIVERSION, and
which have committed or aborted, but the
copies of pages they created are still in
the cache.</td>
</tr>
<tr class="row-even"><td>maxnsnapshot</td>
<td>The maximum number of transactions on the
snapshot list at any one time.</td>
</tr>
<tr class="row-odd"><td>nbegins</td>
<td>Number of transactions that have begun.</td>
</tr>
<tr class="row-even"><td>naborts</td>
<td>Number of transactions that have aborted.</td>
</tr>
<tr class="row-odd"><td>ncommits</td>
<td>Number of transactions that have committed.</td>
</tr>
<tr class="row-even"><td>nrestores</td>
<td>Number of transactions that have been
restored.</td>
</tr>
<tr class="row-odd"><td>regsize</td>
<td>Size of the region.</td>
</tr>
<tr class="row-even"><td>region_wait</td>
<td>Number of times that a thread of control
was forced to wait before obtaining the
region lock.</td>
</tr>
<tr class="row-odd"><td>region_nowait</td>
<td>Number of times that a thread of control
was able to obtain the region lock without
waiting.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/txnstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="txn_stat_print">
<tt class="descname">txn_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#txn_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the transaction subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/txnstat_print.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="lsn_reset">
<tt class="descname">lsn_reset</tt><big>(</big><em>file=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#lsn_reset" title="Permalink to this definition">¶</a></dt>
<dd><p>This method allows database files to be moved from one transactional
database environment to another.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envlsn_reset.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_stat">
<tt class="descname">log_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#log_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary of logging subsystem statistics with the
following keys:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>magic</td>
<td>The magic number that identifies a file as
a log file.</td>
</tr>
<tr class="row-even"><td>version</td>
<td>The version of the log file type.</td>
</tr>
<tr class="row-odd"><td>mode</td>
<td>The mode of any created log files.</td>
</tr>
<tr class="row-even"><td>lg_bsize</td>
<td>The in-memory log record cache size.</td>
</tr>
<tr class="row-odd"><td>lg_size</td>
<td>The log file size.</td>
</tr>
<tr class="row-even"><td>record</td>
<td>The number of records written to this log.</td>
</tr>
<tr class="row-odd"><td>w_mbytes</td>
<td>The number of megabytes written to this
log.</td>
</tr>
<tr class="row-even"><td>w_bytes</td>
<td>The number of bytes over and above w_mbytes
written to this log.</td>
</tr>
<tr class="row-odd"><td>wc_mbytes</td>
<td>The number of megabytes written to this log
since the last checkpoint.</td>
</tr>
<tr class="row-even"><td>wc_bytes</td>
<td>The number of bytes over and above
wc_mbytes written to this log since the
last checkpoint.</td>
</tr>
<tr class="row-odd"><td>wcount</td>
<td>The number of times the log has been
written to disk.</td>
</tr>
<tr class="row-even"><td>wcount_fill</td>
<td>The number of times the log has been
written to disk because the in-memory log
record cache filled up.</td>
</tr>
<tr class="row-odd"><td>rcount</td>
<td>The number of times the log has been read
from disk.</td>
</tr>
<tr class="row-even"><td>scount</td>
<td>The number of times the log has been
flushed to disk.</td>
</tr>
<tr class="row-odd"><td>cur_file</td>
<td>The current log file number.</td>
</tr>
<tr class="row-even"><td>cur_offset</td>
<td>The byte offset in the current log file.</td>
</tr>
<tr class="row-odd"><td>disk_file</td>
<td>The log file number of the last record
known to be on disk.</td>
</tr>
<tr class="row-even"><td>disk_offset</td>
<td>The byte offset of the last record known to
be on disk.</td>
</tr>
<tr class="row-odd"><td>maxcommitperflush</td>
<td>The maximum number of commits contained in
a single log flush.</td>
</tr>
<tr class="row-even"><td>mincommitperflush</td>
<td>The minimum number of commits contained in
a single log flush that contained a commit.</td>
</tr>
<tr class="row-odd"><td>regsize</td>
<td>The size of the log region, in bytes.</td>
</tr>
<tr class="row-even"><td>region_wait</td>
<td>The number of times that a thread of
control was forced to wait before obtaining
the log region mutex.</td>
</tr>
<tr class="row-odd"><td>region_nowait</td>
<td>The number of times that a thread of
control was able to obtain the log region
mutex without waiting.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="log_stat_print">
<tt class="descname">log_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#log_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the logging subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/logstat_print.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="txn_recover">
<tt class="descname">txn_recover</tt><big>(</big><big>)</big><a class="headerlink" href="#txn_recover" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of tuples (GID, TXN) of transactions prepared but
still unresolved. This is used while doing environment recovery in an
application using distributed transactions.</p>
<p>This method must be called only from a single thread at a time. It
should be called after DBEnv recovery.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/txnrecover.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_verbose">
<tt class="descname">set_verbose</tt><big>(</big><em>which</em>, <em>onoff</em><big>)</big><a class="headerlink" href="#set_verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>Turns specific additional informational and debugging messages in the
Berkeley DB message output on and off. To see the additional
messages, verbose messages must also be configured for the
application.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envset_verbose.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="get_verbose">
<tt class="descname">get_verbose</tt><big>(</big><em>which</em><big>)</big><a class="headerlink" href="#get_verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether the specified <em>which</em> parameter is currently set or
not.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envget_verbose.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="set_event_notify">
<tt class="descname">set_event_notify</tt><big>(</big><em>eventFunc</em><big>)</big><a class="headerlink" href="#set_event_notify" title="Permalink to this definition">¶</a></dt>
<dd><p>Configures a callback function which is called to notify the process
of specific Berkeley DB events.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/envevent_notify.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_stat">
<tt class="descname">mutex_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#mutex_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary of mutex subsystem statistics with the following
keys:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="28%" />
<col width="72%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>mutex_align</td>
<td>The mutex alignment, in bytes.</td>
</tr>
<tr class="row-even"><td>mutex_tas_spins</td>
<td>The number of times test-and-set mutexes
will spin without blocking.</td>
</tr>
<tr class="row-odd"><td>mutex_cnt</td>
<td>The total number of mutexes configured.</td>
</tr>
<tr class="row-even"><td>mutex_free</td>
<td>The number of mutexes currently available.</td>
</tr>
<tr class="row-odd"><td>mutex_inuse</td>
<td>The number of mutexes currently in use.</td>
</tr>
<tr class="row-even"><td>mutex_inuse_max</td>
<td>The maximum number of mutexes ever in use.</td>
</tr>
<tr class="row-odd"><td>regsize</td>
<td>The size of the mutex region, in bytes.</td>
</tr>
<tr class="row-even"><td>region_wait</td>
<td>The number of times that a thread of
control was forced to wait before
obtaining the mutex region mutex.</td>
</tr>
<tr class="row-odd"><td>region_nowait</td>
<td>The number of times that a thread of
control was able to obtain the mutex
region mutex without waiting.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_stat_print">
<tt class="descname">mutex_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#mutex_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the mutex subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexstat_print.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_set_max">
<tt class="descname">mutex_set_max</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#mutex_set_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the total number of mutexes to allocate.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexset_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_get_max">
<tt class="descname">mutex_get_max</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex_get_max" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the total number of mutexes allocated.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexget_max.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_set_increment">
<tt class="descname">mutex_set_increment</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#mutex_set_increment" title="Permalink to this definition">¶</a></dt>
<dd><p>Configure the number of additional mutexes to allocate.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexset_increment.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_get_increment">
<tt class="descname">mutex_get_increment</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex_get_increment" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of additional mutexes to allocate.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexget_increment.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_set_align">
<tt class="descname">mutex_set_align</tt><big>(</big><em>align</em><big>)</big><a class="headerlink" href="#mutex_set_align" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the mutex alignment, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexset_align.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_get_align">
<tt class="descname">mutex_get_align</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex_get_align" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the mutex alignment, in bytes.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexget_align.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_set_tas_spins">
<tt class="descname">mutex_set_tas_spins</tt><big>(</big><em>tas_spins</em><big>)</big><a class="headerlink" href="#mutex_set_tas_spins" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify that test-and-set mutexes should spin tas_spins times without
blocking. Check the default values in the Oracle webpage.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexset_tas_spins.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="mutex_get_tas_spins">
<tt class="descname">mutex_get_tas_spins</tt><big>(</big><big>)</big><a class="headerlink" href="#mutex_get_tas_spins" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the test-and-set spin count.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/mutexget_tas_spins.html">More info...</a></p>
</dd></dl>
</div>
<div class="section" id="dbenv-replication-manager-methods">
<h2>DBEnv Replication Manager Methods<a class="headerlink" href="#dbenv-replication-manager-methods" title="Permalink to this headline">¶</a></h2>
<p>This module automates many of the tasks needed to provide replication
abilities in a Berkeley DB system. The module is fairly limited, but
enough in many cases. Users more demanding must use the <strong>full</strong> Base
Replication API.</p>
<p>This module requires pthread support (in Unix), so you must compile
Berkeley DB with it if you want to be able to use the Replication
Manager.</p>
<dl class="function">
<dt id="repmgr_start">
<tt class="descname">repmgr_start</tt><big>(</big><em>nthreads</em>, <em>flags</em><big>)</big><a class="headerlink" href="#repmgr_start" title="Permalink to this definition">¶</a></dt>
<dd><p>Starts the replication manager.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrstart.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_site">
<tt class="descname">repmgr_site</tt><big>(</big><em>host</em>, <em>port</em><big>)</big><a class="headerlink" href="#repmgr_site" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a DB_SITE handle that defines a site’s host/port network
address. You use the DB_SITE handle to configure and manage
replication sites.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgr_site.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_site_by_eid">
<tt class="descname">repmgr_site_by_eid</tt><big>(</big><em>eid</em><big>)</big><a class="headerlink" href="#repmgr_site_by_eid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a DB_SITE handle based on the site’s Environment ID value.
You use the DB_SITE handle to configure and manage replication sites.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgr_site_by_eid.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_set_ack_policy">
<tt class="descname">repmgr_set_ack_policy</tt><big>(</big><em>ack_policy</em><big>)</big><a class="headerlink" href="#repmgr_set_ack_policy" title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies how master and client sites will handle acknowledgment of
replication messages which are necessary for “permanent” records.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrset_ack_policy.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_get_ack_policy">
<tt class="descname">repmgr_get_ack_policy</tt><big>(</big><big>)</big><a class="headerlink" href="#repmgr_get_ack_policy" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the replication manager’s client acknowledgment policy.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrget_ack_policy.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_site_list">
<tt class="descname">repmgr_site_list</tt><big>(</big><big>)</big><a class="headerlink" href="#repmgr_site_list" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary with the status of the sites currently known by
the replication manager.</p>
<p>The keys are the Environment ID assigned by the replication manager.
This is the same value that is passed to the application’s event
notification function for the DB_EVENT_REP_NEWMASTER event.</p>
<p>The values are tuples containing the hostname, the TCP/IP port number
and the link status.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrsite_list.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_stat">
<tt class="descname">repmgr_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#repmgr_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary with the replication manager statistics. Keys
are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="26%" />
<col width="74%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>perm_failed</td>
<td>The number of times a message critical for
maintaining database integrity (for example, a
transaction commit), originating at this site,
did not receive sufficient acknowledgement from
clients, according to the configured
acknowledgement policy and acknowledgement
timeout.</td>
</tr>
<tr class="row-even"><td>msgs_queued</td>
<td>The number of outgoing messages which could not
be transmitted immediately, due to a full
network buffer, and had to be queued for later
delivery.</td>
</tr>
<tr class="row-odd"><td>msgs_dropped</td>
<td>The number of outgoing messages that were
completely dropped, because the outgoing
message queue was full. (Berkeley DB
replication is tolerant of dropped messages,
and will automatically request retransmission
of any missing messages as needed.)</td>
</tr>
<tr class="row-even"><td>connection_drop</td>
<td>The number of times an existing TCP/IP
connection failed.</td>
</tr>
<tr class="row-odd"><td>connect_fail</td>
<td>The number of times an attempt to open a new
TCP/IP connection failed.</td>
</tr>
</tbody>
</table>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="repmgr_stat_print">
<tt class="descname">repmgr_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#repmgr_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the replication manager statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmgrstat_print.html">More info...</a></p>
</dd></dl>
</div>
<div class="section" id="dbenv-replication-methods">
<h2>DBEnv Replication Methods<a class="headerlink" href="#dbenv-replication-methods" title="Permalink to this headline">¶</a></h2>
<p>This section provides the raw methods for replication. If possible,
it is recommended to use the Replication Manager.</p>
<dl class="function">
<dt id="rep_elect">
<tt class="descname">rep_elect</tt><big>(</big><em>nsites</em>, <em>nvotes</em><big>)</big><a class="headerlink" href="#rep_elect" title="Permalink to this definition">¶</a></dt>
<dd><p>Holds an election for the master of a replication group.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repelect.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_transport">
<tt class="descname">rep_set_transport</tt><big>(</big><em>envid</em>, <em>transportFunc</em><big>)</big><a class="headerlink" href="#rep_set_transport" title="Permalink to this definition">¶</a></dt>
<dd><p>Initializes the communication infrastructure for a database
environment participating in a replicated application.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/reptransport.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_process_messsage">
<tt class="descname">rep_process_messsage</tt><big>(</big><em>control</em>, <em>rec</em>, <em>envid</em><big>)</big><a class="headerlink" href="#rep_process_messsage" title="Permalink to this definition">¶</a></dt>
<dd><p>Processes an incoming replication message sent by a member of the
replication group to the local database environment.</p>
<p>Returns a two element tuple.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repmessage.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_start">
<tt class="descname">rep_start</tt><big>(</big><em>flags</em>, <em>cdata=None</em><big>)</big><a class="headerlink" href="#rep_start" title="Permalink to this definition">¶</a></dt>
<dd><p>Configures the database environment as a client or master in a group
of replicated database environments.</p>
<p>The DB_ENV->rep_start method is not called by most replication
applications. It should only be called by applications implementing
their own network transport layer, explicitly holding replication
group elections and handling replication messages outside of the
replication manager framework.</p>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repstart.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_sync">
<tt class="descname">rep_sync</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Forces master synchronization to begin for this client. This method
is the other half of setting the DB_REP_CONF_DELAYCLIENT flag via the
DB_ENV->rep_set_config method.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repsync.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_config">
<tt class="descname">rep_set_config</tt><big>(</big><em>which</em>, <em>onoff</em><big>)</big><a class="headerlink" href="#rep_set_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Configures the Berkeley DB replication subsystem.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repconfig.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_config">
<tt class="descname">rep_get_config</tt><big>(</big><em>which</em><big>)</big><a class="headerlink" href="#rep_get_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns whether the specified which parameter is currently set or
not.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_config.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_limit">
<tt class="descname">rep_set_limit</tt><big>(</big><em>bytes</em><big>)</big><a class="headerlink" href="#rep_set_limit" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets a byte-count limit on the amount of data that will be
transmitted from a site in response to a single message processed by
the DB_ENV->rep_process_message method. The limit is not a hard
limit, and the record that exceeds the limit is the last record to be
sent.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repset_limit.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_limit">
<tt class="descname">rep_get_limit</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_get_limit" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets a byte-count limit on the amount of data that will be
transmitted from a site in response to a single message processed by
the DB_ENV->rep_process_message method. The limit is not a hard
limit, and the record that exceeds the limit is the last record to be
sent.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_limit.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_request">
<tt class="descname">rep_set_request</tt><big>(</big><em>minimum</em>, <em>maximum</em><big>)</big><a class="headerlink" href="#rep_set_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets a threshold for the minimum and maximum time that a client
waits before requesting retransmission of a missing message.
Specifically, if the client detects a gap in the sequence of incoming
log records or database pages, Berkeley DB will wait for at least min
microseconds before requesting retransmission of the missing record.
Berkeley DB will double that amount before requesting the same
missing record again, and so on, up to a maximum threshold of max
microseconds.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repset_request.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_request">
<tt class="descname">rep_get_request</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_get_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a tuple with the minimum and maximum number of microseconds a
client waits before requesting retransmission.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_request.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_nsites">
<tt class="descname">rep_set_nsites</tt><big>(</big><em>nsites</em><big>)</big><a class="headerlink" href="#rep_set_nsites" title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies the total number of sites in a replication group.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repnsites.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_nsites">
<tt class="descname">rep_get_nsites</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_get_nsites" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the total number of sites in the replication group.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_nsites.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_priority">
<tt class="descname">rep_set_priority</tt><big>(</big><em>priority</em><big>)</big><a class="headerlink" href="#rep_set_priority" title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies the database environment’s priority in replication group
elections. The priority must be a positive integer, or 0 if this
environment cannot be a replication group master.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/reppriority.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_priority">
<tt class="descname">rep_get_priority</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_get_priority" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the database environment priority.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_priority.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_timeout">
<tt class="descname">rep_set_timeout</tt><big>(</big><em>which</em>, <em>timeout</em><big>)</big><a class="headerlink" href="#rep_set_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Specifies a variety of replication timeout values.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repset_timeout.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_timeout">
<tt class="descname">rep_get_timeout</tt><big>(</big><em>which</em><big>)</big><a class="headerlink" href="#rep_get_timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the timeout value for the specified <em>which</em> parameter.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_timeout.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_set_clockskew">
<tt class="descname">rep_set_clockskew</tt><big>(</big><em>fast</em>, <em>slow</em><big>)</big><a class="headerlink" href="#rep_set_clockskew" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the clock skew ratio among replication group members based on
the fastest and slowest measurements among the group for use with
master leases.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repclockskew.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_get_clockskew">
<tt class="descname">rep_get_clockskew</tt><big>(</big><big>)</big><a class="headerlink" href="#rep_get_clockskew" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a tuple with the current clock skew values.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repget_clockskew.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_stat">
<tt class="descname">rep_stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#rep_stat" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a dictionary with the replication subsystem statistics. Keys
are:</p>
<table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="68%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>st_bulk_fills</td>
<td>The number of times the bulk buffer filled
up, forcing the buffer content to be sent.</td>
</tr>
<tr class="row-even"><td>bulk_overflows</td>
<td>The number of times a record was bigger
than the entire bulk buffer, and therefore
had to be sent as a singleton.</td>
</tr>
<tr class="row-odd"><td>bulk_records</td>
<td>The number of records added to a bulk
buffer.</td>
</tr>
<tr class="row-even"><td>bulk_transfers</td>
<td>The number of bulk buffers transferred (via
a call to the application’s send function).</td>
</tr>
<tr class="row-odd"><td>client_rerequests</td>
<td>The number of times this client site
received a “re-request” message, indicating
that a request it previously sent to
another client could not be serviced by
that client. (Compare to client_svc_miss.)</td>
</tr>
<tr class="row-even"><td>client_svc_miss</td>
<td>The number of “request” type messages
received by this client that could not be
processed, forcing the originating
requester to try sending the request to the
master (or another client).</td>
</tr>
<tr class="row-odd"><td>client_svc_req</td>
<td>The number of “request” type messages
received by this client. (“Request”
messages are usually sent from a client to
the master, but a message marked with the
DB_REP_ANYWHERE flag in the invocation of
the application’s send function may be sent
to another client instead.)</td>
</tr>
<tr class="row-even"><td>dupmasters</td>
<td>The number of duplicate master conditions
originally detected at this site.</td>
</tr>
<tr class="row-odd"><td>egen</td>
<td>The current election generation number.</td>
</tr>
<tr class="row-even"><td>election_cur_winner</td>
<td>The election winner.</td>
</tr>
<tr class="row-odd"><td>election_gen</td>
<td>The election generation number.</td>
</tr>
<tr class="row-even"><td>election_lsn</td>
<td>The maximum LSN of election winner.</td>
</tr>
<tr class="row-odd"><td>election_nsites</td>
<td>The number sites responding to this site
during the last election.</td>
</tr>
<tr class="row-even"><td>election_nvotes</td>
<td>The number of votes required in the last
election.</td>
</tr>
<tr class="row-odd"><td>election_priority</td>
<td>The election priority.</td>
</tr>
<tr class="row-even"><td>election_sec</td>
<td>The number of seconds the last election
took (the total election time is
election_sec plus election_usec).</td>
</tr>
<tr class="row-odd"><td>election_status</td>
<td>The current election phase (0 if no
election is in progress).</td>
</tr>
<tr class="row-even"><td>election_tiebreaker</td>
<td>The election tiebreaker value.</td>
</tr>
<tr class="row-odd"><td>election_usec</td>
<td>The number of microseconds the last
election took (the total election time is
election_sec plus election_usec).</td>
</tr>
<tr class="row-even"><td>election_votes</td>
<td>The number of votes received in the last
election.</td>
</tr>
<tr class="row-odd"><td>elections</td>
<td>The number of elections held.</td>
</tr>
<tr class="row-even"><td>elections_won</td>
<td>The number of elections won.</td>
</tr>
<tr class="row-odd"><td>env_id</td>
<td>The current environment ID.</td>
</tr>
<tr class="row-even"><td>env_priority</td>
<td>The current environment priority.</td>
</tr>
<tr class="row-odd"><td>gen</td>
<td>The current generation number.</td>
</tr>
<tr class="row-even"><td>log_duplicated</td>
<td>The number of duplicate log records
received.</td>
</tr>
<tr class="row-odd"><td>log_queued</td>
<td>The number of log records currently queued.</td>
</tr>
<tr class="row-even"><td>log_queued_max</td>
<td>The maximum number of log records ever
queued at once.</td>
</tr>
<tr class="row-odd"><td>log_queued_total</td>
<td>The total number of log records queued.</td>
</tr>
<tr class="row-even"><td>log_records</td>
<td>The number of log records received and
appended to the log.</td>
</tr>
<tr class="row-odd"><td>log_requested</td>
<td>The number of times log records were missed
and requested.</td>
</tr>
<tr class="row-even"><td>master</td>
<td>The current master environment ID.</td>
</tr>
<tr class="row-odd"><td>master_changes</td>
<td>The number of times the master has changed.</td>
</tr>
<tr class="row-even"><td>max_lease_sec</td>
<td>The number of seconds of the longest lease
(the total lease time is max_lease_sec plus
max_lease_usec).</td>
</tr>
<tr class="row-odd"><td>max_lease_usec</td>
<td>The number of microseconds of the longest
lease (the total lease time is
max_lease_sec plus max_lease_usec).</td>
</tr>
<tr class="row-even"><td>max_perm_lsn</td>
<td>The LSN of the maximum permanent log
record, or 0 if there are no permanent log
records.</td>
</tr>
<tr class="row-odd"><td>msgs_badgen</td>
<td>The number of messages received with a bad
generation number.</td>
</tr>
<tr class="row-even"><td>msgs_processed</td>
<td>The number of messages received and
processed.</td>
</tr>
<tr class="row-odd"><td>msgs_recover</td>
<td>The number of messages ignored due to
pending recovery.</td>
</tr>
<tr class="row-even"><td>msgs_send_failures</td>
<td>The number of failed message sends.</td>
</tr>
<tr class="row-odd"><td>msgs_sent</td>
<td>The number of messages sent.</td>
</tr>
<tr class="row-even"><td>newsites</td>
<td>The number of new site messages received.</td>
</tr>
<tr class="row-odd"><td>next_lsn</td>
<td>In replication environments configured as
masters, the next LSN expected. In
replication environments configured as
clients, the next LSN to be used.</td>
</tr>
<tr class="row-even"><td>next_pg</td>
<td>The next page number we expect to receive.</td>
</tr>
<tr class="row-odd"><td>nsites</td>
<td>The number of sites used in the last
election.</td>
</tr>
<tr class="row-even"><td>nthrottles</td>
<td>Transmission limited. This indicates the
number of times that data transmission was
stopped to limit the amount of data sent in
response to a single call to
DB_ENV->rep_process_message.</td>
</tr>
<tr class="row-odd"><td>outdated</td>
<td>The number of outdated conditions detected.</td>
</tr>
<tr class="row-even"><td>pg_duplicated</td>
<td>The number of duplicate pages received.</td>
</tr>
<tr class="row-odd"><td>pg_records</td>
<td>The number of pages received and stored.</td>
</tr>
<tr class="row-even"><td>pg_requested</td>
<td>The number of pages missed and requested
from the master.</td>
</tr>
<tr class="row-odd"><td>startsync_delayed</td>
<td>The number of times the client had to delay
the start of a cache flush operation
(initiated by the master for an impending
checkpoint) because it was missing some
previous log record(s).</td>
</tr>
<tr class="row-even"><td>startup_complete</td>
<td>The client site has completed its startup
procedures and is now handling live records
from the master.</td>
</tr>
<tr class="row-odd"><td>status</td>
<td><dl class="first last docutils">
<dt>The current replication mode. Set to</dt>
<dd>DB_REP_MASTER if the environment is a
replication master, DB_REP_CLIENT if the
environment is a replication client, or 0
if replication is not configured.</dd>
</dl>
</td>
</tr>
<tr class="row-even"><td>txns_applied</td>
<td>The number of transactions applied.</td>
</tr>
<tr class="row-odd"><td>waiting_lsn</td>
<td>The LSN of the first log record we have
after missing log records being waited for,
or 0 if no log records are currently
missing.</td>
</tr>
<tr class="row-even"><td>waiting_pg</td>
<td>The page number of the first page we have
after missing pages being waited for, or 0
if no pages are currently missing.</td>
</tr>
</tbody>
</table>
<p><a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repstat.html">More info...</a></p>
</dd></dl>
<dl class="function">
<dt id="rep_stat_print">
<tt class="descname">rep_stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#rep_stat_print" title="Permalink to this definition">¶</a></dt>
<dd><p>Displays the replication subsystem statistical information.
<a class="reference external" href="http://docs.oracle.com/cd/E17076_03/html/api_reference/C/repstat_print.html">More info...</a></p>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">DBEnv</a><ul>
<li><a class="reference internal" href="#dbenv-attributes">DBEnv Attributes</a></li>
<li><a class="reference internal" href="#dbenv-methods">DBEnv Methods</a></li>
<li><a class="reference internal" href="#dbenv-replication-manager-methods">DBEnv Replication Manager Methods</a></li>
<li><a class="reference internal" href="#dbenv-replication-methods">DBEnv Replication Methods</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="introduction.html"
title="previous chapter">Berkeley DB 4.3 thru 6.0 Python Extension Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="db.html"
title="next chapter">DB</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="db.html" title="DB"
>next</a> |</li>
<li class="right" >
<a href="introduction.html" title="Berkeley DB 4.3 thru 6.0 Python Extension Package"
>previous</a> |</li>
<li><a href="contents.html">PyBSDDB 6.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2008-2013 Jesus Cea Avion.
Last updated on Dec 04, 2013.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
|