/usr/share/doc/python3-postgresql/html/_modules/postgresql/cluster.html is in python3-postgresql 1.1.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>postgresql.cluster — py-postgresql 1.1.0 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="py-postgresql 1.1.0 documentation" href="../../index.html" />
<link rel="up" title="postgresql" href="../postgresql.html" />
<link rel="stylesheet" href="_static/unsuck.css" type="text/css" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">py-postgresql 1.1.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../postgresql.html" accesskey="U">postgresql</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for postgresql.cluster</h1><div class="highlight"><pre>
<span class="c">##</span>
<span class="c"># .cluster - PostgreSQL cluster management</span>
<span class="c">##</span>
<span class="sd">"""</span>
<span class="sd">Create, control, and destroy PostgreSQL clusters.</span>
<span class="sd">postgresql.cluster provides a programmer's interface to controlling a PostgreSQL</span>
<span class="sd">cluster. It provides direct access to proper signalling interfaces.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">errno</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">import</span> <span class="nn">subprocess</span> <span class="kn">as</span> <span class="nn">sp</span>
<span class="kn">from</span> <span class="nn">tempfile</span> <span class="kn">import</span> <span class="n">NamedTemporaryFile</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">api</span> <span class="k">as</span> <span class="n">pg_api</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">configfile</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">installation</span> <span class="k">as</span> <span class="n">pg_inn</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">exceptions</span> <span class="k">as</span> <span class="n">pg_exc</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">driver</span> <span class="k">as</span> <span class="n">pg_driver</span>
<span class="kn">from</span> <span class="nn">.encodings.aliases</span> <span class="kn">import</span> <span class="n">get_python_name</span>
<span class="kn">from</span> <span class="nn">.python.os</span> <span class="kn">import</span> <span class="n">close_fds</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">platform</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'win32'</span><span class="p">,</span> <span class="s">'win64'</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">.port</span> <span class="kn">import</span> <span class="n">signal1_msw</span> <span class="k">as</span> <span class="n">signal</span>
<span class="n">pg_kill</span> <span class="o">=</span> <span class="n">signal</span><span class="o">.</span><span class="n">kill</span>
<span class="k">def</span> <span class="nf">namedtemp</span><span class="p">(</span><span class="n">encoding</span><span class="p">):</span>
<span class="k">return</span> <span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">delete</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">mode</span> <span class="o">=</span> <span class="s">'w'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">signal</span>
<span class="n">pg_kill</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">kill</span>
<span class="k">def</span> <span class="nf">namedtemp</span><span class="p">(</span><span class="n">encoding</span><span class="p">):</span>
<span class="k">return</span> <span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">mode</span> <span class="o">=</span> <span class="s">'w'</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="n">encoding</span><span class="p">)</span>
<div class="viewcode-block" id="ClusterError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterError">[docs]</a><span class="k">class</span> <span class="nc">ClusterError</span><span class="p">(</span><span class="n">pg_exc</span><span class="o">.</span><span class="n">Error</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> General cluster error.</span>
<span class="sd"> """</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-C000'</span>
<span class="n">source</span> <span class="o">=</span> <span class="s">'CLUSTER'</span></div>
<div class="viewcode-block" id="ClusterInitializationError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterInitializationError">[docs]</a><span class="k">class</span> <span class="nc">ClusterInitializationError</span><span class="p">(</span><span class="n">ClusterError</span><span class="p">):</span>
<span class="s">"General cluster initialization failure"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cini'</span></div>
<div class="viewcode-block" id="InitDBError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.InitDBError">[docs]</a><span class="k">class</span> <span class="nc">InitDBError</span><span class="p">(</span><span class="n">ClusterInitializationError</span><span class="p">):</span>
<span class="s">"A non-zero result was returned by the initdb command"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cidb'</span></div>
<div class="viewcode-block" id="ClusterStartupError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterStartupError">[docs]</a><span class="k">class</span> <span class="nc">ClusterStartupError</span><span class="p">(</span><span class="n">ClusterError</span><span class="p">):</span>
<span class="s">"Cluster startup failed"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cbot'</span></div>
<div class="viewcode-block" id="ClusterNotRunningError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterNotRunningError">[docs]</a><span class="k">class</span> <span class="nc">ClusterNotRunningError</span><span class="p">(</span><span class="n">ClusterError</span><span class="p">):</span>
<span class="s">"Cluster is not running"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cdwn'</span></div>
<div class="viewcode-block" id="ClusterTimeoutError"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterTimeoutError">[docs]</a><span class="k">class</span> <span class="nc">ClusterTimeoutError</span><span class="p">(</span><span class="n">ClusterError</span><span class="p">):</span>
<span class="s">"Cluster operation timed out"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cout'</span>
</div>
<div class="viewcode-block" id="ClusterWarning"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.ClusterWarning">[docs]</a><span class="k">class</span> <span class="nc">ClusterWarning</span><span class="p">(</span><span class="n">pg_exc</span><span class="o">.</span><span class="n">Warning</span><span class="p">):</span>
<span class="s">"Warning issued by cluster operations"</span>
<span class="n">code</span> <span class="o">=</span> <span class="s">'-Cwrn'</span>
<span class="n">source</span> <span class="o">=</span> <span class="s">'CLUSTER'</span>
</div>
<span class="n">DEFAULT_CLUSTER_ENCODING</span> <span class="o">=</span> <span class="s">'utf-8'</span>
<span class="n">DEFAULT_CONFIG_FILENAME</span> <span class="o">=</span> <span class="s">'postgresql.conf'</span>
<span class="n">DEFAULT_HBA_FILENAME</span> <span class="o">=</span> <span class="s">'pg_hba.conf'</span>
<span class="n">DEFAULT_PID_FILENAME</span> <span class="o">=</span> <span class="s">'postmaster.pid'</span>
<span class="n">initdb_option_map</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'encoding'</span> <span class="p">:</span> <span class="s">'-E'</span><span class="p">,</span>
<span class="s">'authentication'</span> <span class="p">:</span> <span class="s">'-A'</span><span class="p">,</span>
<span class="s">'user'</span> <span class="p">:</span> <span class="s">'-U'</span><span class="p">,</span>
<span class="c"># pwprompt is not supported.</span>
<span class="c"># interactive use should be implemented by the application</span>
<span class="c"># calling Cluster.init()</span>
<span class="p">}</span>
<div class="viewcode-block" id="Cluster"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster">[docs]</a><span class="k">class</span> <span class="nc">Cluster</span><span class="p">(</span><span class="n">pg_api</span><span class="o">.</span><span class="n">Cluster</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Interface to a PostgreSQL cluster.</span>
<span class="sd"> Provides mechanisms to start, stop, restart, kill, drop, and initalize a</span>
<span class="sd"> cluster(data directory).</span>
<span class="sd"> Cluster does not strive to be consistent with ``pg_ctl``. This is considered</span>
<span class="sd"> to be a base class for managing a cluster, and is intended to be extended to</span>
<span class="sd"> accommodate for a particular purpose.</span>
<span class="sd"> """</span>
<span class="n">driver</span> <span class="o">=</span> <span class="n">pg_driver</span><span class="o">.</span><span class="n">default</span>
<span class="n">installation</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">data_directory</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">DEFAULT_CLUSTER_ENCODING</span> <span class="o">=</span> <span class="n">DEFAULT_CLUSTER_ENCODING</span>
<span class="n">DEFAULT_CONFIG_FILENAME</span> <span class="o">=</span> <span class="n">DEFAULT_CONFIG_FILENAME</span>
<span class="n">DEFAULT_PID_FILENAME</span> <span class="o">=</span> <span class="n">DEFAULT_PID_FILENAME</span>
<span class="n">DEFAULT_HBA_FILENAME</span> <span class="o">=</span> <span class="n">DEFAULT_HBA_FILENAME</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">return</span> <span class="s">'running'</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'void'</span>
<span class="k">return</span> <span class="s">'stopped'</span>
<span class="k">def</span> <span class="nf">_e_metas</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span>
<span class="k">yield</span> <span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="s">'['</span> <span class="o">+</span> <span class="n">state</span> <span class="o">+</span> <span class="s">']'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">state</span> <span class="o">==</span> <span class="s">'running'</span><span class="p">:</span>
<span class="k">yield</span> <span class="p">(</span><span class="s">'pid'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">state</span><span class="p">)</span>
<span class="nd">@property</span>
<div class="viewcode-block" id="Cluster.daemon_path"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.daemon_path">[docs]</a> <span class="k">def</span> <span class="nf">daemon_path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Path to the executable to use to startup the cluster.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="o">.</span><span class="n">postmaster</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="o">.</span><span class="n">postgres</span>
</div>
<div class="viewcode-block" id="Cluster.get_pid_from_file"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.get_pid_from_file">[docs]</a> <span class="k">def</span> <span class="nf">get_pid_from_file</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The current pid from the postmaster.pid file.</span>
<span class="sd"> """</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">DEFAULT_PID_FILENAME</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">readline</span><span class="p">())</span>
<span class="k">except</span> <span class="ne">IOError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="ow">in</span> <span class="p">(</span><span class="n">errno</span><span class="o">.</span><span class="n">EIO</span><span class="p">,</span> <span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">None</span>
</div>
<span class="nd">@property</span>
<div class="viewcode-block" id="Cluster.pid"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.pid">[docs]</a> <span class="k">def</span> <span class="nf">pid</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> If we have the subprocess, use the pid on the object.</span>
<span class="sd"> """</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_pid_from_file</span><span class="p">()</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span>
<span class="k">if</span> <span class="n">d</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">d</span><span class="o">.</span><span class="n">pid</span>
<span class="k">return</span> <span class="n">pid</span>
</div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">settings</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'_settings'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_settings</span> <span class="o">=</span> <span class="n">configfile</span><span class="o">.</span><span class="n">ConfigFile</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pgsql_dot_conf</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_settings</span>
<span class="nd">@property</span>
<div class="viewcode-block" id="Cluster.hba_file"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.hba_file">[docs]</a> <span class="k">def</span> <span class="nf">hba_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">join</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The path to the HBA file of the cluster.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s">'hba_file'</span><span class="p">,</span>
<span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">DEFAULT_HBA_FILENAME</span><span class="p">)</span>
<span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">installation</span> <span class="p">:</span> <span class="s">"installation object"</span><span class="p">,</span>
<span class="n">data_directory</span> <span class="p">:</span> <span class="s">"path to the data directory"</span><span class="p">,</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">installation</span> <span class="o">=</span> <span class="n">installation</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">data_directory</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">pgsql_dot_conf</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">DEFAULT_CONFIG_FILENAME</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">daemon_command</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">format</span> <span class="o">=</span> <span class="s">"{mod}.{name}({ins!r}, {dir!r})"</span><span class="o">.</span><span class="n">format</span><span class="p">):</span>
<span class="k">return</span> <span class="n">format</span><span class="p">(</span>
<span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__module__</span><span class="p">,</span>
<span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Start the cluster and wait for it to startup.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_started</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">typ</span><span class="p">,</span> <span class="n">val</span><span class="p">,</span> <span class="n">tb</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Stop the cluster and wait for it to shutdown.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_stopped</span><span class="p">()</span>
<div class="viewcode-block" id="Cluster.init"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.init">[docs]</a> <span class="k">def</span> <span class="nf">init</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">password</span> <span class="p">:</span> \
<span class="s">"Password to assign to the "</span> \
<span class="s">"cluster's superuser(`user` keyword)."</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
<span class="o">**</span><span class="n">kw</span>
<span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create the cluster at the given `data_directory` using the</span>
<span class="sd"> provided keyword parameters as options to the command.</span>
<span class="sd"> `command_option_map` provides the mapping of keyword arguments</span>
<span class="sd"> to command options.</span>
<span class="sd"> """</span>
<span class="n">initdb</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="o">.</span><span class="n">initdb</span>
<span class="k">if</span> <span class="n">initdb</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">initdb</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="o">.</span><span class="n">pg_ctl</span><span class="p">,</span> <span class="s">'initdb'</span><span class="p">,)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">initdb</span> <span class="o">=</span> <span class="p">(</span><span class="n">initdb</span><span class="p">,)</span>
<span class="k">if</span> <span class="bp">None</span> <span class="ow">in</span> <span class="n">initdb</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ClusterInitializationError</span><span class="p">(</span>
<span class="s">"unable to find executable for cluster initialization"</span><span class="p">,</span>
<span class="n">details</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'detail'</span> <span class="p">:</span> <span class="s">"The installation does not have 'initdb' or 'pg_ctl'."</span><span class="p">,</span>
<span class="p">},</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="c"># Transform keyword options into command options for the executable.</span>
<span class="c"># A default is used rather than looking at the environment to, well,</span>
<span class="c"># avoid looking at the environment.</span>
<span class="n">kw</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s">'encoding'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">DEFAULT_CLUSTER_ENCODING</span><span class="p">)</span>
<span class="n">opts</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">kw</span><span class="p">:</span>
<span class="k">if</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">(</span><span class="s">'logfile'</span><span class="p">,</span> <span class="s">'extra_arguments'</span><span class="p">):</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">x</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">initdb_option_map</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s">"got an unexpected keyword argument </span><span class="si">%r</span><span class="s">"</span> <span class="o">%</span><span class="p">(</span><span class="n">x</span><span class="p">,))</span>
<span class="n">opts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">initdb_option_map</span><span class="p">[</span><span class="n">x</span><span class="p">])</span>
<span class="n">opts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">kw</span><span class="p">[</span><span class="n">x</span><span class="p">])</span>
<span class="n">logfile</span> <span class="o">=</span> <span class="n">kw</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'logfile'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">sp</span><span class="o">.</span><span class="n">PIPE</span>
<span class="n">extra_args</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">([</span>
<span class="nb">str</span><span class="p">(</span><span class="n">x</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">kw</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'extra_arguments'</span><span class="p">,</span> <span class="p">())</span>
<span class="p">])</span>
<span class="n">supw_file</span> <span class="o">=</span> <span class="p">()</span>
<span class="n">supw_tmp</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">p</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">password</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># got a superuserpass, store it in a tempfile for initdb</span>
<span class="n">supw_tmp</span> <span class="o">=</span> <span class="n">namedtemp</span><span class="p">(</span><span class="n">encoding</span> <span class="o">=</span> <span class="n">get_python_name</span><span class="p">(</span><span class="n">kw</span><span class="p">[</span><span class="s">'encoding'</span><span class="p">]))</span>
<span class="n">supw_tmp</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">password</span><span class="p">)</span>
<span class="n">supw_tmp</span><span class="o">.</span><span class="n">flush</span><span class="p">()</span>
<span class="n">supw_file</span> <span class="o">=</span> <span class="p">(</span><span class="s">'--pwfile='</span> <span class="o">+</span> <span class="n">supw_tmp</span><span class="o">.</span><span class="n">name</span><span class="p">,)</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="n">initdb</span> <span class="o">+</span> <span class="p">(</span><span class="s">'-D'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">)</span> \
<span class="o">+</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">opts</span><span class="p">)</span> \
<span class="o">+</span> <span class="n">supw_file</span> \
<span class="o">+</span> <span class="n">extra_args</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span>
<span class="n">cmd</span><span class="p">,</span>
<span class="n">close_fds</span> <span class="o">=</span> <span class="n">close_fds</span><span class="p">,</span>
<span class="n">bufsize</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">5</span><span class="p">,</span> <span class="c"># not expecting this to ever be filled.</span>
<span class="n">stdin</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="n">stdout</span> <span class="o">=</span> <span class="n">logfile</span><span class="p">,</span>
<span class="c"># stderr is used to identify a reasonable error message.</span>
<span class="n">stderr</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="p">)</span>
<span class="c"># stdin is not used; it is not desirable for initdb to be attached.</span>
<span class="n">p</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">rc</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span>
<span class="k">break</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">EINTR</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">stdout</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">p</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="n">rc</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="c"># initdb returned non-zero, pickup stderr and attach to exception.</span>
<span class="n">r</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">stderr</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">r</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'utf-8'</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">UnicodeDecodeError</span><span class="p">:</span>
<span class="c"># split up the lines, and use rep.</span>
<span class="n">msg</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">linesep</span><span class="o">.</span><span class="n">join</span><span class="p">([</span>
<span class="nb">repr</span><span class="p">(</span><span class="n">x</span><span class="p">)[</span><span class="mi">2</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">r</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()</span>
<span class="p">])</span>
<span class="k">raise</span> <span class="n">InitDBError</span><span class="p">(</span>
<span class="s">"initdb exited with non-zero status"</span><span class="p">,</span>
<span class="n">details</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'command'</span><span class="p">:</span> <span class="n">cmd</span><span class="p">,</span>
<span class="s">'stderr'</span><span class="p">:</span> <span class="n">msg</span><span class="p">,</span>
<span class="s">'stdout'</span><span class="p">:</span> <span class="n">msg</span><span class="p">,</span>
<span class="p">},</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="k">if</span> <span class="n">p</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">stderr</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">stdin</span><span class="p">,</span> <span class="n">p</span><span class="o">.</span><span class="n">stdout</span><span class="p">):</span>
<span class="k">if</span> <span class="n">x</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">x</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">if</span> <span class="n">supw_tmp</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">n</span> <span class="o">=</span> <span class="n">supw_tmp</span><span class="o">.</span><span class="n">name</span>
<span class="n">supw_tmp</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="c"># XXX: win32 compensation.</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">unlink</span><span class="p">(</span><span class="n">n</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Cluster.drop"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.drop">[docs]</a> <span class="k">def</span> <span class="nf">drop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Stop the cluster and remove it from the filesystem</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_stopped</span><span class="p">()</span>
<span class="k">except</span> <span class="n">ClusterTimeoutError</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">kill</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_stopped</span><span class="p">()</span>
<span class="k">except</span> <span class="n">ClusterTimeoutError</span><span class="p">:</span>
<span class="n">ClusterWarning</span><span class="p">(</span>
<span class="s">'cluster failed to shutdown after kill'</span><span class="p">,</span>
<span class="n">details</span> <span class="o">=</span> <span class="p">{</span><span class="s">'hint'</span> <span class="p">:</span> <span class="s">'Shared memory may have been leaked.'</span><span class="p">},</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span><span class="o">.</span><span class="n">emit</span><span class="p">()</span>
<span class="c"># Really, using rm -rf would be the best, but use this for portability.</span>
<span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">dirs</span><span class="p">,</span> <span class="n">files</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span> <span class="n">topdown</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">files</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="k">for</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">dirs</span><span class="p">:</span>
<span class="n">os</span><span class="o">.</span><span class="n">rmdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">name</span><span class="p">))</span>
<span class="n">os</span><span class="o">.</span><span class="n">rmdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Cluster.start"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">logfile</span> <span class="p">:</span> <span class="s">"Where to send stderr"</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span>
<span class="n">settings</span> <span class="p">:</span> <span class="s">"Mapping of runtime parameters"</span> <span class="o">=</span> <span class="bp">None</span>
<span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Start the cluster.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">return</span>
<span class="n">cmd</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">daemon_path</span><span class="p">,</span> <span class="s">'-D'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">)</span>
<span class="k">if</span> <span class="n">settings</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span><span class="p">,</span><span class="n">v</span> <span class="ow">in</span> <span class="nb">dict</span><span class="p">(</span><span class="n">settings</span><span class="p">)</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">cmd</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'--{k}={v}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">k</span><span class="o">=</span><span class="n">k</span><span class="p">,</span><span class="n">v</span><span class="o">=</span><span class="n">v</span><span class="p">))</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">Popen</span><span class="p">(</span>
<span class="n">cmd</span><span class="p">,</span>
<span class="n">close_fds</span> <span class="o">=</span> <span class="n">close_fds</span><span class="p">,</span>
<span class="n">bufsize</span> <span class="o">=</span> <span class="mi">1024</span><span class="p">,</span>
<span class="c"># send everything to logfile</span>
<span class="n">stdout</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">PIPE</span> <span class="k">if</span> <span class="n">logfile</span> <span class="ow">is</span> <span class="bp">None</span> <span class="k">else</span> <span class="n">logfile</span><span class="p">,</span>
<span class="n">stderr</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">,</span>
<span class="n">stdin</span> <span class="o">=</span> <span class="n">sp</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">logfile</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">p</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="n">p</span><span class="o">.</span><span class="n">stdin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="o">=</span> <span class="n">p</span>
<span class="bp">self</span><span class="o">.</span><span class="n">daemon_command</span> <span class="o">=</span> <span class="n">cmd</span>
</div>
<div class="viewcode-block" id="Cluster.restart"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.restart">[docs]</a> <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">logfile</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">settings</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">timeout</span> <span class="o">=</span> <span class="mi">10</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Restart the cluster gracefully.</span>
<span class="sd"> This provides a higher level interface to stopping then starting the</span>
<span class="sd"> cluster. It will perform the wait operations and block until the</span>
<span class="sd"> restart is complete.</span>
<span class="sd"> If waiting is not desired, .start() and .stop() should be used directly.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="bp">self</span><span class="o">.</span><span class="n">stop</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_stopped</span><span class="p">(</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">ClusterError</span><span class="p">(</span>
<span class="s">"failed to shutdown cluster"</span><span class="p">,</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="n">logfile</span> <span class="o">=</span> <span class="n">logfile</span><span class="p">,</span> <span class="n">settings</span> <span class="o">=</span> <span class="n">settings</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_started</span><span class="p">(</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Cluster.reload"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.reload">[docs]</a> <span class="k">def</span> <span class="nf">reload</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Signal the cluster to reload its configuration file.</span>
<span class="sd"> """</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pid</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pg_kill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGHUP</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">ESRCH</span><span class="p">:</span>
<span class="k">raise</span>
</div>
<div class="viewcode-block" id="Cluster.stop"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Stop the cluster gracefully waiting for clients to disconnect(SIGTERM).</span>
<span class="sd"> """</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pid</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pg_kill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGTERM</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">ESRCH</span><span class="p">:</span>
<span class="k">raise</span>
</div>
<div class="viewcode-block" id="Cluster.shutdown"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.shutdown">[docs]</a> <span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Shutdown the cluster as soon as possible, disconnecting clients.</span>
<span class="sd"> """</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pid</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pg_kill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGINT</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">ESRCH</span><span class="p">:</span>
<span class="k">raise</span>
</div>
<div class="viewcode-block" id="Cluster.kill"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.kill">[docs]</a> <span class="k">def</span> <span class="nf">kill</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Stop the cluster immediately(SIGKILL).</span>
<span class="sd"> Does *not* wait for shutdown.</span>
<span class="sd"> """</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pid</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pg_kill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIGKILL</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">ESRCH</span><span class="p">:</span>
<span class="k">raise</span>
<span class="c"># already dead, so it would seem.</span>
</div>
<div class="viewcode-block" id="Cluster.initialized"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.initialized">[docs]</a> <span class="k">def</span> <span class="nf">initialized</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Whether or not the data directory *appears* to be a valid cluster.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">)</span> <span class="ow">and</span> \
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">pgsql_dot_conf</span><span class="p">)</span> <span class="ow">and</span> \
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">data_directory</span><span class="p">,</span> <span class="s">'base'</span><span class="p">)):</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">return</span> <span class="bp">False</span>
</div>
<div class="viewcode-block" id="Cluster.running"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.running">[docs]</a> <span class="k">def</span> <span class="nf">running</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Whether or not the postmaster is running.</span>
<span class="sd"> This does *not* mean the cluster is accepting connections.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">r</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span>
<span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_pid_from_file</span><span class="p">()</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># daemon process does not exist, but there's a pidfile.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">pid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_pid_from_file</span><span class="p">()</span>
<span class="k">if</span> <span class="n">pid</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">pg_kill</span><span class="p">(</span><span class="n">pid</span><span class="p">,</span> <span class="n">signal</span><span class="o">.</span><span class="n">SIG_DFL</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">!=</span> <span class="n">errno</span><span class="o">.</span><span class="n">ESRCH</span><span class="p">:</span>
<span class="k">raise</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="Cluster.connector"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.connector">[docs]</a> <span class="k">def</span> <span class="nf">connector</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a postgresql.driver connector based on the given keywords and</span>
<span class="sd"> listen_addresses and port configuration in settings.</span>
<span class="sd"> """</span>
<span class="n">host</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">address</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">host</span> <span class="ow">or</span> <span class="s">'localhost'</span><span class="p">,</span>
<span class="n">port</span> <span class="o">=</span> <span class="n">port</span> <span class="ow">or</span> <span class="mi">5432</span><span class="p">,</span>
<span class="o">**</span><span class="n">kw</span>
<span class="p">)</span>
</div>
<div class="viewcode-block" id="Cluster.connection"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.connection">[docs]</a> <span class="k">def</span> <span class="nf">connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a connection object to the cluster, but do not connect.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">connector</span><span class="p">(</span><span class="o">**</span><span class="n">kw</span><span class="p">)()</span>
</div>
<div class="viewcode-block" id="Cluster.connect"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.connect">[docs]</a> <span class="k">def</span> <span class="nf">connect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create an established connection from the connector.</span>
<span class="sd"> Cluster must be running.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">ClusterNotRunningError</span><span class="p">(</span>
<span class="s">"cannot connect if cluster is not running"</span><span class="p">,</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="n">x</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="p">(</span><span class="o">**</span><span class="n">kw</span><span class="p">)</span>
<span class="n">x</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="k">return</span> <span class="n">x</span>
</div>
<div class="viewcode-block" id="Cluster.address"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.address">[docs]</a> <span class="k">def</span> <span class="nf">address</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Get the host-port pair from the configuration.</span>
<span class="sd"> """</span>
<span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">getset</span><span class="p">((</span>
<span class="s">'listen_addresses'</span><span class="p">,</span> <span class="s">'port'</span><span class="p">,</span>
<span class="p">))</span>
<span class="k">if</span> <span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'listen_addresses'</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="c"># Prefer localhost over other addresses.</span>
<span class="c"># More likely to get a successful connection.</span>
<span class="n">addrs</span> <span class="o">=</span> <span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'listen_addresses'</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">)</span>
<span class="k">if</span> <span class="s">'localhost'</span> <span class="ow">in</span> <span class="n">addrs</span> <span class="ow">or</span> <span class="s">'*'</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
<span class="n">host</span> <span class="o">=</span> <span class="s">'localhost'</span>
<span class="k">elif</span> <span class="s">'127.0.0.1'</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
<span class="n">host</span> <span class="o">=</span> <span class="s">'127.0.0.1'</span>
<span class="k">elif</span> <span class="s">'::1'</span> <span class="ow">in</span> <span class="n">addrs</span><span class="p">:</span>
<span class="n">host</span> <span class="o">=</span> <span class="s">'::1'</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">addrs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">host</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">return</span> <span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">d</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'port'</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="Cluster.ready_for_connections"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.ready_for_connections">[docs]</a> <span class="k">def</span> <span class="nf">ready_for_connections</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> If the daemon is running, and is not in startup mode.</span>
<span class="sd"> This only works for clusters configured for TCP/IP connections.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="n">e</span> <span class="o">=</span> <span class="bp">None</span>
<span class="n">host</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">address</span><span class="p">()</span>
<span class="n">connection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span>
<span class="n">user</span> <span class="o">=</span> <span class="s">' -*- ping -*- '</span><span class="p">,</span>
<span class="n">host</span> <span class="o">=</span> <span class="n">host</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="n">port</span><span class="p">,</span>
<span class="n">database</span> <span class="o">=</span> <span class="s">'template1'</span><span class="p">,</span>
<span class="n">sslmode</span> <span class="o">=</span> <span class="s">'disable'</span><span class="p">,</span>
<span class="p">)()</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">connection</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span>
<span class="k">except</span> <span class="n">pg_exc</span><span class="o">.</span><span class="n">ClientCannotConnectError</span> <span class="k">as</span> <span class="n">err</span><span class="p">:</span>
<span class="k">for</span> <span class="n">attempt</span> <span class="ow">in</span> <span class="n">err</span><span class="o">.</span><span class="n">database</span><span class="o">.</span><span class="n">failures</span><span class="p">:</span>
<span class="n">x</span> <span class="o">=</span> <span class="n">attempt</span><span class="o">.</span><span class="n">error</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">installation</span><span class="o">.</span><span class="n">version_info</span><span class="p">[:</span><span class="mi">2</span><span class="p">]</span> <span class="o"><</span> <span class="p">(</span><span class="mi">8</span><span class="p">,</span><span class="mi">1</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="p">(</span>
<span class="n">pg_exc</span><span class="o">.</span><span class="n">UndefinedObjectError</span><span class="p">,</span>
<span class="n">pg_exc</span><span class="o">.</span><span class="n">AuthenticationSpecificationError</span><span class="p">,</span>
<span class="p">)):</span>
<span class="c"># undefined user.. whatever...</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">pg_exc</span><span class="o">.</span><span class="n">AuthenticationSpecificationError</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="c"># configuration file error. ya, that's probably not going to change.</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="p">(</span><span class="n">pg_exc</span><span class="o">.</span><span class="n">CFError</span><span class="p">,</span> <span class="n">pg_exc</span><span class="o">.</span><span class="n">ProtocolError</span><span class="p">)):</span>
<span class="k">raise</span> <span class="n">x</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">pg_exc</span><span class="o">.</span><span class="n">ServerNotReadyError</span><span class="p">):</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">x</span>
<span class="k">break</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">err</span>
<span class="c"># the else true means we successfully connected with those</span>
<span class="c"># credentials... strange, but true..</span>
<span class="k">return</span> <span class="n">e</span> <span class="k">if</span> <span class="n">e</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="k">else</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="Cluster.wait_until_started"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.wait_until_started">[docs]</a> <span class="k">def</span> <span class="nf">wait_until_started</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">timeout</span> <span class="p">:</span> <span class="s">"how long to wait before throwing a timeout exception"</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
<span class="n">delay</span> <span class="p">:</span> <span class="s">"how long to sleep before re-testing"</span> <span class="o">=</span> <span class="mf">0.05</span><span class="p">,</span>
<span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> After the `start` method is used, this can be ran in order to block</span>
<span class="sd"> until the cluster is ready for use.</span>
<span class="sd"> This method loops until `ready_for_connections` returns `True` in</span>
<span class="sd"> order to make sure that the cluster is actually up.</span>
<span class="sd"> """</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">checkpoint</span> <span class="o">=</span> <span class="n">start</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">():</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">r</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span><span class="o">.</span><span class="n">returncode</span>
<span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ClusterStartupError</span><span class="p">(</span>
<span class="s">"postgres daemon terminated"</span><span class="p">,</span>
<span class="n">details</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'RESULT'</span> <span class="p">:</span> <span class="n">r</span><span class="p">,</span>
<span class="s">'COMMAND'</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_command</span><span class="p">,</span>
<span class="p">},</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ClusterNotRunningError</span><span class="p">(</span>
<span class="s">"postgres daemon has not been started"</span><span class="p">,</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="n">r</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">ready_for_connections</span><span class="p">()</span>
<span class="n">checkpoint</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="bp">True</span><span class="p">:</span>
<span class="k">break</span>
<span class="k">if</span> <span class="n">checkpoint</span> <span class="o">-</span> <span class="n">start</span> <span class="o">>=</span> <span class="n">timeout</span><span class="p">:</span>
<span class="c"># timeout was reached, but raise ServerNotReadyError</span>
<span class="c"># to signal to the user that it was *not* due to some unknown</span>
<span class="c"># condition, rather it's *still* starting up.</span>
<span class="k">if</span> <span class="n">r</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">r</span><span class="p">,</span> <span class="n">pg_exc</span><span class="o">.</span><span class="n">ServerNotReadyError</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">r</span>
<span class="n">e</span> <span class="o">=</span> <span class="n">ClusterTimeoutError</span><span class="p">(</span>
<span class="s">'timeout on startup'</span><span class="p">,</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">r</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span><span class="bp">True</span><span class="p">,</span><span class="bp">False</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">e</span> <span class="kn">from</span> <span class="nn">r</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Cluster.wait_until_stopped"><a class="viewcode-back" href="../../reference.html#postgresql.cluster.Cluster.wait_until_stopped">[docs]</a> <span class="k">def</span> <span class="nf">wait_until_stopped</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">timeout</span> <span class="p">:</span> <span class="s">"how long to wait before throwing a timeout exception"</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
<span class="n">delay</span> <span class="p">:</span> <span class="s">"how long to sleep before re-testing"</span> <span class="o">=</span> <span class="mf">0.05</span>
<span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> After the `stop` method is used, this can be ran in order to block until</span>
<span class="sd"> the cluster is shutdown.</span>
<span class="sd"> Additionally, catching `ClusterTimeoutError` exceptions would be a</span>
<span class="sd"> starting point for making decisions about whether or not to issue a kill</span>
<span class="sd"> to the daemon.</span>
<span class="sd"> """</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="k">while</span> <span class="bp">self</span><span class="o">.</span><span class="n">running</span><span class="p">()</span> <span class="ow">is</span> <span class="bp">True</span><span class="p">:</span>
<span class="c"># pickup the exit code.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_exit_code</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">daemon_process</span><span class="o">.</span><span class="n">poll</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_exit_code</span> <span class="o">=</span> <span class="n">pg_kill</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">get_pid_from_file</span><span class="p">(),</span> <span class="mi">0</span><span class="p">)</span>
<span class="k">if</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</span> <span class="o">-</span> <span class="n">start</span> <span class="o">>=</span> <span class="n">timeout</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ClusterTimeoutError</span><span class="p">(</span>
<span class="s">'timeout on shutdown'</span><span class="p">,</span>
<span class="n">creator</span> <span class="o">=</span> <span class="bp">self</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">delay</span><span class="p">)</span>
<span class="c">##</span>
<span class="c"># vim: ts=3:sw=3:noet:</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">py-postgresql 1.1.0 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
<li><a href="../postgresql.html" >postgresql</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright Python+Postgres.
Last updated on Mar 31, 2014.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|