patroni.postgresql.postmaster module

Bases: Process

__init__ ( pid : int ) → None View on GitHub

classmethod _from_pidfile ( data_dir : str ) → PostmasterProcess | None View on GitHub

_is_postmaster_process ( ) → bool View on GitHub

static _read_postmaster_pidfile ( data_dir : str ) → Dict [ str , str ] View on GitHub

Reads and parses postmaster.pid from the data directory

:returns dictionary of values if successful, empty dictionary otherwise

classmethod from_pid ( pid : int ) → PostmasterProcess | None View on GitHub

static from_pidfile ( data_dir : str ) → PostmasterProcess | None View on GitHub

pg_ctl_kill ( mode : str , pg_ctl : str ) → bool | None View on GitHub

signal_kill ( ) → bool View on GitHub

to suspend and kill postmaster and all children

:returns True if postmaster and children are killed, False if error

signal_stop ( mode : str , pg_ctl : str = 'pg_ctl' ) → bool | None View on GitHub

Signal postmaster process to stop

:returns None if signaled, True if process is already gone, False if error

static start ( pgcommand : str , data_dir : str , conf : str , options : List [ str ] ) → PostmasterProcess | None View on GitHub

wait_for_user_backends_to_close ( stop_timeout : float | None ) → bool | None View on GitHub

Wait for all user backend processes to close before the postmaster shuts down.

Auxiliary/background PostgreSQL processes (archiver, checkpointer, wal senders, logical replication workers, and so on) are identified via their command line and excluded, so that only genuine client backends are awaited.

Parameters :

stop_timeout – maximum number of seconds to wait for the user backends to close. If None , wait indefinitely.

Returns :

True if there were no user backends or all of them closed in time; None if the list of children could not be retrieved or some backends were still alive after stop_timeout .