/usr/share/doc/swift-doc/html/container.html is in swift-doc 2.17.0-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
<title>OpenStack Docs: Container</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Bootstrap CSS -->
<link href="_static/css/bootstrap.min.css" rel="stylesheet">
<!-- Pygments CSS -->
<link href="_static/css/native.css" rel="stylesheet">
<!-- Fonts -->
<link href="_static/css/font-awesome.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="_static/css/combined.css" rel="stylesheet">
</head>
<body>
<!-- SOURCE_FILE: https://git.openstack.org/cgit/openstack/swift/tree/doc/source/container.rst -->
<script type="text/javascript">
(function(w,d,t,u,n,s,e){w['SwiftypeObject']=n;w[n]=w[n]||function(){
(w[n].q=w[n].q||[]).push(arguments);};s=d.createElement(t);
e=d.getElementsByTagName(t)[0];s.async=1;s.src=u;e.parentNode.insertBefore(s,e);
})(window,document,'script','//s.swiftypecdn.com/install/v2/st.js','_st');
_st('install','aDn5L_vgZ2yzRcE893kK','2.0.0');
</script>
<nav class="navbar navbar-default" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<div class="brand-wrapper">
<a class="navbar-brand" href="index.html"></a>
</div>
</div>
</div>
<!-- /.container -->
</nav>
<div class="container docs-book-wrapper">
<div class="row">
<div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4">
<div class="row">
<div class="col-lg-8">
<h2>Container</h2>
</div>
<div class="docs-actions">
<a href="account.html"><i class="fa fa-angle-double-left" data-toggle="tooltip" data-placement="top" title="Previous: Account"></i></a>
<a href="db.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Account DB and Container DB"></i></a>
<a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a>
</div>
</div>
<div class="row docs-byline">
<div class="docs-updated">updated: 2018-02-14 14:24</div>
</div>
<div class="row">
<div class="col-lg-12">
<div class="docs-body">
<div class="section" id="container">
<span id="id1"></span><h1>Container<a class="headerlink" href="#container" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-swift.container.auditor">
<span id="id2"></span><span id="container-auditor"></span><h2>Container Auditor<a class="headerlink" href="#module-swift.container.auditor" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.auditor.ContainerAuditor">
<em class="property">class </em><code class="descclassname">swift.container.auditor.</code><code class="descname">ContainerAuditor</code><span class="sig-paren">(</span><em>conf</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.auditor.ContainerAuditor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">swift.common.daemon.Daemon</span></code></p>
<p>Audit containers.</p>
<dl class="method">
<dt id="swift.container.auditor.ContainerAuditor.container_audit">
<code class="descname">container_audit</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.auditor.ContainerAuditor.container_audit" title="Permalink to this definition">¶</a></dt>
<dd><p>Audits the given container path</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – the path to a container db</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.auditor.ContainerAuditor.run_forever">
<code class="descname">run_forever</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.auditor.ContainerAuditor.run_forever" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the container audit until stopped.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.auditor.ContainerAuditor.run_once">
<code class="descname">run_once</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.auditor.ContainerAuditor.run_once" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the container audit once.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.auditor.random">
<code class="descclassname">swift.container.auditor.</code><code class="descname">random</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → x in the interval [0, 1).<a class="headerlink" href="#swift.container.auditor.random" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-swift.container.backend">
<span id="id3"></span><span id="container-backend"></span><h2>Container Backend<a class="headerlink" href="#module-swift.container.backend" title="Permalink to this headline">¶</a></h2>
<p>Pluggable Back-ends for Container Server</p>
<dl class="class">
<dt id="swift.container.backend.ContainerBroker">
<em class="property">class </em><code class="descclassname">swift.container.backend.</code><code class="descname">ContainerBroker</code><span class="sig-paren">(</span><em>db_file</em>, <em>timeout=25</em>, <em>logger=None</em>, <em>account=None</em>, <em>container=None</em>, <em>pending_timeout=None</em>, <em>stale_reads_ok=False</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="db.html#swift.common.db.DatabaseBroker" title="swift.common.db.DatabaseBroker"><code class="xref py py-class docutils literal"><span class="pre">swift.common.db.DatabaseBroker</span></code></a></p>
<p>Encapsulates working with a container database.</p>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.create_container_info_table">
<code class="descname">create_container_info_table</code><span class="sig-paren">(</span><em>conn</em>, <em>put_timestamp</em>, <em>storage_policy_index</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.create_container_info_table" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the container_info table which is specific to the container DB.
Not a part of Pluggable Back-ends, internal to the baseline code.
Also creates the container_stat view.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>conn</strong> – DB connection object</li>
<li><strong>put_timestamp</strong> – put timestamp</li>
<li><strong>storage_policy_index</strong> – storage policy index</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.create_object_table">
<code class="descname">create_object_table</code><span class="sig-paren">(</span><em>conn</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.create_object_table" title="Permalink to this definition">¶</a></dt>
<dd><p>Create the object table which is specific to the container DB.
Not a part of Pluggable Back-ends, internal to the baseline code.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>conn</strong> – DB connection object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.create_policy_stat_table">
<code class="descname">create_policy_stat_table</code><span class="sig-paren">(</span><em>conn</em>, <em>storage_policy_index=0</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.create_policy_stat_table" title="Permalink to this definition">¶</a></dt>
<dd><p>Create policy_stat table.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>conn</strong> – DB connection object</li>
<li><strong>storage_policy_index</strong> – the policy_index the container is
being created with</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.backend.ContainerBroker.db_contains_type">
<code class="descname">db_contains_type</code><em class="property"> = 'object'</em><a class="headerlink" href="#swift.container.backend.ContainerBroker.db_contains_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.backend.ContainerBroker.db_reclaim_timestamp">
<code class="descname">db_reclaim_timestamp</code><em class="property"> = 'created_at'</em><a class="headerlink" href="#swift.container.backend.ContainerBroker.db_reclaim_timestamp" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.backend.ContainerBroker.db_type">
<code class="descname">db_type</code><em class="property"> = 'container'</em><a class="headerlink" href="#swift.container.backend.ContainerBroker.db_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.delete_object">
<code class="descname">delete_object</code><span class="sig-paren">(</span><em>name</em>, <em>timestamp</em>, <em>storage_policy_index=0</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.delete_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Mark an object deleted.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – object name to be deleted</li>
<li><strong>timestamp</strong> – timestamp when the object was marked as deleted</li>
<li><strong>storage_policy_index</strong> – the storage policy index for the object</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.empty">
<code class="descname">empty</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.empty" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if container DB is empty.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the database has no active objects, False otherwise</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_db_version">
<code class="descname">get_db_version</code><span class="sig-paren">(</span><em>conn</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_db_version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_info">
<code class="descname">get_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get global data for the container.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">dict with keys: account, container, created_at,
put_timestamp, delete_timestamp, status_changed_at,
object_count, bytes_used, reported_put_timestamp,
reported_delete_timestamp, reported_object_count,
reported_bytes_used, hash, id, x_container_sync_point1,
x_container_sync_point2, and storage_policy_index.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_info_is_deleted">
<code class="descname">get_info_is_deleted</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_info_is_deleted" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the is_deleted status and info for the container.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a tuple, in the form (info, is_deleted) info is a dict as
returned by get_info and is_deleted is a boolean.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_misplaced_since">
<code class="descname">get_misplaced_since</code><span class="sig-paren">(</span><em>start</em>, <em>count</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_misplaced_since" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of objects which are in a storage policy different
from the container’s storage policy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>start</strong> – last reconciler sync point</li>
<li><strong>count</strong> – maximum number of entries to get</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of dicts with keys: name, created_at, size,
content_type, etag, storage_policy_index</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_policy_stats">
<code class="descname">get_policy_stats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_policy_stats" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.get_reconciler_sync">
<code class="descname">get_reconciler_sync</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.get_reconciler_sync" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.has_multiple_policies">
<code class="descname">has_multiple_policies</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.has_multiple_policies" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.list_objects_iter">
<code class="descname">list_objects_iter</code><span class="sig-paren">(</span><em>limit</em>, <em>marker</em>, <em>end_marker</em>, <em>prefix</em>, <em>delimiter</em>, <em>path=None</em>, <em>storage_policy_index=0</em>, <em>reverse=False</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.list_objects_iter" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of objects sorted by name starting at marker onward, up
to limit entries. Entries will begin with the prefix and will not
have the delimiter after the prefix.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>limit</strong> – maximum number of entries to get</li>
<li><strong>marker</strong> – marker query</li>
<li><strong>end_marker</strong> – end marker query</li>
<li><strong>prefix</strong> – prefix query</li>
<li><strong>delimiter</strong> – delimiter for query</li>
<li><strong>path</strong> – if defined, will set the prefix and delimiter based on
the path</li>
<li><strong>storage_policy_index</strong> – storage policy index for query</li>
<li><strong>reverse</strong> – reverse the result order.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of tuples of (name, created_at, size, content_type,
etag)</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.make_tuple_for_pickle">
<code class="descname">make_tuple_for_pickle</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.make_tuple_for_pickle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.merge_items">
<code class="descname">merge_items</code><span class="sig-paren">(</span><em>item_list</em>, <em>source=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.merge_items" title="Permalink to this definition">¶</a></dt>
<dd><p>Merge items into the object table.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>item_list</strong> – list of dictionaries of {‘name’, ‘created_at’,
‘size’, ‘content_type’, ‘etag’, ‘deleted’,
‘storage_policy_index’, ‘ctype_timestamp’,
‘meta_timestamp’}</li>
<li><strong>source</strong> – if defined, update incoming_sync with the source</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.put_object">
<code class="descname">put_object</code><span class="sig-paren">(</span><em>name</em>, <em>timestamp</em>, <em>size</em>, <em>content_type</em>, <em>etag</em>, <em>deleted=0</em>, <em>storage_policy_index=0</em>, <em>ctype_timestamp=None</em>, <em>meta_timestamp=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.put_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an object in the DB with its metadata.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – object name to be created</li>
<li><strong>timestamp</strong> – timestamp of when the object was created</li>
<li><strong>size</strong> – object size</li>
<li><strong>content_type</strong> – object content-type</li>
<li><strong>etag</strong> – object etag</li>
<li><strong>deleted</strong> – if True, marks the object as deleted and sets the
deleted_at timestamp to timestamp</li>
<li><strong>storage_policy_index</strong> – the storage policy index for the object</li>
<li><strong>ctype_timestamp</strong> – timestamp of when content_type was last
updated</li>
<li><strong>meta_timestamp</strong> – timestamp of when metadata was last updated</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.reported">
<code class="descname">reported</code><span class="sig-paren">(</span><em>put_timestamp</em>, <em>delete_timestamp</em>, <em>object_count</em>, <em>bytes_used</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.reported" title="Permalink to this definition">¶</a></dt>
<dd><p>Update reported stats, available with container’s <cite>get_info</cite>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>put_timestamp</strong> – put_timestamp to update</li>
<li><strong>delete_timestamp</strong> – delete_timestamp to update</li>
<li><strong>object_count</strong> – object_count to update</li>
<li><strong>bytes_used</strong> – bytes_used to update</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.set_storage_policy_index">
<code class="descname">set_storage_policy_index</code><span class="sig-paren">(</span><em>policy_index</em>, <em>timestamp=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.set_storage_policy_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the container_stat policy_index and status_changed_at.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.set_x_container_sync_points">
<code class="descname">set_x_container_sync_points</code><span class="sig-paren">(</span><em>sync_point1</em>, <em>sync_point2</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.set_x_container_sync_points" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.backend.ContainerBroker.storage_policy_index">
<code class="descname">storage_policy_index</code><a class="headerlink" href="#swift.container.backend.ContainerBroker.storage_policy_index" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.backend.ContainerBroker.update_reconciler_sync">
<code class="descname">update_reconciler_sync</code><span class="sig-paren">(</span><em>point</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.ContainerBroker.update_reconciler_sync" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.backend.update_new_item_from_existing">
<code class="descclassname">swift.container.backend.</code><code class="descname">update_new_item_from_existing</code><span class="sig-paren">(</span><em>new_item</em>, <em>existing</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.backend.update_new_item_from_existing" title="Permalink to this definition">¶</a></dt>
<dd><p>Compare the data and meta related timestamps of a new object item with
the timestamps of an existing object record, and update the new item
with data and/or meta related attributes from the existing record if
their timestamps are newer.</p>
<p>The multiple timestamps are encoded into a single string for storing
in the ‘created_at’ column of the objects db table.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>new_item</strong> – A dict of object update attributes</li>
<li><strong>existing</strong> – A dict of existing object attributes</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if any attributes of the new item dict were found to be
newer than the existing and therefore not updated, otherwise
False implying that the updated item is equal to the existing.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="module-swift.container.server">
<span id="id4"></span><span id="container-server"></span><h2>Container Server<a class="headerlink" href="#module-swift.container.server" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.server.ContainerController">
<em class="property">class </em><code class="descclassname">swift.container.server.</code><code class="descname">ContainerController</code><span class="sig-paren">(</span><em>conf</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">swift.common.base_storage_server.BaseStorageServer</span></code></p>
<p>WSGI Controller for the container server.</p>
<dl class="method">
<dt id="swift.container.server.ContainerController.DELETE">
<code class="descname">DELETE</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.DELETE" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP DELETE request.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.GET">
<code class="descname">GET</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.GET" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP GET request.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.HEAD">
<code class="descname">HEAD</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.HEAD" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP HEAD request.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.POST">
<code class="descname">POST</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.POST" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP POST request.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.PUT">
<code class="descname">PUT</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.PUT" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP PUT request.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.REPLICATE">
<code class="descname">REPLICATE</code><span class="sig-paren">(</span><em>ctrl</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.REPLICATE" title="Permalink to this definition">¶</a></dt>
<dd><p>Handle HTTP REPLICATE request (json-encoded RPC calls for replication.)</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.account_update">
<code class="descname">account_update</code><span class="sig-paren">(</span><em>req</em>, <em>account</em>, <em>container</em>, <em>broker</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.account_update" title="Permalink to this definition">¶</a></dt>
<dd><p>Update the account server(s) with latest container info.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>req</strong> – swob.Request object</li>
<li><strong>account</strong> – account name</li>
<li><strong>container</strong> – container name</li>
<li><strong>broker</strong> – container DB broker object</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">if all the account requests return a 404 error code,
HTTPNotFound response object,
if the account cannot be updated due to a malformed header,
an HTTPBadRequest response object,
otherwise None.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.server.ContainerController.allowed_sync_hosts">
<code class="descname">allowed_sync_hosts</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.server.ContainerController.allowed_sync_hosts" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of hosts we’re allowed to send syncs to. This can be
overridden by data in self.realms_conf</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.create_listing">
<code class="descname">create_listing</code><span class="sig-paren">(</span><em>req</em>, <em>out_content_type</em>, <em>info</em>, <em>resp_headers</em>, <em>metadata</em>, <em>container_list</em>, <em>container</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.create_listing" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.get_and_validate_policy_index">
<code class="descname">get_and_validate_policy_index</code><span class="sig-paren">(</span><em>req</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.get_and_validate_policy_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate that the index supplied maps to a policy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">policy index from request, or None if not present</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>HTTPBadRequest</strong> – if the supplied index is bogus</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.server.ContainerController.realms_conf">
<code class="descname">realms_conf</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.server.ContainerController.realms_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>ContainerSyncCluster instance for validating sync-to values.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.server.ContainerController.save_headers">
<code class="descname">save_headers</code><em class="property"> = ['x-container-read', 'x-container-write', 'x-container-sync-key', 'x-container-sync-to']</em><a class="headerlink" href="#swift.container.server.ContainerController.save_headers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.server.ContainerController.server_type">
<code class="descname">server_type</code><em class="property"> = 'container-server'</em><a class="headerlink" href="#swift.container.server.ContainerController.server_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.server.ContainerController.update_data_record">
<code class="descname">update_data_record</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.ContainerController.update_data_record" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform any mutations to container listing records that are common to
all serialization formats, and returns it as a dict.</p>
<p>Converts created time to iso timestamp.
Replaces size with ‘swift_bytes’ content type parameter.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Params record:</th><td class="field-body">object entry record</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">modified record</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.server.app_factory">
<code class="descclassname">swift.container.server.</code><code class="descname">app_factory</code><span class="sig-paren">(</span><em>global_conf</em>, <em>**local_conf</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.app_factory" title="Permalink to this definition">¶</a></dt>
<dd><p>paste.deploy app factory for creating WSGI container server apps</p>
</dd></dl>
<dl class="function">
<dt id="swift.container.server.gen_resp_headers">
<code class="descclassname">swift.container.server.</code><code class="descname">gen_resp_headers</code><span class="sig-paren">(</span><em>info</em>, <em>is_deleted=False</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.server.gen_resp_headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert container info dict to headers.</p>
</dd></dl>
</div>
<div class="section" id="module-swift.container.reconciler">
<span id="id5"></span><span id="container-reconciler"></span><h2>Container Reconciler<a class="headerlink" href="#module-swift.container.reconciler" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.reconciler.ContainerReconciler">
<em class="property">class </em><code class="descclassname">swift.container.reconciler.</code><code class="descname">ContainerReconciler</code><span class="sig-paren">(</span><em>conf</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">swift.common.daemon.Daemon</span></code></p>
<p>Move objects that are in the wrong storage policy.</p>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.ensure_object_in_right_location">
<code class="descname">ensure_object_in_right_location</code><span class="sig-paren">(</span><em>q_policy_index</em>, <em>account</em>, <em>container</em>, <em>obj</em>, <em>q_ts</em>, <em>path</em>, <em>container_policy_index</em>, <em>source_ts</em>, <em>source_obj_status</em>, <em>source_obj_info</em>, <em>source_obj_iter</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.ensure_object_in_right_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Validate source object will satisfy the misplaced object queue entry
and move to destination.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>q_policy_index</strong> – the policy_index for the source object</li>
<li><strong>account</strong> – the account name of the misplaced object</li>
<li><strong>container</strong> – the container name of the misplaced object</li>
<li><strong>obj</strong> – the name of the misplaced object</li>
<li><strong>q_ts</strong> – the timestamp of the misplaced object</li>
<li><strong>path</strong> – the full path of the misplaced object for logging</li>
<li><strong>container_policy_index</strong> – the policy_index of the destination</li>
<li><strong>source_ts</strong> – the timestamp of the source object</li>
<li><strong>source_obj_status</strong> – the HTTP status source object request</li>
<li><strong>source_obj_info</strong> – the HTTP headers of the source object request</li>
<li><strong>source_obj_iter</strong> – the body iter of the source object request</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.ensure_tombstone_in_right_location">
<code class="descname">ensure_tombstone_in_right_location</code><span class="sig-paren">(</span><em>q_policy_index</em>, <em>account</em>, <em>container</em>, <em>obj</em>, <em>q_ts</em>, <em>path</em>, <em>container_policy_index</em>, <em>source_ts</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.ensure_tombstone_in_right_location" title="Permalink to this definition">¶</a></dt>
<dd><p>Issue a DELETE request against the destination to match the
misplaced DELETE against the source.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.log_stats">
<code class="descname">log_stats</code><span class="sig-paren">(</span><em>force=False</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.log_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Dump stats to logger, noop when stats have been already been
logged in the last minute.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.pop_queue">
<code class="descname">pop_queue</code><span class="sig-paren">(</span><em>container</em>, <em>obj</em>, <em>q_ts</em>, <em>q_record</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.pop_queue" title="Permalink to this definition">¶</a></dt>
<dd><p>Issue a delete object request to the container for the misplaced
object queue entry.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>container</strong> – the misplaced objects container</li>
<li><strong>obj</strong> – the name of the misplaced object</li>
<li><strong>q_ts</strong> – the timestamp of the misplaced object</li>
<li><strong>q_record</strong> – the timestamp of the queue entry</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>N.B. q_ts will normally be the same time as q_record except when
an object was manually re-enqued.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.reconcile">
<code class="descname">reconcile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.reconcile" title="Permalink to this definition">¶</a></dt>
<dd><p>Main entry point for processing misplaced objects.</p>
<p>Iterate over all queue entries and delegate to reconcile_object.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.reconcile_object">
<code class="descname">reconcile_object</code><span class="sig-paren">(</span><em>info</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.reconcile_object" title="Permalink to this definition">¶</a></dt>
<dd><p>Process a possibly misplaced object write request. Determine correct
destination storage policy by checking with primary containers. Check
source and destination, copying or deleting into destination and
cleaning up the source as needed.</p>
<p>This method wraps _reconcile_object for exception handling.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>info</strong> – a queue entry dict</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True to indicate the request is fully processed
successfully, otherwise False.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.run_forever">
<code class="descname">run_forever</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.run_forever" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.run_once">
<code class="descname">run_once</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.run_once" title="Permalink to this definition">¶</a></dt>
<dd><p>Process every entry in the queue.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.stats_log">
<code class="descname">stats_log</code><span class="sig-paren">(</span><em>metric</em>, <em>msg</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.stats_log" title="Permalink to this definition">¶</a></dt>
<dd><p>Update stats tracking for metric and emit log message.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.reconciler.ContainerReconciler.throw_tombstones">
<code class="descname">throw_tombstones</code><span class="sig-paren">(</span><em>account</em>, <em>container</em>, <em>obj</em>, <em>timestamp</em>, <em>policy_index</em>, <em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.ContainerReconciler.throw_tombstones" title="Permalink to this definition">¶</a></dt>
<dd><p>Issue a delete object request to the given storage_policy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>account</strong> – the account name</li>
<li><strong>container</strong> – the container name</li>
<li><strong>obj</strong> – the object name</li>
<li><strong>timestamp</strong> – the timestamp of the object to delete</li>
<li><strong>policy_index</strong> – the policy index to direct the request</li>
<li><strong>path</strong> – the path to be used for logging</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.add_to_reconciler_queue">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">add_to_reconciler_queue</code><span class="sig-paren">(</span><em>container_ring</em>, <em>account</em>, <em>container</em>, <em>obj</em>, <em>obj_policy_index</em>, <em>obj_timestamp</em>, <em>op</em>, <em>force=False</em>, <em>conn_timeout=5</em>, <em>response_timeout=15</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.add_to_reconciler_queue" title="Permalink to this definition">¶</a></dt>
<dd><p>Add an object to the container reconciler’s queue. This will cause the
container reconciler to move it from its current storage policy index to
the correct storage policy index.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>container_ring</strong> – container ring</li>
<li><strong>account</strong> – the misplaced object’s account</li>
<li><strong>container</strong> – the misplaced object’s container</li>
<li><strong>obj</strong> – the misplaced object</li>
<li><strong>obj_policy_index</strong> – the policy index where the misplaced object
currently is</li>
<li><strong>obj_timestamp</strong> – the misplaced object’s X-Timestamp. We need this to
ensure that the reconciler doesn’t overwrite a newer
object with an older one.</li>
<li><strong>op</strong> – the method of the operation (DELETE or PUT)</li>
<li><strong>force</strong> – over-write queue entries newer than obj_timestamp</li>
<li><strong>conn_timeout</strong> – max time to wait for connection to container server</li>
<li><strong>response_timeout</strong> – max time to wait for response from container
server</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">.misplaced_object container name, False on failure. “Success”
means a majority of containers got the update.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.best_policy_index">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">best_policy_index</code><span class="sig-paren">(</span><em>headers</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.best_policy_index" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.cmp_policy_info">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">cmp_policy_info</code><span class="sig-paren">(</span><em>info</em>, <em>remote_info</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.cmp_policy_info" title="Permalink to this definition">¶</a></dt>
<dd><p>You have to squint to see it, but the general strategy is just:</p>
<dl class="docutils">
<dt>if either has been recreated:</dt>
<dd>return the newest (of the recreated)</dd>
<dt>else</dt>
<dd>return the oldest</dd>
</dl>
<p>I tried cleaning it up for awhile, but settled on just writing a bunch of
tests instead. Once you get an intuitive sense for the nuance here you
can try and see there’s a better way to spell the boolean logic but it all
ends up looking sorta hairy.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">-1 if info is correct, 1 if remote_info is better</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.direct_delete_container_entry">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">direct_delete_container_entry</code><span class="sig-paren">(</span><em>container_ring</em>, <em>account_name</em>, <em>container_name</em>, <em>object_name</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.direct_delete_container_entry" title="Permalink to this definition">¶</a></dt>
<dd><p>Talk directly to the primary container servers to delete a particular
object listing. Does not talk to object servers; use this only when a
container entry does not actually have a corresponding object.</p>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.get_reconciler_container_name">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">get_reconciler_container_name</code><span class="sig-paren">(</span><em>obj_timestamp</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.get_reconciler_container_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the name of a container into which a misplaced object should be
enqueued. The name is the object’s last modified time rounded down to the
nearest hour.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj_timestamp</strong> – a string representation of the object’s ‘created_at’
time from it’s container db row.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a container name</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.get_reconciler_content_type">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">get_reconciler_content_type</code><span class="sig-paren">(</span><em>op</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.get_reconciler_content_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.get_reconciler_obj_name">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">get_reconciler_obj_name</code><span class="sig-paren">(</span><em>policy_index</em>, <em>account</em>, <em>container</em>, <em>obj</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.get_reconciler_obj_name" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.get_row_to_q_entry_translator">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">get_row_to_q_entry_translator</code><span class="sig-paren">(</span><em>broker</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.get_row_to_q_entry_translator" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.incorrect_policy_index">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">incorrect_policy_index</code><span class="sig-paren">(</span><em>info</em>, <em>remote_info</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.incorrect_policy_index" title="Permalink to this definition">¶</a></dt>
<dd><p>Compare remote_info to info and decide if the remote storage policy index
should be used instead of ours.</p>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.parse_raw_obj">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">parse_raw_obj</code><span class="sig-paren">(</span><em>obj_info</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.parse_raw_obj" title="Permalink to this definition">¶</a></dt>
<dd><p>Translate a reconciler container listing entry to a dictionary
containing the parts of the misplaced object queue entry.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj_info</strong> – an entry in an a container listing with the
required keys: name, content_type, and hash</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a queue entry dict with the keys: q_policy_index, account,
container, obj, q_op, q_ts, q_record, and path</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.slightly_later_timestamp">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">slightly_later_timestamp</code><span class="sig-paren">(</span><em>ts</em>, <em>offset=1</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.slightly_later_timestamp" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="swift.container.reconciler.translate_container_headers_to_info">
<code class="descclassname">swift.container.reconciler.</code><code class="descname">translate_container_headers_to_info</code><span class="sig-paren">(</span><em>headers</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.reconciler.translate_container_headers_to_info" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-swift.container.replicator">
<span id="id6"></span><span id="container-replicator"></span><h2>Container Replicator<a class="headerlink" href="#module-swift.container.replicator" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.replicator.ContainerReplicator">
<em class="property">class </em><code class="descclassname">swift.container.replicator.</code><code class="descname">ContainerReplicator</code><span class="sig-paren">(</span><em>conf</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="db.html#swift.common.db_replicator.Replicator" title="swift.common.db_replicator.Replicator"><code class="xref py py-class docutils literal"><span class="pre">swift.common.db_replicator.Replicator</span></code></a></p>
<dl class="attribute">
<dt id="swift.container.replicator.ContainerReplicator.brokerclass">
<code class="descname">brokerclass</code><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.brokerclass" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="#swift.container.backend.ContainerBroker" title="swift.container.backend.ContainerBroker"><code class="xref py py-class docutils literal"><span class="pre">swift.container.backend.ContainerBroker</span></code></a></p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.replicator.ContainerReplicator.datadir">
<code class="descname">datadir</code><em class="property"> = 'containers'</em><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.datadir" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.replicator.ContainerReplicator.default_port">
<code class="descname">default_port</code><em class="property"> = 6201</em><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.default_port" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.delete_db">
<code class="descname">delete_db</code><span class="sig-paren">(</span><em>broker</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.delete_db" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure that reconciler databases are only cleaned up at the end of the
replication run.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.dump_to_reconciler">
<code class="descname">dump_to_reconciler</code><span class="sig-paren">(</span><em>broker</em>, <em>point</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.dump_to_reconciler" title="Permalink to this definition">¶</a></dt>
<dd><p>Look for object rows for objects updates in the wrong storage policy
in broker with a <code class="docutils literal"><span class="pre">ROWID</span></code> greater than the rowid given as point.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>broker</strong> – the container broker with misplaced objects</li>
<li><strong>point</strong> – the last verified <code class="docutils literal"><span class="pre">reconciler_sync_point</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the last successful enqueued rowid</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.feed_reconciler">
<code class="descname">feed_reconciler</code><span class="sig-paren">(</span><em>container</em>, <em>item_list</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.feed_reconciler" title="Permalink to this definition">¶</a></dt>
<dd><p>Add queue entries for rows in item_list to the local reconciler
container database.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>container</strong> – the name of the reconciler container</li>
<li><strong>item_list</strong> – the list of rows to enqueue</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True if successfully enqueued</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.find_local_handoff_for_part">
<code class="descname">find_local_handoff_for_part</code><span class="sig-paren">(</span><em>part</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.find_local_handoff_for_part" title="Permalink to this definition">¶</a></dt>
<dd><p>Look through devices in the ring for the first handoff device that was
identified during job creation as available on this node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a node entry from the ring</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.get_reconciler_broker">
<code class="descname">get_reconciler_broker</code><span class="sig-paren">(</span><em>timestamp</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.get_reconciler_broker" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a local instance of the reconciler container broker that is
appropriate to enqueue the given timestamp.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timestamp</strong> – the timestamp of the row to be enqueued</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a local reconciler broker</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.replicate_reconcilers">
<code class="descname">replicate_reconcilers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.replicate_reconcilers" title="Permalink to this definition">¶</a></dt>
<dd><p>Ensure any items merged to reconciler containers during replication
are pushed out to correct nodes and any reconciler containers that do
not belong on this node are removed.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.report_up_to_date">
<code class="descname">report_up_to_date</code><span class="sig-paren">(</span><em>full_info</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.report_up_to_date" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="swift.container.replicator.ContainerReplicator.run_once">
<code class="descname">run_once</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.run_once" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.replicator.ContainerReplicator.server_type">
<code class="descname">server_type</code><em class="property"> = 'container'</em><a class="headerlink" href="#swift.container.replicator.ContainerReplicator.server_type" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="swift.container.replicator.ContainerReplicatorRpc">
<em class="property">class </em><code class="descclassname">swift.container.replicator.</code><code class="descname">ContainerReplicatorRpc</code><span class="sig-paren">(</span><em>root</em>, <em>datadir</em>, <em>broker_class</em>, <em>mount_check=True</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.replicator.ContainerReplicatorRpc" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="db.html#swift.common.db_replicator.ReplicatorRpc" title="swift.common.db_replicator.ReplicatorRpc"><code class="xref py py-class docutils literal"><span class="pre">swift.common.db_replicator.ReplicatorRpc</span></code></a></p>
</dd></dl>
</div>
<div class="section" id="module-swift.container.sync">
<span id="container-sync"></span><span id="container-sync-daemon"></span><h2>Container Sync<a class="headerlink" href="#module-swift.container.sync" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.sync.ContainerSync">
<em class="property">class </em><code class="descclassname">swift.container.sync.</code><code class="descname">ContainerSync</code><span class="sig-paren">(</span><em>conf</em>, <em>container_ring=None</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">swift.common.daemon.Daemon</span></code></p>
<p>Daemon to sync syncable containers.</p>
<p>This is done by scanning the local devices for container databases and
checking for x-container-sync-to and x-container-sync-key metadata values.
If they exist, newer rows since the last sync will trigger PUTs or DELETEs
to the other container.</p>
<p>The actual syncing is slightly more complicated to make use of the three
(or number-of-replicas) main nodes for a container without each trying to
do the exact same work but also without missing work if one node happens to
be down.</p>
<p>Two sync points are kept per container database. All rows between the two
sync points trigger updates. Any rows newer than both sync points cause
updates depending on the node’s position for the container (primary nodes
do one third, etc. depending on the replica count of course). After a sync
run, the first sync point is set to the newest ROWID known and the second
sync point is set to newest ROWID for which all updates have been sent.</p>
<p>An example may help. Assume replica count is 3 and perfectly matching
ROWIDs starting at 1.</p>
<blockquote>
<div><p>First sync run, database has 6 rows:</p>
<blockquote>
<div><ul class="simple">
<li>SyncPoint1 starts as -1.</li>
<li>SyncPoint2 starts as -1.</li>
<li>No rows between points, so no “all updates” rows.</li>
<li>Six rows newer than SyncPoint1, so a third of the rows are sent
by node 1, another third by node 2, remaining third by node 3.</li>
<li>SyncPoint1 is set as 6 (the newest ROWID known).</li>
<li>SyncPoint2 is left as -1 since no “all updates” rows were synced.</li>
</ul>
</div></blockquote>
<p>Next sync run, database has 12 rows:</p>
<blockquote>
<div><ul class="simple">
<li>SyncPoint1 starts as 6.</li>
<li>SyncPoint2 starts as -1.</li>
<li>The rows between -1 and 6 all trigger updates (most of which
should short-circuit on the remote end as having already been
done).</li>
<li>Six more rows newer than SyncPoint1, so a third of the rows are
sent by node 1, another third by node 2, remaining third by node
3.</li>
<li>SyncPoint1 is set as 12 (the newest ROWID known).</li>
<li>SyncPoint2 is set as 6 (the newest “all updates” ROWID).</li>
</ul>
</div></blockquote>
</div></blockquote>
<p>In this way, under normal circumstances each node sends its share of
updates each run and just sends a batch of older updates to ensure nothing
was missed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>conf</strong> – The dict of configuration values from the [container-sync]
section of the container-server.conf</li>
<li><strong>container_ring</strong> – If None, the <swift_dir>/container.ring.gz will be
loaded. This is overridden by unit tests.</li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.allowed_sync_hosts">
<code class="descname">allowed_sync_hosts</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.allowed_sync_hosts" title="Permalink to this definition">¶</a></dt>
<dd><p>The list of hosts we’re allowed to send syncs to. This can be
overridden by data in self.realms_conf</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.conf">
<code class="descname">conf</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.conf" title="Permalink to this definition">¶</a></dt>
<dd><p>The dict of configuration values from the [container-sync] section
of the container-server.conf.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_deletes">
<code class="descname">container_deletes</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_deletes" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of successful DELETEs triggered.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_failures">
<code class="descname">container_failures</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_failures" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of containers that had a failure of some type.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_puts">
<code class="descname">container_puts</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_puts" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of successful PUTs triggered.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.container_report">
<code class="descname">container_report</code><span class="sig-paren">(</span><em>start</em>, <em>end</em>, <em>sync_point1</em>, <em>sync_point2</em>, <em>info</em>, <em>max_row</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.container_report" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_ring">
<code class="descname">container_ring</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_ring" title="Permalink to this definition">¶</a></dt>
<dd><p>swift.common.ring.Ring for locating containers.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_skips">
<code class="descname">container_skips</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_skips" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of containers whose sync has been turned off, but
are not yet cleared from the sync store.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_stats">
<code class="descname">container_stats</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Per container stats. These are collected per container.
puts - the number of puts that were done for the container
deletes - the number of deletes that were fot the container
bytes - the total number of bytes transferred per the container</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.container_sync">
<code class="descname">container_sync</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.container_sync" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks the given path for a container database, determines if syncing
is turned on for that database and, if so, sends any updates to the
other container.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – the path to a container db</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.container_sync_row">
<code class="descname">container_sync_row</code><span class="sig-paren">(</span><em>row</em>, <em>sync_to</em>, <em>user_key</em>, <em>broker</em>, <em>info</em>, <em>realm</em>, <em>realm_key</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.container_sync_row" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends the update the row indicates to the sync_to container.
Update can be either delete or put.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>row</strong> – The updated row in the local database triggering the sync
update.</li>
<li><strong>sync_to</strong> – The URL to the remote container.</li>
<li><strong>user_key</strong> – The X-Container-Sync-Key to use when sending requests
to the other container.</li>
<li><strong>broker</strong> – The local container database broker.</li>
<li><strong>info</strong> – The get_info result from the local container database
broker.</li>
<li><strong>realm</strong> – The realm from self.realms_conf, if there is one.
If None, fallback to using the older allowed_sync_hosts
way of syncing.</li>
<li><strong>realm_key</strong> – The realm key from self.realms_conf, if there
is one. If None, fallback to using the older
allowed_sync_hosts way of syncing.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">True on success</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_syncs">
<code class="descname">container_syncs</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_syncs" title="Permalink to this definition">¶</a></dt>
<dd><p>Number of containers with sync turned on that were successfully
synced.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.container_time">
<code class="descname">container_time</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.container_time" title="Permalink to this definition">¶</a></dt>
<dd><p>Maximum amount of time to spend syncing a container before moving on
to the next one. If a container sync hasn’t finished in this time,
it’ll just be resumed next scan.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.devices">
<code class="descname">devices</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.devices" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to the local device mount points.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.interval">
<code class="descname">interval</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.interval" title="Permalink to this definition">¶</a></dt>
<dd><p>Minimum time between full scans. This is to keep the daemon from
running wild on near empty systems.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.logger">
<code class="descname">logger</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.logger" title="Permalink to this definition">¶</a></dt>
<dd><p>Logger to use for container-sync log lines.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.mount_check">
<code class="descname">mount_check</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.mount_check" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates whether mount points should be verified as actual mount
points (normally true, false for tests and SAIO).</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.realms_conf">
<code class="descname">realms_conf</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.realms_conf" title="Permalink to this definition">¶</a></dt>
<dd><p>ContainerSyncCluster instance for validating sync-to values.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.report">
<code class="descname">report</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.report" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes a report of the stats to the logger and resets the stats for the
next report.</p>
</dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.reported">
<code class="descname">reported</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.reported" title="Permalink to this definition">¶</a></dt>
<dd><p>Time of last stats report.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.run_forever">
<code class="descname">run_forever</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.run_forever" title="Permalink to this definition">¶</a></dt>
<dd><p>Runs container sync scans until stopped.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.run_once">
<code class="descname">run_once</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.run_once" title="Permalink to this definition">¶</a></dt>
<dd><p>Runs a single container sync scan.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.sync.ContainerSync.select_http_proxy">
<code class="descname">select_http_proxy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.sync.ContainerSync.select_http_proxy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="swift.container.sync.ContainerSync.sync_store">
<code class="descname">sync_store</code><em class="property"> = None</em><a class="headerlink" href="#swift.container.sync.ContainerSync.sync_store" title="Permalink to this definition">¶</a></dt>
<dd><p>ContainerSyncStore instance for iterating over synced containers</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.sync.random">
<code class="descclassname">swift.container.sync.</code><code class="descname">random</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → x in the interval [0, 1).<a class="headerlink" href="#swift.container.sync.random" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="module-swift.container.updater">
<span id="id7"></span><span id="container-updater"></span><h2>Container Updater<a class="headerlink" href="#module-swift.container.updater" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="swift.container.updater.ContainerUpdater">
<em class="property">class </em><code class="descclassname">swift.container.updater.</code><code class="descname">ContainerUpdater</code><span class="sig-paren">(</span><em>conf</em>, <em>logger=None</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">swift.common.daemon.Daemon</span></code></p>
<p>Update container information in account listings.</p>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.container_report">
<code class="descname">container_report</code><span class="sig-paren">(</span><em>node</em>, <em>part</em>, <em>container</em>, <em>put_timestamp</em>, <em>delete_timestamp</em>, <em>count</em>, <em>bytes</em>, <em>storage_policy_index</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.container_report" title="Permalink to this definition">¶</a></dt>
<dd><p>Report container info to an account server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>node</strong> – node dictionary from the account ring</li>
<li><strong>part</strong> – partition the account is on</li>
<li><strong>container</strong> – container name</li>
<li><strong>put_timestamp</strong> – put timestamp</li>
<li><strong>delete_timestamp</strong> – delete timestamp</li>
<li><strong>count</strong> – object count in the container</li>
<li><strong>bytes</strong> – bytes used in the container</li>
<li><strong>storage_policy_index</strong> – the policy index for the container</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.container_sweep">
<code class="descname">container_sweep</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.container_sweep" title="Permalink to this definition">¶</a></dt>
<dd><p>Walk the path looking for container DBs and process them.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> – path to walk</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.get_account_ring">
<code class="descname">get_account_ring</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.get_account_ring" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the account ring. Load it if it hasn’t been yet.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.get_paths">
<code class="descname">get_paths</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.get_paths" title="Permalink to this definition">¶</a></dt>
<dd><p>Get paths to all of the partitions on each drive to be processed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a list of paths</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.process_container">
<code class="descname">process_container</code><span class="sig-paren">(</span><em>dbfile</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.process_container" title="Permalink to this definition">¶</a></dt>
<dd><p>Process a container, and update the information in the account.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dbfile</strong> – container DB to process</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.run_forever">
<code class="descname">run_forever</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.run_forever" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the updater continuously.</p>
</dd></dl>
<dl class="method">
<dt id="swift.container.updater.ContainerUpdater.run_once">
<code class="descname">run_once</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#swift.container.updater.ContainerUpdater.run_once" title="Permalink to this definition">¶</a></dt>
<dd><p>Run the updater once.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="swift.container.updater.random">
<code class="descclassname">swift.container.updater.</code><code class="descname">random</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → x in the interval [0, 1).<a class="headerlink" href="#swift.container.updater.random" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="docs-actions">
<a href="account.html"><i class="fa fa-angle-double-left" data-toggle="tooltip" data-placement="top" title="Previous: Account"></i></a>
<a href="db.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="Next: Account DB and Container DB"></i></a>
<a id="logABugLink3" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a>
</div>
<div class="row docs-byline bottom">
<div class="docs-updated">updated: 2018-02-14 14:24</div>
</div>
<div class="row">
<div class="col-lg-8 col-md-8 col-sm-8 docs-license">
<a href="https://creativecommons.org/licenses/by/3.0/">
<img src="_static/images/docs/license.png" alt="Creative Commons Attribution 3.0 License"/>
</a>
<p>
Except where otherwise noted, this document is licensed under
<a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>. See all <a href="http://www.openstack.org/legal">
OpenStack Legal Documents</a>.
</p>
</div>
<div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">
<!-- ID buglinkbottom added so that pre-filled doc bugs
are sent to Launchpad projects related to the
document -->
<a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a>
<a href="http://ask.openstack.org" class="docs-footer-actions"><i class="fa fa-question-circle"></i> questions?</a>
</div>
</div>
</div>
<div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar">
<div class="btn-group docs-sidebar-releases">
<button onclick="location.href='/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button>
<button href="#" type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button>
<ul class="dropdown-menu docs-sidebar-dropdown" role="menu" aria-labelledby="dLabel">
<li role="presentation" class="dropdown-header">Guides</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#install-guides">Install Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#user-guides">User Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#api-guides">API Guides</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li>
<li role="presentation" class="dropdown-header">Languages</li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/de/">Deutsch (German)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/fr/">Français (French)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/it/">Italiano (Italian)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ja/">日本語 (Japanese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="http://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li>
</ul>
</div>
<div class="docs-sidebar-toc">
<div class="docs-sidebar-section" id="table-of-contents">
<a href="index.html" class="docs-sidebar-section-title"><h4>Swift 2.17</h4></a>
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/object_api_v1_overview.html">Object Storage API overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_architecture.html">Swift Architectural Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_ring.html">The Rings</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_policies.html">Storage Policies</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_reaper.html">The Account Reaper</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_auth.html">The Auth System</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_acl.html">Access Control Lists (ACLs)</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_replication.html">Replication</a></li>
<li class="toctree-l1"><a class="reference internal" href="ratelimit.html">Rate Limiting</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_large_objects.html">Large Object Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_object_versioning.html">Object Versioning</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_global_cluster.html">Global Clusters</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_container_sync.html">Container to Container Synchronization</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_expiring_objects.html">Expiring Object Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="cors.html">CORS</a></li>
<li class="toctree-l1"><a class="reference internal" href="crossdomain.html">Cross-domain Policy File</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_erasure_code.html">Erasure Code Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_encryption.html">Object Encryption</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview_backing_store.html">Using Swift as Backing Store for Service Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="ring_background.html">Building a Consistent Hashing Ring</a></li>
<li class="toctree-l1"><a class="reference internal" href="ring_partpower.html">Modifying Ring Partition Power</a></li>
<li class="toctree-l1"><a class="reference internal" href="associated_projects.html">Associated Projects</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development_guidelines.html">Development Guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_saio.html">SAIO - Swift All In One</a></li>
<li class="toctree-l1"><a class="reference internal" href="first_contribution_swift.html">First Contribution to Swift</a></li>
<li class="toctree-l1"><a class="reference internal" href="policies_saio.html">Adding Storage Policies to an Existing SAIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_auth.html">Auth Server and Middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_middleware.html">Middleware and Metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_ondisk_backends.html">Pluggable On-Disk Back-end APIs</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="howto_installmultinode.html">Instructions for a Multiple Server Swift Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment_guide.html">Deployment Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_deployment_guide.html">Apache Deployment Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin_guide.html">Administrator’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="replication_network.html">Dedicated replication network</a></li>
<li class="toctree-l1"><a class="reference internal" href="logs.html">Logs</a></li>
<li class="toctree-l1"><a class="reference internal" href="ops_runbook/index.html">Swift Ops Runbook</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/index.html">OpenStack Swift Administrator Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="install/index.html">Object Storage Install Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api/object_api_v1_overview.html">Object Storage API overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/discoverability.html">Discoverability</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/authentication.html">Authentication</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/container_quotas.html">Container quotas</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/object_versioning.html">Object versioning</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/large_objects.html">Large objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/temporary_url_middleware.html">Temporary URL middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/form_post_middleware.html">Form POST middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/use_content-encoding_metadata.html">Use Content-Encoding metadata</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/use_the_content-disposition_metadata.html">Use the Content-Disposition metadata</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="ring.html">Partitioned Consistent Hash Ring</a></li>
<li class="toctree-l1"><a class="reference internal" href="proxy.html">Proxy</a></li>
<li class="toctree-l1"><a class="reference internal" href="account.html">Account</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Container</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.auditor">Container Auditor</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.backend">Container Backend</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.server">Container Server</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.reconciler">Container Reconciler</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.replicator">Container Replicator</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.sync">Container Sync</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-swift.container.updater">Container Updater</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="db.html">Account DB and Container DB</a></li>
<li class="toctree-l1"><a class="reference internal" href="object.html">Object</a></li>
<li class="toctree-l1"><a class="reference internal" href="misc.html">Misc</a></li>
<li class="toctree-l1"><a class="reference internal" href="middleware.html">Middleware</a></li>
</ul>
</div>
<div class="docs-sidebar-toc">
<div class="docs-sidebar-section" id="local-table-of-contents">
<h4 class="docs-sidebar-section-title">Page Contents</h4>
<ul>
<li><a class="reference internal" href="#">Container</a><ul>
<li><a class="reference internal" href="#module-swift.container.auditor">Container Auditor</a></li>
<li><a class="reference internal" href="#module-swift.container.backend">Container Backend</a></li>
<li><a class="reference internal" href="#module-swift.container.server">Container Server</a></li>
<li><a class="reference internal" href="#module-swift.container.reconciler">Container Reconciler</a></li>
<li><a class="reference internal" href="#module-swift.container.replicator">Container Replicator</a></li>
<li><a class="reference internal" href="#module-swift.container.sync">Container Sync</a></li>
<li><a class="reference internal" href="#module-swift.container.updater">Container Updater</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row footer-links">
<div class="col-lg-2 col-sm-2">
<h3>OpenStack</h3>
<ul>
<li><a href="http://openstack.org/projects/">Projects</a></li>
<li><a href="http://openstack.org/projects/openstack-security/">OpenStack Security</a></li>
<li><a href="http://openstack.org/projects/openstack-faq/">Common Questions</a></li>
<li><a href="http://openstack.org/blog/">Blog</a></li>
<li><a href="http://openstack.org/news/">News</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Community</h3>
<ul>
<li><a href="http://openstack.org/community/">User Groups</a></li>
<li><a href="http://openstack.org/community/events/">Events</a></li>
<li><a href="http://openstack.org/community/jobs/">Jobs</a></li>
<li><a href="http://openstack.org/foundation/companies/">Companies</a></li>
<li><a href="http://docs.openstack.org/infra/manual/developers.html">Contribute</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Documentation</h3>
<ul>
<li><a href="http://docs.openstack.org">OpenStack Manuals</a></li>
<li><a href="http://openstack.org/software/start/">Getting Started</a></li>
<li><a href="http://developer.openstack.org">API Documentation</a></li>
<li><a href="https://wiki.openstack.org">Wiki</a></li>
</ul>
</div>
<div class="col-lg-2 col-sm-2">
<h3>Branding & Legal</h3>
<ul>
<li><a href="http://openstack.org/brand/">Logos & Guidelines</a></li>
<li><a href="http://openstack.org/brand/openstack-trademark-policy/">Trademark Policy</a></li>
<li><a href="http://openstack.org/privacy/">Privacy Policy</a></li>
<li><a href="https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement">OpenStack CLA</a></li>
</ul>
</div>
<div class="col-lg-4 col-sm-4">
<h3>Stay In Touch</h3>
<a href="https://twitter.com/OpenStack" target="_blank" class="social-icons footer-twitter"></a>
<a href="https://www.facebook.com/openstack" target="_blank" class="social-icons footer-facebook"></a>
<a href="https://www.linkedin.com/company/openstack" target="_blank" class="social-icons footer-linkedin"></a>
<a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a>
<p class="fine-print">
The OpenStack project is provided under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Openstack.org is powered by
<a href="http://rackspace.com" target="_blank">Rackspace Cloud Computing</a>.
</p>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script type="text/javascript" src="_static/js/jquery-3.2.1.min.js"></script>
<!-- Bootstrap JavaScript -->
<script type="text/javascript" src="_static/js/bootstrap.min.js"></script>
<!-- The rest of the JS -->
<script type="text/javascript" src="_static/js/navigation.js"></script>
<!-- Docs JS -->
<script type="text/javascript" src="_static/js/docs.js"></script>
<!-- Popovers -->
<script type="text/javascript" src="_static/js/webui-popover.js"></script>
<!-- standard sphinx include libraries, which allow search highlighting -->
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.17',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
SOURCELINK_SUFFIX: '.txt',
HAS_SOURCE: true
};
</script>
<!-- Javascript for page -->
<script language="JavaScript">
/* build a description of this page including SHA, source location on git repo,
build time and the project's launchpad bug tag. Set the HREF of the bug
buttons */
var lineFeed = "%0A";
var gitURL = "Source: Can't derive source file URL";
/* there have been cases where "pagename" wasn't set; better check for it */
/* The URL of the source file on Git is based on the giturl variable
in conf.py, which must be manually initialized to the source file
URL in Git.
"pagename" is a standard sphinx parameter containing the name of
the source file, without extension. */
var sourceFile = "container" + ".rst";
gitURL = "Source: https://git.openstack.org/cgit/openstack/swift/tree/doc/source" + "/" + sourceFile;
/* gitsha, project and bug_tag rely on variables in conf.py */
var gitSha = "SHA: unknown";
var bugProject = "swift";
var bugTitle = "Container in Swift";
var fieldTags = "";
var useStoryboard = "";
/* "last_updated" is the build date and time. It relies on the
conf.py variable "html_last_updated_fmt", which should include
year/month/day as well as hours and minutes */
var buildstring = "Release: 2.17.0 on 2018-02-14 14:24";
var fieldComment = encodeURI(buildstring) +
lineFeed + encodeURI(gitSha) +
lineFeed + encodeURI(gitURL) ;
logABug(bugTitle, bugProject, fieldComment, fieldTags);
</script>
</body>
</html>
|