Patroni

Contents:

  • Introduction
  • Installation
  • Patroni configuration
  • Patroni REST API
  • patronictl
  • Replica imaging and bootstrap
  • Replication modes
  • Standby cluster
  • Watchdog support
  • Pause/Resume mode for the cluster
  • DCS Failsafe Mode
  • Using Patroni with Kubernetes
  • Citus support
  • Convert a Standalone to a Patroni Cluster
  • Major Upgrade of PostgreSQL Version
  • Integration with other tools
  • Security Considerations
  • HA multi datacenter
  • FAQ
  • Release notes
  • Contributing
    • Contributing guidelines
    • Patroni API docs
      • patroni package
        • Subpackages
        • Submodules
        • Module contents
Patroni
  • Contributing
  • patroni
  • patroni package
  • patroni.scripts package
  • Edit on GitHub

patroni.scripts package

Subpackages

  • patroni.scripts.barman package
    • Submodules
      • patroni.scripts.barman.cli module
        • ExitCode
        • main()
      • patroni.scripts.barman.config_switch module
        • ExitCode
        • _should_skip_switch()
        • _switch_config()
        • run_barman_config_switch()
      • patroni.scripts.barman.recover module
        • ExitCode
        • _restore_backup()
        • run_barman_recover()
      • patroni.scripts.barman.utils module
        • ApiNotOk
        • OperationStatus
        • PgBackupApi
        • RetriesExceeded
        • retry()
        • set_up_logging()
    • Module contents

Submodules

  • patroni.scripts.aws module
    • AWSConnection
      • AWSConnection.__init__()
      • AWSConnection._tag_ebs()
      • AWSConnection._tag_ec2()
      • AWSConnection.aws_available()
      • AWSConnection.on_role_change()
      • AWSConnection.retry()
    • main()
  • patroni.scripts.wale_restore module
    • ExitCode
      • ExitCode.FAIL
      • ExitCode.RETRY_LATER
      • ExitCode.SUCCESS
    • WALEConfig
      • WALEConfig._asdict()
      • WALEConfig._field_defaults
      • WALEConfig._fields
      • WALEConfig._make()
      • WALEConfig._replace()
      • WALEConfig.cmd
      • WALEConfig.env_dir
      • WALEConfig.threshold_mb
      • WALEConfig.threshold_pct
    • WALERestore
      • WALERestore.__init__()
      • WALERestore.create_replica_with_s3()
      • WALERestore.fix_subdirectory_path_if_broken()
      • WALERestore.run()
      • WALERestore.should_use_s3_to_create_replica()
    • get_major_version()
    • main()
    • repr_size()
    • size_as_bytes()

Module contents

Previous Next

© Copyright 2025 Compose, Zalando SE, Patroni Contributors.

Built with Sphinx using a theme provided by Read the Docs.