popoto.backends.postgres.pubsub¶
popoto.backends.postgres.pubsub
¶
Pub/sub on Postgres: PUBLISH as pg_notify, SUBSCRIBE as
LISTEN (#759 M5).
One notification channel per schema (popoto_pubsub_<digest>) carries
every popoto channel: the payload names the channel and carries the message,
and each subscriber keeps what its subscriptions match. So a channel name is
not bound by Postgres's 63-byte identifier limit, and pattern subscriptions
(PSUBSCRIBE) are matched client-side, with Redis's glob rules
(*, ?, [...], [^...], \ escapes) translated to a regular
expression and matched byte-wise, as Redis's stringmatchlen matches
(:func:glob_match). The cost: every subscriber of the schema receives every
message and drops what it did not ask for.
Each payload starts with a per-publish nonce, stripped before delivery: Postgres folds identical notifications sent in one transaction into one, so without it a message published twice in a transaction would arrive once.
NOTIFY is transactional: a message published inside the backend's unit
of work (pipeline=uow) is delivered when that transaction commits and
never if it rolls back -- the Postgres reading of "publish atomically with the
save". It is also bounded: a payload must be shorter than 8000 bytes. The
message travels base64-encoded beside the channel name, so a message of
roughly 5.9 KB is the most one notification holds; a larger one is refused
with :class:PubSubPayloadTooLarge before anything is sent, rather than
split (a split message could be half-delivered to a subscriber that joins
between its parts). Publish a key and keep the body in a record.
publish returns the number of live subscriptions the message reaches,
like PUBLISH: each subscriber registers its subscriptions in
popoto_pubsub_listener under its session's backend pid, and the count
keeps the rows whose pid is a live session (pg_stat_activity). A
subscriber that closes deletes its rows; one that dies leaves rows that stop
counting when its session ends and are swept by the next subscriber to
connect. The LISTEN session is never pooled (ยง3 Topology): every
subscriber in a process shares one per DSN (:mod:.listen, #799), and it
must reach the same server as the backend's DSN.
NOTIFY_PAYLOAD_LIMIT = 8000
module-attribute
¶
Postgres's NOTIFY payload must be shorter than this many bytes (the
server's default build).
PubSubPayloadTooLarge
¶
Bases: PublisherException, ValueError
A message too large for one NOTIFY on the Postgres backend.
PostgresPubSub
¶
redis-py's PubSub on the process's shared LISTEN session.
subscribe/psubscribe/unsubscribe/punsubscribe,
get_message(ignore_subscribe_messages=, timeout=) (0.0 polls,
None waits), listen() and close(), with the same message
dicts (type, pattern, channel, data; bytes values).
A subscription is live when the call returns.
Every subscriber in a process shares one session per DSN
(:mod:.listen, #799): each is a sink on the schema's channel, attached
on its first subscription and detached when it has none left. If the
session drops it is reopened at once, re-LISTEN\ s and re-registers
every subscription under its new pid; messages published while it was
down are lost, as on a Redis reconnect.
Source code in src/popoto/backends/postgres/pubsub.py
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 | |
pid
property
¶
The shared session's server pid this subscriber's
popoto_pubsub_listener rows are registered under.
dropped
property
¶
Messages discarded unread because this subscriber fell behind
(Defaults.PG_LISTEN_QUEUE_MAX_MESSAGES /
PG_LISTEN_QUEUE_MAX_BYTES). The process-wide total is the
shared session's hub.dropped.
queued_bytes
property
¶
Payload bytes received but not yet read.
glob_to_regex(pattern)
¶
Redis's stringmatchlen glob as a regular expression body that
means the same in Python re (with DOTALL) and in Postgres's
~; the caller anchors it. * any run, ? one character,
[abc]/[^abc]/[a-z] a class, \x a literal x.
Redis matches bytes. To mean what it means on a non-ASCII channel,
translate and match the byte forms (:func:as_bytes_text: UTF-8,
then each byte as one character) -- then ? and [^...] consume
one byte, and a range compares bytes as stringmatchlen does (as
signed char, :func:_range_items). :func:glob_match does both.
Source code in src/popoto/backends/postgres/pubsub.py
as_bytes_text(value)
¶
value's UTF-8 bytes, one character per byte (latin-1): the
form a glob and a channel are matched in, so the match is byte-wise like
Redis's. Every byte maps to a character Postgres text can hold
(U+0001..U+00FF; a channel has no NUL).
Source code in src/popoto/backends/postgres/pubsub.py
glob_match(pattern, channel)
¶
Whether channel matches the PSUBSCRIBE glob pattern as
Redis's stringmatchlen decides it, byte for byte.
Source code in src/popoto/backends/postgres/pubsub.py
publish(backend, channel, message, *, uow=None)
¶
PUBLISH channel message on backend: see the module docstring.