barman package

Subpackages

• barman.clients package
  • Submodules
    • barman.clients.cloud_backup module
      • __is_hook_script()
      • _find_space()
      • _validate_config()
      • build_conninfo()
      • main()
      • parse_arguments()
      • quote_conninfo()
    • barman.clients.cloud_backup_delete module
      • _delete_backup()
      • _get_files_for_backup()
      • _remove_wals_for_backup()
      • main()
      • parse_arguments()
    • barman.clients.cloud_backup_keep module
      • main()
      • parse_arguments()
    • barman.clients.cloud_backup_list module
      • main()
      • parse_arguments()
    • barman.clients.cloud_backup_show module
      • main()
      • parse_arguments()
    • barman.clients.cloud_check_wal_archive module
      • main()
      • parse_arguments()
    • barman.clients.cloud_cli module
      • CLIErrorExit
      • CloudArgumentParser
      • GeneralErrorExit
      • NetworkErrorExit
      • OperationErrorExit
      • UrlArgumentType
      • __parse_tag()
      • add_tag_argument()
      • create_argument_parser()
      • get_missing_attrs()
    • barman.clients.cloud_compression module
      • ChunkedCompressor
      • SnappyCompressor
      • _try_import_snappy()
      • compress()
      • decompress_to_file()
      • get_compressor()
      • get_streaming_tar_mode()
    • barman.clients.cloud_restore module
      • CloudBackupDownloader
      • CloudBackupDownloaderObjectStore
      • CloudBackupDownloaderSnapshot
      • _validate_config()
      • main()
      • parse_arguments()
      • tablespace_map()
    • barman.clients.cloud_walarchive module
      • CloudWalUploader
      • __is_hook_script()
      • main()
      • parse_arguments()
    • barman.clients.cloud_walrestore module
      • CloudWalDownloader
      • main()
      • parse_arguments()
    • barman.clients.walarchive module
      • ChecksumTarFile
      • ChecksumTarInfo
      • RemotePutWal
      • build_ssh_command()
      • connectivity_test()
      • exit_with_error()
      • hashCopyfileobj()
      • main()
      • parse_arguments()
    • barman.clients.walrestore module
      • RemoteGetWal
      • build_ssh_command()
      • connectivity_test()
      • execute_peek()
      • exit_with_error()
      • main()
      • parse_arguments()
      • peek_additional_files()
      • spawn_additional_process()
      • try_deliver_from_spool()
  • Module contents
• barman.cloud_providers package
  • Submodules
    • barman.cloud_providers.aws_s3 module
    • barman.cloud_providers.azure_blob_storage module
    • barman.cloud_providers.google_cloud_storage module
  • Module contents
    • CloudProviderOptionUnsupported
    • CloudProviderUnsupported
    • _get_azure_credential()
    • _make_azure_cloud_interface()
    • _make_google_cloud_interface()
    • _make_s3_cloud_interface()
    • _update_kwargs()
    • get_cloud_interface()
    • get_snapshot_interface()
    • get_snapshot_interface_from_backup_info()
    • get_snapshot_interface_from_server_config()
    • snapshots_info_from_dict()
• barman.storage package
  • Submodules
    • barman.storage.file_manager module
      • FileManager
    • barman.storage.file_stats module
      • FileStats
    • barman.storage.local_file_manager module
      • LocalFileManager
  • Module contents

Submodules

• barman.annotations module
  • AnnotationManager
    • AnnotationManager._abc_impl
    • AnnotationManager.delete_annotation()
    • AnnotationManager.get_annotation()
    • AnnotationManager.put_annotation()
  • AnnotationManagerCloud
    • AnnotationManagerCloud.__init__()
    • AnnotationManagerCloud._abc_impl
    • AnnotationManagerCloud._get_annotation_path()
    • AnnotationManagerCloud._get_base_path()
    • AnnotationManagerCloud._populate_annotation_cache()
    • AnnotationManagerCloud.delete_annotation()
    • AnnotationManagerCloud.get_annotation()
    • AnnotationManagerCloud.put_annotation()
  • AnnotationManagerFile
    • AnnotationManagerFile.__init__()
    • AnnotationManagerFile._abc_impl
    • AnnotationManagerFile._get_annotation_path()
    • AnnotationManagerFile.delete_annotation()
    • AnnotationManagerFile.get_annotation()
    • AnnotationManagerFile.put_annotation()
  • KeepManager
    • KeepManager.ANNOTATION_KEY
    • KeepManager.TARGET_FULL
    • KeepManager.TARGET_STANDALONE
    • KeepManager._abc_impl
    • KeepManager.get_keep_target()
    • KeepManager.keep_backup()
    • KeepManager.release_keep()
    • KeepManager.should_keep_backup()
    • KeepManager.supported_targets
  • KeepManagerMixin
    • KeepManagerMixin.__init__()
    • KeepManagerMixin._abc_impl
    • KeepManagerMixin.get_keep_target()
    • KeepManagerMixin.keep_backup()
    • KeepManagerMixin.release_keep()
    • KeepManagerMixin.should_keep_backup()
  • KeepManagerMixinCloud
    • KeepManagerMixinCloud._abc_impl
    • KeepManagerMixinCloud.get_keep_target()
    • KeepManagerMixinCloud.should_keep_backup()
• barman.backup module
  • BackupManager
    • BackupManager.DEFAULT_STATUS_FILTER
    • BackupManager.DELETE_ANNOTATION
    • BackupManager.__init__()
    • BackupManager._abc_impl
    • BackupManager._load_backup_cache()
    • BackupManager._set_backup_sizes()
    • BackupManager._validate_incremental_backup_configs()
    • BackupManager.archive_wal()
    • BackupManager.backup()
    • BackupManager.backup_cache_add()
    • BackupManager.backup_cache_remove()
    • BackupManager.backup_fsync_and_set_sizes()
    • BackupManager.check()
    • BackupManager.check_backup()
    • BackupManager.check_delete_annotation()
    • BackupManager.cron_retention_policy()
    • BackupManager.delete_backup()
    • BackupManager.delete_backup_data()
    • BackupManager.delete_basebackup()
    • BackupManager.delete_wal()
    • BackupManager.fetch_remote_status()
    • BackupManager.find_next_backup_in()
    • BackupManager.find_previous_backup_in()
    • BackupManager.get_available_backups()
    • BackupManager.get_backup()
    • BackupManager.get_backup_id_from_name()
    • BackupManager.get_first_backup_id()
    • BackupManager.get_last_backup_id()
    • BackupManager.get_last_full_backup_id()
    • BackupManager.get_latest_archived_wals_info()
    • BackupManager.get_next_backup()
    • BackupManager.get_previous_backup()
    • BackupManager.get_timelines_to_protect()
    • BackupManager.mode
    • BackupManager.put_delete_annotation()
    • BackupManager.rebuild_xlogdb()
    • BackupManager.recover()
    • BackupManager.release_delete_annotation()
    • BackupManager.remove_wal_before_backup()
    • BackupManager.should_remove_wals()
    • BackupManager.status()
    • BackupManager.validate_backup_args()
    • BackupManager.validate_last_backup_maximum_age()
    • BackupManager.validate_last_backup_min_size()
    • BackupManager.verify_backup()
• barman.backup_executor module
  • BackupExecutor
    • BackupExecutor.__init__()
    • BackupExecutor._abc_impl
    • BackupExecutor._purge_unused_wal_files()
    • BackupExecutor._start_backup_copy_message()
    • BackupExecutor._stop_backup_copy_message()
    • BackupExecutor.backup()
    • BackupExecutor.check()
    • BackupExecutor.fetch_remote_status()
    • BackupExecutor.init()
    • BackupExecutor.mode
    • BackupExecutor.status()
  • BackupStrategy
    • BackupStrategy.START_TIME_RE
    • BackupStrategy.WAL_RE
    • BackupStrategy.__init__()
    • BackupStrategy._abc_impl
    • BackupStrategy._backup_info_from_backup_label()
    • BackupStrategy._backup_info_from_start_location()
    • BackupStrategy._backup_info_from_stop_location()
    • BackupStrategy._pg_get_metadata()
    • BackupStrategy._read_backup_label()
    • BackupStrategy.check()
    • BackupStrategy.start_backup()
    • BackupStrategy.status()
    • BackupStrategy.stop_backup()
  • ConcurrentBackupStrategy
    • ConcurrentBackupStrategy.__init__()
    • ConcurrentBackupStrategy._abc_impl
    • ConcurrentBackupStrategy._concurrent_start_backup()
    • ConcurrentBackupStrategy._concurrent_stop_backup()
    • ConcurrentBackupStrategy.check()
    • ConcurrentBackupStrategy.start_backup()
    • ConcurrentBackupStrategy.stop_backup()
  • ExclusiveBackupStrategy
    • ExclusiveBackupStrategy.__init__()
    • ExclusiveBackupStrategy._abc_impl
    • ExclusiveBackupStrategy.check()
    • ExclusiveBackupStrategy.start_backup()
    • ExclusiveBackupStrategy.stop_backup()
  • ExternalBackupExecutor
    • ExternalBackupExecutor.__init__()
    • ExternalBackupExecutor._abc_impl
    • ExternalBackupExecutor._local_check()
    • ExternalBackupExecutor._remote_check()
    • ExternalBackupExecutor._update_action_from_strategy()
    • ExternalBackupExecutor.backup()
    • ExternalBackupExecutor.backup_copy()
    • ExternalBackupExecutor.check()
    • ExternalBackupExecutor.fetch_remote_status()
    • ExternalBackupExecutor.status()
  • LocalConcurrentBackupStrategy
    • LocalConcurrentBackupStrategy._abc_impl
    • LocalConcurrentBackupStrategy._write_backup_label()
    • LocalConcurrentBackupStrategy.stop_backup()
  • PassiveBackupExecutor
    • PassiveBackupExecutor.__init__()
    • PassiveBackupExecutor._abc_impl
    • PassiveBackupExecutor.backup()
    • PassiveBackupExecutor.check()
    • PassiveBackupExecutor.mode
    • PassiveBackupExecutor.status()
  • PostgresBackupExecutor
    • PostgresBackupExecutor.__init__()
    • PostgresBackupExecutor._abc_impl
    • PostgresBackupExecutor._err_handler()
    • PostgresBackupExecutor._prepare_backup_destination()
    • PostgresBackupExecutor._retry_handler()
    • PostgresBackupExecutor._start_backup_copy_message()
    • PostgresBackupExecutor._validate_compression()
    • PostgresBackupExecutor.backup()
    • PostgresBackupExecutor.backup_copy()
    • PostgresBackupExecutor.check()
    • PostgresBackupExecutor.fetch_remote_status()
    • PostgresBackupExecutor.validate_configuration()
  • PostgresBackupStrategy
    • PostgresBackupStrategy.__init__()
    • PostgresBackupStrategy._abc_impl
    • PostgresBackupStrategy._read_backup_label()
    • PostgresBackupStrategy._read_compressed_backup_label()
    • PostgresBackupStrategy.check()
    • PostgresBackupStrategy.start_backup()
    • PostgresBackupStrategy.stop_backup()
  • RsyncBackupExecutor
    • RsyncBackupExecutor.__init__()
    • RsyncBackupExecutor._abc_impl
    • RsyncBackupExecutor._format_src()
    • RsyncBackupExecutor._reuse_path()
    • RsyncBackupExecutor._start_backup_copy_message()
    • RsyncBackupExecutor.backup()
    • RsyncBackupExecutor.backup_copy()
    • RsyncBackupExecutor.validate_configuration()
  • SnapshotBackupExecutor
    • SnapshotBackupExecutor.__init__()
    • SnapshotBackupExecutor._abc_impl
    • SnapshotBackupExecutor._start_backup_copy_message()
    • SnapshotBackupExecutor._stop_backup_copy_message()
    • SnapshotBackupExecutor._validate_aws_lock_configuration()
    • SnapshotBackupExecutor.add_mount_data_to_volume_metadata()
    • SnapshotBackupExecutor.backup_copy()
    • SnapshotBackupExecutor.check()
    • SnapshotBackupExecutor.find_missing_and_unmounted_disks()
    • SnapshotBackupExecutor.validate_configuration()
  • _parse_ssh_command()
• barman.backup_manifest module
  • BackupManifest
    • BackupManifest.__init__()
    • BackupManifest._create_files_metadata()
    • BackupManifest._get_manifest_file_path()
    • BackupManifest._get_manifest_from_dict()
    • BackupManifest._get_manifest_str()
    • BackupManifest.create_backup_manifest()
    • BackupManifest.name
  • FileIdentity
    • FileIdentity.__init__()
    • FileIdentity._get_checksum()
    • FileIdentity._get_relative_path()
    • FileIdentity.get_value()
• barman.cli module
  • OrderedHelpFormatter
    • OrderedHelpFormatter._format_usage()
  • archive_wal()
  • argument()
  • backup()
  • backup_completer()
  • check()
  • check_backup()
  • check_target_action()
  • check_wal_archive()
  • command()
  • config_switch()
  • config_update()
  • cron()
  • delete()
  • diagnose()
  • generate_manifest()
  • get_model()
  • get_models_list()
  • get_server()
  • get_server_list()
  • get_wal()
  • global_config()
  • help()
  • keep()
  • list_backups()
  • list_files()
  • list_servers()
  • lock_directory_cleanup()
  • main()
  • manage_model_command()
  • manage_server_command()
  • parse_backup_id()
  • pretty_args()
  • put_wal()
  • rebuild_xlogdb()
  • receive_wal()
  • replication_status()
  • restore()
  • server_completer()
  • server_completer_all()
  • show_backup()
  • show_servers()
  • status()
  • switch_wal()
  • sync_backup()
  • sync_info()
  • sync_wals()
  • verify_backup()
• barman.cloud module
  • BackupFileInfo
    • BackupFileInfo.__init__()
  • CloudBackup
    • CloudBackup.__init__()
    • CloudBackup._abc_impl
    • CloudBackup._add_stats_to_backup_info()
    • CloudBackup._check_postgres_version()
    • CloudBackup._coordinate_backup()
    • CloudBackup._create_restore_point()
    • CloudBackup._finalise_copy()
    • CloudBackup._get_backup_info()
    • CloudBackup._log_end_of_backup()
    • CloudBackup._start_backup()
    • CloudBackup._stop_backup()
    • CloudBackup._take_backup()
    • CloudBackup._upload_backup_info()
    • CloudBackup._upload_backup_label()
    • CloudBackup.backup()
    • CloudBackup.handle_backup_errors()
  • CloudBackupCatalog
    • CloudBackupCatalog.__init__()
    • CloudBackupCatalog._abc_impl
    • CloudBackupCatalog._get_backup_info_from_name()
    • CloudBackupCatalog.get_backup_files()
    • CloudBackupCatalog.get_backup_info()
    • CloudBackupCatalog.get_backup_list()
    • CloudBackupCatalog.get_wal_paths()
    • CloudBackupCatalog.get_wal_prefixes()
    • CloudBackupCatalog.parse_backup_id()
    • CloudBackupCatalog.remove_backup_from_cache()
    • CloudBackupCatalog.remove_wal_from_cache()
  • CloudBackupSnapshot
    • CloudBackupSnapshot.__init__()
    • CloudBackupSnapshot._abc_impl
    • CloudBackupSnapshot._add_stats_to_backup_info()
    • CloudBackupSnapshot._check_backup_preconditions()
    • CloudBackupSnapshot._finalise_copy()
    • CloudBackupSnapshot._take_backup()
    • CloudBackupSnapshot._upload_backup_label()
    • CloudBackupSnapshot.backup()
  • CloudBackupUploader
    • CloudBackupUploader.__init__()
    • CloudBackupUploader._abc_impl
    • CloudBackupUploader._add_stats_to_backup_info()
    • CloudBackupUploader._backup_config_files()
    • CloudBackupUploader._backup_data_files()
    • CloudBackupUploader._create_upload_controller()
    • CloudBackupUploader._finalise_copy()
    • CloudBackupUploader._get_tablespace_location()
    • CloudBackupUploader._pgdata_dir
    • CloudBackupUploader._take_backup()
    • CloudBackupUploader._upload_backup_label()
    • CloudBackupUploader.backup()
  • CloudBackupUploaderBarman
    • CloudBackupUploaderBarman.__init__()
    • CloudBackupUploaderBarman._abc_impl
    • CloudBackupUploaderBarman._get_tablespace_location()
    • CloudBackupUploaderBarman._pgdata_dir
    • CloudBackupUploaderBarman._take_backup()
    • CloudBackupUploaderBarman.backup()
    • CloudBackupUploaderBarman.handle_backup_errors()
  • CloudInterface
    • CloudInterface.MAX_ARCHIVE_SIZE
    • CloudInterface.MAX_CHUNKS_PER_FILE
    • CloudInterface.MAX_DELETE_BATCH_SIZE
    • CloudInterface.MIN_CHUNK_SIZE
    • CloudInterface.__init__()
    • CloudInterface._abc_impl
    • CloudInterface._abort()
    • CloudInterface._abort_multipart_upload()
    • CloudInterface._check_bucket_existence()
    • CloudInterface._complete_multipart_upload()
    • CloudInterface._create_bucket()
    • CloudInterface._delete_objects_batch()
    • CloudInterface._ensure_async()
    • CloudInterface._handle_async_errors()
    • CloudInterface._reinit_session()
    • CloudInterface._retrieve_results()
    • CloudInterface._upload_part()
    • CloudInterface._worker_process_execute_job()
    • CloudInterface._worker_process_main()
    • CloudInterface.async_complete_multipart_upload()
    • CloudInterface.async_upload_part()
    • CloudInterface.close()
    • CloudInterface.create_multipart_upload()
    • CloudInterface.delete_objects()
    • CloudInterface.delete_under_prefix()
    • CloudInterface.download_file()
    • CloudInterface.extract_tar()
    • CloudInterface.get_prefixes()
    • CloudInterface.list_bucket()
    • CloudInterface.remote_open()
    • CloudInterface.setup_bucket()
    • CloudInterface.test_connectivity()
    • CloudInterface.upload_fileobj()
    • CloudInterface.wait_for_multipart_upload()
  • CloudProviderError
  • CloudSnapshotInterface
    • CloudSnapshotInterface._abc_impl
    • CloudSnapshotInterface._required_config_for_backup
    • CloudSnapshotInterface._required_config_for_restore
    • CloudSnapshotInterface.delete_snapshot_backup()
    • CloudSnapshotInterface.get_attached_volumes()
    • CloudSnapshotInterface.instance_exists()
    • CloudSnapshotInterface.take_snapshot_backup()
    • CloudSnapshotInterface.validate_backup_config()
    • CloudSnapshotInterface.validate_restore_config()
  • CloudTarUploader
    • CloudTarUploader.__init__()
    • CloudTarUploader._buffer()
    • CloudTarUploader._throttle_upload()
    • CloudTarUploader.close()
    • CloudTarUploader.flush()
    • CloudTarUploader.write()
  • CloudUploadController
    • CloudUploadController.__init__()
    • CloudUploadController._build_dest_name()
    • CloudUploadController._get_tar()
    • CloudUploadController.add_file()
    • CloudUploadController.add_fileobj()
    • CloudUploadController.close()
    • CloudUploadController.copy_end_time
    • CloudUploadController.copy_start_time
    • CloudUploadController.statistics()
    • CloudUploadController.upload_directory()
    • CloudUploadController.upload_stats
  • CloudUploadingError
  • DecompressingStreamingIO
    • DecompressingStreamingIO.COMPRESSED_CHUNK_SIZE
    • DecompressingStreamingIO.__init__()
    • DecompressingStreamingIO._abc_impl
    • DecompressingStreamingIO._read_from_uncompressed_buffer()
    • DecompressingStreamingIO.read()
  • FileUploadStatistics
    • FileUploadStatistics.__init__()
    • FileUploadStatistics.set_part_end_time()
    • FileUploadStatistics.set_part_start_time()
  • SnapshotMetadata
    • SnapshotMetadata.__init__()
    • SnapshotMetadata._provider_fields
    • SnapshotMetadata.from_dict()
    • SnapshotMetadata.identifier
    • SnapshotMetadata.to_dict()
  • SnapshotsInfo
    • SnapshotsInfo.__init__()
    • SnapshotsInfo._provider_fields
    • SnapshotsInfo._snapshot_metadata_cls
    • SnapshotsInfo.from_dict()
    • SnapshotsInfo.to_dict()
  • TarFileIgnoringTruncate
    • TarFileIgnoringTruncate.addfile()
    • TarFileIgnoringTruncate.format
  • VolumeMetadata
    • VolumeMetadata.__init__()
    • VolumeMetadata.mount_options
    • VolumeMetadata.mount_point
    • VolumeMetadata.resolve_mounted_volume()
    • VolumeMetadata.source_snapshot
  • configure_logging()
  • copyfileobj_pad_truncate()
• barman.command_wrappers module
  • BarmanSubProcess
    • BarmanSubProcess.__init__()
    • BarmanSubProcess.execute()
  • Command
    • Command.__init__()
    • Command._build_pipe()
    • Command._get_output_once()
    • Command._restore_sigpipe()
    • Command.check_return_value()
    • Command.enable_signal_forwarding()
    • Command.execute()
    • Command.get_output()
    • Command.make_logging_handler()
    • Command.make_output_handler()
    • Command.pipe_processor_loop()
  • Handler
    • Handler.__init__()
    • Handler.run()
  • PgBaseBackup
    • PgBaseBackup.COMMAND_ALTERNATIVES
    • PgBaseBackup.__init__()
    • PgBaseBackup._get_compression_args()
  • PgCombineBackup
    • PgCombineBackup.COMMAND_ALTERNATIVES
    • PgCombineBackup.__init__()
  • PgReceiveXlog
    • PgReceiveXlog.COMMAND_ALTERNATIVES
    • PgReceiveXlog.__init__()
  • PgVerifyBackup
    • PgVerifyBackup.COMMAND_ALTERNATIVES
    • PgVerifyBackup.__init__()
  • PostgreSQLClient
    • PostgreSQLClient.COMMAND_ALTERNATIVES
    • PostgreSQLClient.__init__()
    • PostgreSQLClient.find_command()
    • PostgreSQLClient.get_version_info()
  • Rsync
    • Rsync.__init__()
    • Rsync._args_for_suse()
    • Rsync.from_file_list()
    • Rsync.get_output()
  • RsyncPgData
    • RsyncPgData.__init__()
  • StreamLineProcessor
    • StreamLineProcessor.__init__()
    • StreamLineProcessor.fileno()
    • StreamLineProcessor.process()
  • full_command_quote()
  • shell_quote()
• barman.compression module
  • BZip2Compressor
    • BZip2Compressor.MAGIC
    • BZip2Compressor.__init__()
    • BZip2Compressor._abc_impl
  • CommandCompressor
    • CommandCompressor.__init__()
    • CommandCompressor._abc_impl
    • CommandCompressor._build_command()
    • CommandCompressor.compress()
    • CommandCompressor.decompress()
  • Compression
    • Compression._abc_impl
    • Compression.file_extension
    • Compression.get_file_content()
    • Compression.name
    • Compression.uncompress()
    • Compression.validate_dst()
    • Compression.validate_src_and_dst()
  • CompressionManager
    • CompressionManager.__init__()
    • CompressionManager.check()
    • CompressionManager.get_compressor()
    • CompressionManager.get_default_compressor()
    • CompressionManager.get_wal_file_info()
    • CompressionManager.identify_compression()
  • Compressor
    • Compressor.MAGIC
    • Compressor.__init__()
    • Compressor._abc_impl
    • Compressor.compress()
    • Compressor.decompress()
    • Compressor.validate()
  • CustomCompressor
    • CustomCompressor.__init__()
    • CustomCompressor._abc_impl
  • GZipCompression
    • GZipCompression.__init__()
    • GZipCompression._abc_impl
    • GZipCompression.file_extension
    • GZipCompression.get_file_content()
    • GZipCompression.name
    • GZipCompression.uncompress()
  • GZipCompressor
    • GZipCompressor.MAGIC
    • GZipCompressor.__init__()
    • GZipCompressor._abc_impl
  • GZipPgBaseBackupCompressionOption
    • GZipPgBaseBackupCompressionOption.validate()
  • InternalCompressor
    • InternalCompressor._abc_impl
    • InternalCompressor._compressor()
    • InternalCompressor._decompressor()
    • InternalCompressor.compress()
    • InternalCompressor.decompress()
  • LZ4Compression
    • LZ4Compression.__init__()
    • LZ4Compression._abc_impl
    • LZ4Compression.file_extension
    • LZ4Compression.get_file_content()
    • LZ4Compression.name
    • LZ4Compression.uncompress()
  • LZ4Compressor
    • LZ4Compressor.MAGIC
    • LZ4Compressor.__init__()
    • LZ4Compressor._abc_impl
    • LZ4Compressor._compressor()
    • LZ4Compressor._decompressor()
  • LZ4PgBaseBackupCompressionOption
    • LZ4PgBaseBackupCompressionOption.validate()
  • NoneCompression
    • NoneCompression.__init__()
    • NoneCompression._abc_impl
    • NoneCompression.file_extension
    • NoneCompression.get_file_content()
    • NoneCompression.name
    • NoneCompression.uncompress()
  • NonePgBaseBackupCompressionOption
    • NonePgBaseBackupCompressionOption.validate()
  • PgBaseBackupCompression
    • PgBaseBackupCompression.__init__()
    • PgBaseBackupCompression.get_file_content()
    • PgBaseBackupCompression.validate()
    • PgBaseBackupCompression.with_suffix()
  • PgBaseBackupCompressionConfig
    • PgBaseBackupCompressionConfig.__init__()
  • PgBaseBackupCompressionOption
    • PgBaseBackupCompressionOption.__init__()
    • PgBaseBackupCompressionOption.validate()
  • PigzCompressor
    • PigzCompressor.MAGIC
    • PigzCompressor.__init__()
    • PigzCompressor._abc_impl
  • PyBZip2Compressor
    • PyBZip2Compressor.MAGIC
    • PyBZip2Compressor.__init__()
    • PyBZip2Compressor._abc_impl
    • PyBZip2Compressor._compressor()
    • PyBZip2Compressor._decompressor()
  • PyGZipCompressor
    • PyGZipCompressor.MAGIC
    • PyGZipCompressor.__init__()
    • PyGZipCompressor._abc_impl
    • PyGZipCompressor._compressor()
    • PyGZipCompressor._decompressor()
  • XZCompressor
    • XZCompressor.MAGIC
    • XZCompressor._abc_impl
    • XZCompressor._compressor()
    • XZCompressor._decompressor()
  • ZSTDCompression
    • ZSTDCompression.__init__()
    • ZSTDCompression._abc_impl
    • ZSTDCompression.file_extension
    • ZSTDCompression.get_file_content()
    • ZSTDCompression.name
    • ZSTDCompression.uncompress()
  • ZSTDCompressor
    • ZSTDCompressor.MAGIC
    • ZSTDCompressor.__init__()
    • ZSTDCompressor._abc_impl
    • ZSTDCompressor._compressor()
    • ZSTDCompressor._decompressor()
  • ZSTDPgBaseBackupCompressionOption
    • ZSTDPgBaseBackupCompressionOption.validate()
  • _try_import_lz4()
  • _try_import_zstd()
  • get_pg_basebackup_compression()
• barman.config module
  • BackupOptions
    • BackupOptions.CONCURRENT_BACKUP
    • BackupOptions.EXCLUSIVE_BACKUP
    • BackupOptions.EXTERNAL_CONFIGURATION
    • BackupOptions.conflicts
    • BackupOptions.value_list
  • BaseChange
    • BaseChange._fields
    • BaseChange.as_dict()
    • BaseChange.as_tuple()
  • BaseConfig
    • BaseConfig.PARSERS
    • BaseConfig.invoke_parser()
  • Config
    • Config.CONFIG_FILES
    • Config._QUOTE_RE
    • Config.__init__()
    • Config._apply_models()
    • Config._check_conflicting_paths()
    • Config._detect_missing_keys()
    • Config._is_global_config_changed()
    • Config._is_model()
    • Config._parse_global_config()
    • Config._populate_servers_and_models()
    • Config._validate_with_keys()
    • Config.get()
    • Config.get_config_source()
    • Config.get_model()
    • Config.get_server()
    • Config.global_config_to_json()
    • Config.load_config_file()
    • Config.load_configuration_files_directory()
    • Config.model_names()
    • Config.models()
    • Config.server_names()
    • Config.servers()
    • Config.validate_global_config()
    • Config.validate_model_config()
    • Config.validate_server_config()
  • ConfigChange
    • ConfigChange.__init__()
    • ConfigChange._fields
    • ConfigChange.from_dict()
  • ConfigChangeSet
    • ConfigChangeSet.__init__()
    • ConfigChangeSet._fields
    • ConfigChangeSet.from_dict()
  • ConfigChangeSetEncoder
    • ConfigChangeSetEncoder.default()
  • ConfigChangesProcessor
    • ConfigChangesProcessor.__init__()
    • ConfigChangesProcessor.apply_change()
    • ConfigChangesProcessor.process_conf_changes_queue()
    • ConfigChangesProcessor.receive_config_changes()
  • ConfigChangesQueue
    • ConfigChangesQueue.__init__()
    • ConfigChangesQueue.close()
    • ConfigChangesQueue.open()
    • ConfigChangesQueue.queue
    • ConfigChangesQueue.read_file()
  • ConfigMapping
    • ConfigMapping.__init__()
    • ConfigMapping._abc_impl
    • ConfigMapping.get_config_source()
    • ConfigMapping.read_config()
  • CsvOption
    • CsvOption.__init__()
    • CsvOption.conflicts
    • CsvOption.parse()
    • CsvOption.to_json()
    • CsvOption.validate()
    • CsvOption.value_list
  • ModelConfig
    • ModelConfig.KEYS
    • ModelConfig.PARSERS
    • ModelConfig.REQUIRED_KEYS
    • ModelConfig._KEYS_BLACKLIST
    • ModelConfig.__init__()
    • ModelConfig.get_override_options()
    • ModelConfig.key
    • ModelConfig.to_json()
  • PathConflict
    • PathConflict._asdict()
    • PathConflict._field_defaults
    • PathConflict._fields
    • PathConflict._make()
    • PathConflict._replace()
    • PathConflict.label
    • PathConflict.server
  • RecoveryOptions
    • RecoveryOptions.GET_WAL
    • RecoveryOptions.value_list
  • ServerConfig
    • ServerConfig.BARMAN_KEYS
    • ServerConfig.DEFAULTS
    • ServerConfig.FIXED
    • ServerConfig.KEYS
    • ServerConfig.PARSERS
    • ServerConfig.__init__()
    • ServerConfig.apply_model()
    • ServerConfig.get_bwlimit()
    • ServerConfig.get_wal_conninfo()
    • ServerConfig.reset_model()
    • ServerConfig.to_json()
    • ServerConfig.update_msg_list_and_disable_server()
  • _main()
  • parse_backup_compression()
  • parse_backup_compression_format()
  • parse_backup_compression_location()
  • parse_backup_method()
  • parse_boolean()
  • parse_create_slot()
  • parse_reuse_backup()
  • parse_si_suffix()
  • parse_slot_name()
  • parse_snapshot_disks()
  • parse_staging_path()
  • parse_time_interval()
• barman.copy_controller module
  • RsyncCopyController
    • RsyncCopyController.CONFIG_CLASS
    • RsyncCopyController.LIST_ONLY_RE
    • RsyncCopyController.PGCONTROL_CLASS
    • RsyncCopyController.PGDATA_CLASS
    • RsyncCopyController.TABLESPACE_CLASS
    • RsyncCopyController.VANISHED_RE
    • RsyncCopyController.__init__()
    • RsyncCopyController._analyze_directory()
    • RsyncCopyController._apply_rate_limit()
    • RsyncCopyController._copy()
    • RsyncCopyController._create_dir_and_purge()
    • RsyncCopyController._execute_job()
    • RsyncCopyController._fill_buckets()
    • RsyncCopyController._job_generator()
    • RsyncCopyController._list_files()
    • RsyncCopyController._progress_init()
    • RsyncCopyController._progress_message()
    • RsyncCopyController._retry_handler()
    • RsyncCopyController._reuse_args()
    • RsyncCopyController._rsync_factory()
    • RsyncCopyController._rsync_ignore_vanished_files()
    • RsyncCopyController._rsync_set_pre_31_mode()
    • RsyncCopyController.add_directory()
    • RsyncCopyController.add_file()
    • RsyncCopyController.copy()
    • RsyncCopyController.copy_end_time
    • RsyncCopyController.copy_start_time
    • RsyncCopyController.current_step
    • RsyncCopyController.item_list
    • RsyncCopyController.jobs_done
    • RsyncCopyController.rsync_cache
    • RsyncCopyController.statistics()
    • RsyncCopyController.temp_dir
    • RsyncCopyController.total_steps
  • _FileItem
  • _RsyncCopyItem
    • _RsyncCopyItem.__init__()
  • _RsyncJob
    • _RsyncJob.__init__()
  • _init_worker()
  • _run_worker()
  • _worker_callable
• barman.diagnose module
  • exec_diagnose()
• barman.exceptions module
  • AbortedRetryHookScript
    • AbortedRetryHookScript.__init__()
  • ArchivalBackupException
  • ArchiverFailure
  • BackupException
  • BackupFunctionsAccessRequired
  • BackupInfoBadInitialisation
  • BackupManifestException
  • BackupPreconditionException
  • BadHistoryFileContents
  • BadXlogPrefix
  • BadXlogSegmentName
  • BarmanException
  • CommandException
  • CommandFailedException
  • CommandMaxRetryExceeded
  • CompressionException
  • CompressionIncompatibility
  • ConfigurationException
  • ConninfoException
  • DataTransferFailure
    • DataTransferFailure.from_command_error()
  • DuplicateWalFile
  • FileNotFoundException
  • FsOperationFailed
  • HookScriptException
  • InvalidRetentionPolicy
  • LockFileBusy
  • LockFileException
  • LockFileParsingError
  • LockFilePermissionDenied
  • MatchingDuplicateWalFile
  • PostgresAppNameError
  • PostgresCheckpointPrivilegesRequired
  • PostgresConnectionError
  • PostgresConnectionLost
  • PostgresDuplicateReplicationSlot
  • PostgresException
  • PostgresInvalidReplicationSlot
  • PostgresIsInRecovery
  • PostgresObsoleteFeature
  • PostgresReplicationSlotInUse
  • PostgresReplicationSlotsFull
  • PostgresSuperuserRequired
  • PostgresUnsupportedFeature
  • RecoveryException
  • RecoveryInvalidTargetException
  • RecoveryPreconditionException
  • RecoveryStandbyModeException
  • RecoveryTargetActionException
  • RsyncListFilesFailure
  • SnapshotBackupException
  • SnapshotInstanceNotFoundException
  • SshCommandException
  • SyncError
  • SyncException
  • SyncNothingToDo
  • SyncToBeDeleted
  • TimeoutError
  • UnknownBackupIdException
  • UnrecoverableHookScriptError
  • WALFileException
  • WalArchiveContentError
• barman.fs module
  • LocalLibPathDeletionCommand
    • LocalLibPathDeletionCommand.__init__()
    • LocalLibPathDeletionCommand._abc_impl
    • LocalLibPathDeletionCommand.delete()
  • PathDeletionCommand
    • PathDeletionCommand._abc_impl
    • PathDeletionCommand.delete()
  • UnixCommandPathDeletionCommand
    • UnixCommandPathDeletionCommand.__init__()
    • UnixCommandPathDeletionCommand._abc_impl
    • UnixCommandPathDeletionCommand.delete()
  • UnixLocalCommand
    • UnixLocalCommand.__init__()
    • UnixLocalCommand.check_directory_exists()
    • UnixLocalCommand.check_write_permission()
    • UnixLocalCommand.cmd()
    • UnixLocalCommand.create_dir_if_not_exists()
    • UnixLocalCommand.create_symbolic_link()
    • UnixLocalCommand.delete_if_exists()
    • UnixLocalCommand.exists()
    • UnixLocalCommand.findmnt()
    • UnixLocalCommand.get_file_content()
    • UnixLocalCommand.get_file_mode()
    • UnixLocalCommand.get_last_output()
    • UnixLocalCommand.get_system_info()
    • UnixLocalCommand.is_osx()
    • UnixLocalCommand.list_dir_content()
    • UnixLocalCommand.move()
    • UnixLocalCommand.ping()
    • UnixLocalCommand.validate_file_mode()
  • UnixRemoteCommand
    • UnixRemoteCommand.__init__()
  • _match_path()
  • _translate_to_regexp()
  • _wildcard_match_path()
  • path_allowed()
  • unix_command_factory()
• barman.hooks module
  • HookScriptRunner
    • HookScriptRunner.__init__()
    • HookScriptRunner.env_from_backup_info()
    • HookScriptRunner.env_from_recover()
    • HookScriptRunner.env_from_wal_info()
    • HookScriptRunner.reset()
    • HookScriptRunner.run()
  • RetryHookScriptRunner
    • RetryHookScriptRunner.ATTEMPTS_BEFORE_NAP
    • RetryHookScriptRunner.BREAK_TIME
    • RetryHookScriptRunner.EXIT_ABORT_CONTINUE
    • RetryHookScriptRunner.EXIT_ABORT_STOP
    • RetryHookScriptRunner.EXIT_SUCCESS
    • RetryHookScriptRunner.NAP_TIME
    • RetryHookScriptRunner.__init__()
    • RetryHookScriptRunner.run()
• barman.infofile module
  • BackupInfo
    • BackupInfo.DONE
    • BackupInfo.EMPTY
    • BackupInfo.FAILED
    • BackupInfo.KEEP_FULL
    • BackupInfo.KEEP_STANDALONE
    • BackupInfo.NONE
    • BackupInfo.OBSOLETE
    • BackupInfo.POTENTIALLY_OBSOLETE
    • BackupInfo.RETENTION_STATUS
    • BackupInfo.STARTED
    • BackupInfo.STATUS_ALL
    • BackupInfo.STATUS_ARCHIVING
    • BackupInfo.STATUS_COPY_DONE
    • BackupInfo.STATUS_NOT_EMPTY
    • BackupInfo.SYNCING
    • BackupInfo.VALID
    • BackupInfo.WAITING_FOR_WALS
    • BackupInfo.__init__()
    • BackupInfo._hide_if_null
    • BackupInfo.backup_id
    • BackupInfo.backup_label
    • BackupInfo.backup_name
    • BackupInfo.backup_type
    • BackupInfo.backup_version
    • BackupInfo.begin_offset
    • BackupInfo.begin_time
    • BackupInfo.begin_wal
    • BackupInfo.begin_xlog
    • BackupInfo.children_backup_ids
    • BackupInfo.cluster_size
    • BackupInfo.compression
    • BackupInfo.config_file
    • BackupInfo.copy_stats
    • BackupInfo.data_checksums
    • BackupInfo.deduplicated_size
    • BackupInfo.deduplication_ratio
    • BackupInfo.end_offset
    • BackupInfo.end_time
    • BackupInfo.end_wal
    • BackupInfo.end_xlog
    • BackupInfo.error
    • BackupInfo.from_json()
    • BackupInfo.get_external_config_files()
    • BackupInfo.get_required_wal_segments()
    • BackupInfo.has_children
    • BackupInfo.hba_file
    • BackupInfo.ident_file
    • BackupInfo.included_files
    • BackupInfo.is_incremental
    • BackupInfo.mode
    • BackupInfo.parent_backup_id
    • BackupInfo.pg_major_version()
    • BackupInfo.pgdata
    • BackupInfo.server_name
    • BackupInfo.set_attribute()
    • BackupInfo.size
    • BackupInfo.snapshots_info
    • BackupInfo.status
    • BackupInfo.summarize_wal
    • BackupInfo.systemid
    • BackupInfo.tablespaces
    • BackupInfo.timeline
    • BackupInfo.to_dict()
    • BackupInfo.to_json()
    • BackupInfo.version
    • BackupInfo.wal_directory()
    • BackupInfo.xlog_segment_size
  • Field
    • Field.__init__()
    • Field.dump()
    • Field.load()
  • FieldListFile
    • FieldListFile.__init__()
    • FieldListFile._fields
    • FieldListFile._hide_if_null
    • FieldListFile.filename
    • FieldListFile.from_meta_file()
    • FieldListFile.items()
    • FieldListFile.load()
    • FieldListFile.save()
  • LocalBackupInfo
    • LocalBackupInfo.__init__()
    • LocalBackupInfo.backup_manager
    • LocalBackupInfo.config
    • LocalBackupInfo.detect_backup_id()
    • LocalBackupInfo.get_backup_manifest_path()
    • LocalBackupInfo.get_basebackup_directory()
    • LocalBackupInfo.get_child_backup_info()
    • LocalBackupInfo.get_data_directory()
    • LocalBackupInfo.get_filename()
    • LocalBackupInfo.get_list_of_files()
    • LocalBackupInfo.get_parent_backup_info()
    • LocalBackupInfo.is_checksum_consistent()
    • LocalBackupInfo.is_full_and_eligible_for_incremental()
    • LocalBackupInfo.is_orphan
    • LocalBackupInfo.save()
    • LocalBackupInfo.server
    • LocalBackupInfo.walk_backups_tree()
    • LocalBackupInfo.walk_to_root()
  • SyntheticBackupInfo
    • SyntheticBackupInfo.__init__()
    • SyntheticBackupInfo.backup_manager
    • SyntheticBackupInfo.config
    • SyntheticBackupInfo.get_basebackup_directory()
    • SyntheticBackupInfo.server
  • Tablespace
    • Tablespace._asdict()
    • Tablespace._field_defaults
    • Tablespace._fields
    • Tablespace._make()
    • Tablespace._replace()
    • Tablespace.location
    • Tablespace.name
    • Tablespace.oid
  • TypedFile
  • WalFileInfo
    • WalFileInfo.compression
    • WalFileInfo.from_file()
    • WalFileInfo.from_xlogdb_line()
    • WalFileInfo.fullpath()
    • WalFileInfo.name
    • WalFileInfo.orig_filename
    • WalFileInfo.relpath()
    • WalFileInfo.size
    • WalFileInfo.time
    • WalFileInfo.to_json()
    • WalFileInfo.to_xlogdb_line()
  • dump_backup_ids()
  • load_backup_ids()
  • load_datetime_tz()
  • load_snapshots_info()
  • load_tablespace_list()
  • null_repr()
  • output_snapshots_info()
  • output_tablespace_list()
• barman.lockfile module
  • ConfigUpdateLock
    • ConfigUpdateLock.__init__()
  • GlobalCronLock
    • GlobalCronLock.__init__()
  • LockFile
    • LockFile.LOCK_PATTERN
    • LockFile.__init__()
    • LockFile.acquire()
    • LockFile.build_if_matches()
    • LockFile.get_owner_pid()
    • LockFile.release()
  • ServerBackupIdLock
    • ServerBackupIdLock.__init__()
  • ServerBackupLock
    • ServerBackupLock.__init__()
  • ServerBackupSyncLock
    • ServerBackupSyncLock.__init__()
  • ServerCronLock
    • ServerCronLock.__init__()
  • ServerWalArchiveLock
    • ServerWalArchiveLock.__init__()
  • ServerWalReceiveLock
    • ServerWalReceiveLock.LOCK_PATTERN
    • ServerWalReceiveLock.__init__()
  • ServerWalSyncLock
    • ServerWalSyncLock.__init__()
  • ServerXLOGDBLock
    • ServerXLOGDBLock.__init__()
• barman.output module
  • AVAILABLE_WRITERS
  • ConsoleOutputWriter
    • ConsoleOutputWriter.SERVER_OUTPUT_PREFIX
    • ConsoleOutputWriter.__init__()
    • ConsoleOutputWriter._err()
    • ConsoleOutputWriter._out()
    • ConsoleOutputWriter._print()
    • ConsoleOutputWriter._record_check()
    • ConsoleOutputWriter.active
    • ConsoleOutputWriter.close()
    • ConsoleOutputWriter.debug()
    • ConsoleOutputWriter.error()
    • ConsoleOutputWriter.error_occurred()
    • ConsoleOutputWriter.exception()
    • ConsoleOutputWriter.info()
    • ConsoleOutputWriter.init_check()
    • ConsoleOutputWriter.init_check_wal_archive()
    • ConsoleOutputWriter.init_list_backup()
    • ConsoleOutputWriter.init_list_server()
    • ConsoleOutputWriter.init_replication_status()
    • ConsoleOutputWriter.init_show_server()
    • ConsoleOutputWriter.init_status()
    • ConsoleOutputWriter.is_debug()
    • ConsoleOutputWriter.is_quiet()
    • ConsoleOutputWriter.minimal
    • ConsoleOutputWriter.render_show_backup()
    • ConsoleOutputWriter.render_show_backup_base()
    • ConsoleOutputWriter.render_show_backup_catalog_info()
    • ConsoleOutputWriter.render_show_backup_general()
    • ConsoleOutputWriter.render_show_backup_server()
    • ConsoleOutputWriter.render_show_backup_snapshots()
    • ConsoleOutputWriter.render_show_backup_tablespaces()
    • ConsoleOutputWriter.render_show_backup_walinfo()
    • ConsoleOutputWriter.result_backup()
    • ConsoleOutputWriter.result_check()
    • ConsoleOutputWriter.result_check_list
    • ConsoleOutputWriter.result_check_wal_archive()
    • ConsoleOutputWriter.result_list_backup()
    • ConsoleOutputWriter.result_list_server()
    • ConsoleOutputWriter.result_recovery()
    • ConsoleOutputWriter.result_replication_status()
    • ConsoleOutputWriter.result_show_backup()
    • ConsoleOutputWriter.result_show_server()
    • ConsoleOutputWriter.result_status()
    • ConsoleOutputWriter.warning()
  • DEFAULT_WRITER
  • JsonOutputWriter
    • JsonOutputWriter.__init__()
    • JsonOutputWriter._mangle_key()
    • JsonOutputWriter._out_to_field()
    • JsonOutputWriter.close()
    • JsonOutputWriter.debug()
    • JsonOutputWriter.error()
    • JsonOutputWriter.exception()
    • JsonOutputWriter.info()
    • JsonOutputWriter.init_check()
    • JsonOutputWriter.init_check_wal_archive()
    • JsonOutputWriter.init_list_backup()
    • JsonOutputWriter.init_list_server()
    • JsonOutputWriter.init_replication_status()
    • JsonOutputWriter.init_show_server()
    • JsonOutputWriter.init_status()
    • JsonOutputWriter.json_output
    • JsonOutputWriter.result_backup()
    • JsonOutputWriter.result_check()
    • JsonOutputWriter.result_check_wal_archive()
    • JsonOutputWriter.result_list_backup()
    • JsonOutputWriter.result_list_server()
    • JsonOutputWriter.result_recovery()
    • JsonOutputWriter.result_replication_status()
    • JsonOutputWriter.result_show_backup()
    • JsonOutputWriter.result_show_server()
    • JsonOutputWriter.result_status()
    • JsonOutputWriter.warning()
  • NagiosOutputWriter
    • NagiosOutputWriter._err()
    • NagiosOutputWriter._out()
    • NagiosOutputWriter._parse_check_results()
    • NagiosOutputWriter._print_check_failure()
    • NagiosOutputWriter._print_check_success()
    • NagiosOutputWriter._summarise_server_issues()
    • NagiosOutputWriter.close()
  • close()
  • close_and_exit()
  • debug()
  • error()
  • error_occurred
  • exception()
  • info()
  • result()
  • set_output_writer()
  • warning()
• barman.postgres module
  • PostgreSQL
    • PostgreSQL.CHECK_QUERY
    • PostgreSQL.MINIMAL_VERSION
    • PostgreSQL.__init__()
    • PostgreSQL._abc_impl
    • PostgreSQL._check_connection()
    • PostgreSQL._cursor()
    • PostgreSQL.close()
    • PostgreSQL.connect()
    • PostgreSQL.encode_dsn()
    • PostgreSQL.get_connection_string()
    • PostgreSQL.int_version_to_string_version()
    • PostgreSQL.is_minimal_postgres_version()
    • PostgreSQL.minimal_txt_version
    • PostgreSQL.parse_dsn()
    • PostgreSQL.server_major_version
    • PostgreSQL.server_txt_version
    • PostgreSQL.server_version
  • PostgreSQLConnection
    • PostgreSQLConnection.ANY_STREAMING_CLIENT
    • PostgreSQLConnection.HEARTBEAT_QUERY
    • PostgreSQLConnection.STANDBY
    • PostgreSQLConnection.WALSTREAMER
    • PostgreSQLConnection.__init__()
    • PostgreSQLConnection._abc_impl
    • PostgreSQLConnection.archive_timeout
    • PostgreSQLConnection.checkpoint()
    • PostgreSQLConnection.checkpoint_timeout
    • PostgreSQLConnection.connect()
    • PostgreSQLConnection.create_restore_point()
    • PostgreSQLConnection.current_size
    • PostgreSQLConnection.current_xlog_file_name
    • PostgreSQLConnection.current_xlog_info
    • PostgreSQLConnection.current_xlog_location
    • PostgreSQLConnection.fetch_remote_status()
    • PostgreSQLConnection.get_archiver_stats()
    • PostgreSQLConnection.get_configuration_files()
    • PostgreSQLConnection.get_replication_slot()
    • PostgreSQLConnection.get_replication_stats()
    • PostgreSQLConnection.get_setting()
    • PostgreSQLConnection.get_synchronous_standby_names()
    • PostgreSQLConnection.get_systemid()
    • PostgreSQLConnection.get_tablespaces()
    • PostgreSQLConnection.has_backup_privileges
    • PostgreSQLConnection.has_checkpoint_privileges
    • PostgreSQLConnection.has_connection
    • PostgreSQLConnection.has_monitoring_privileges
    • PostgreSQLConnection.is_in_recovery
    • PostgreSQLConnection.is_superuser
    • PostgreSQLConnection.name_map
    • PostgreSQLConnection.send_heartbeat_query()
    • PostgreSQLConnection.server_txt_version
    • PostgreSQLConnection.start_concurrent_backup()
    • PostgreSQLConnection.start_exclusive_backup()
    • PostgreSQLConnection.stop_concurrent_backup()
    • PostgreSQLConnection.stop_exclusive_backup()
    • PostgreSQLConnection.switch_wal()
    • PostgreSQLConnection.xlog_segment_size
  • PostgresKeepAlive
    • PostgresKeepAlive.THREAD_NAME
    • PostgresKeepAlive.__init__()
    • PostgresKeepAlive._prepare_signal_handler()
    • PostgresKeepAlive._raise_exception_on_main()
    • PostgresKeepAlive._run_keep_alive()
  • StandbyPostgreSQLConnection
    • StandbyPostgreSQLConnection.__init__()
    • StandbyPostgreSQLConnection._abc_impl
    • StandbyPostgreSQLConnection._start_wal_switch()
    • StandbyPostgreSQLConnection._stop_backup()
    • StandbyPostgreSQLConnection._stop_wal_switch()
    • StandbyPostgreSQLConnection.close()
    • StandbyPostgreSQLConnection.stop_concurrent_backup()
    • StandbyPostgreSQLConnection.stop_exclusive_backup()
    • StandbyPostgreSQLConnection.switch_wal()
    • StandbyPostgreSQLConnection.switch_wal_in_background()
  • StreamingConnection
    • StreamingConnection.CHECK_QUERY
    • StreamingConnection.__init__()
    • StreamingConnection._abc_impl
    • StreamingConnection.connect()
    • StreamingConnection.create_physical_repslot()
    • StreamingConnection.drop_repslot()
    • StreamingConnection.fetch_remote_status()
  • _atexit()
  • _live_connections
• barman.postgres_plumbing module
  • function_name_map()
• barman.process module
  • ProcessInfo
    • ProcessInfo.__init__()
  • ProcessManager
    • ProcessManager.TASKS
    • ProcessManager.__init__()
    • ProcessManager.kill()
    • ProcessManager.list()
• barman.recovery_executor module
  • Assertion
    • Assertion._asdict()
    • Assertion._field_defaults
    • Assertion._fields
    • Assertion._make()
    • Assertion._replace()
    • Assertion.filename
    • Assertion.key
    • Assertion.line
    • Assertion.value
  • ConfigIssueDetection
    • ConfigIssueDetection.DANGEROUS_OPTIONS
    • ConfigIssueDetection.detect_issues()
  • ConfigurationFileMangeler
    • ConfigurationFileMangeler.OPTIONS_TO_MANGLE
    • ConfigurationFileMangeler.mangle_options()
  • IncrementalRecoveryExecutor
    • IncrementalRecoveryExecutor.__init__()
    • IncrementalRecoveryExecutor._backup_copy()
    • IncrementalRecoveryExecutor._combine_backups()
    • IncrementalRecoveryExecutor._end_message()
    • IncrementalRecoveryExecutor._fetch_remote_status()
    • IncrementalRecoveryExecutor._get_backup_chain_paths()
    • IncrementalRecoveryExecutor._move_to_destination()
    • IncrementalRecoveryExecutor._prepare_destination()
    • IncrementalRecoveryExecutor._retry_handler()
    • IncrementalRecoveryExecutor._start_message()
    • IncrementalRecoveryExecutor.recover()
  • RecoveryExecutor
    • RecoveryExecutor.__init__()
    • RecoveryExecutor._analyse_temporary_config_files()
    • RecoveryExecutor._backup_copy()
    • RecoveryExecutor._backup_copy_failure_message()
    • RecoveryExecutor._conf_files_exist()
    • RecoveryExecutor._copy_conf_files_to_tempdir()
    • RecoveryExecutor._copy_temporary_config_files()
    • RecoveryExecutor._generate_archive_status()
    • RecoveryExecutor._generate_recovery_conf()
    • RecoveryExecutor._map_temporary_config_files()
    • RecoveryExecutor._prepare_tablespaces()
    • RecoveryExecutor._retrieve_safe_horizon()
    • RecoveryExecutor._set_pitr_targets()
    • RecoveryExecutor._setup()
    • RecoveryExecutor._start_backup_copy_message()
    • RecoveryExecutor._xlog_copy()
    • RecoveryExecutor.close()
    • RecoveryExecutor.recover()
  • RemoteConfigRecoveryExecutor
    • RemoteConfigRecoveryExecutor._conf_files_exist()
    • RemoteConfigRecoveryExecutor._copy_conf_files_to_tempdir()
  • SnapshotRecoveryExecutor
    • SnapshotRecoveryExecutor._backup_copy()
    • SnapshotRecoveryExecutor._backup_copy_failure_message()
    • SnapshotRecoveryExecutor._prepare_tablespaces()
    • SnapshotRecoveryExecutor._start_backup_copy_message()
    • SnapshotRecoveryExecutor.check_mount_points()
    • SnapshotRecoveryExecutor.check_recovery_dir_exists()
    • SnapshotRecoveryExecutor.get_attached_volumes_for_backup()
    • SnapshotRecoveryExecutor.recover()
  • TarballRecoveryExecutor
    • TarballRecoveryExecutor.BASE_TARBALL_NAME
    • TarballRecoveryExecutor.__init__()
    • TarballRecoveryExecutor._backup_copy()
  • recovery_executor_factory()
• barman.remote_status module
  • RemoteStatusMixin
    • RemoteStatusMixin.__init__()
    • RemoteStatusMixin._abc_impl
    • RemoteStatusMixin.fetch_remote_status()
    • RemoteStatusMixin.get_remote_status()
    • RemoteStatusMixin.reset_remote_status()
• barman.retention_policies module
  • RecoveryWindowRetentionPolicy
    • RecoveryWindowRetentionPolicy.__init__()
    • RecoveryWindowRetentionPolicy._abc_impl
    • RecoveryWindowRetentionPolicy._backup_report()
    • RecoveryWindowRetentionPolicy._kw
    • RecoveryWindowRetentionPolicy._point_of_recoverability()
    • RecoveryWindowRetentionPolicy._re
    • RecoveryWindowRetentionPolicy._wal_report()
    • RecoveryWindowRetentionPolicy.create()
    • RecoveryWindowRetentionPolicy.debug()
  • RedundancyRetentionPolicy
    • RedundancyRetentionPolicy.__init__()
    • RedundancyRetentionPolicy._abc_impl
    • RedundancyRetentionPolicy._backup_report()
    • RedundancyRetentionPolicy._re
    • RedundancyRetentionPolicy._wal_report()
    • RedundancyRetentionPolicy.create()
    • RedundancyRetentionPolicy.debug()
  • RetentionPolicy
    • RetentionPolicy.__init__()
    • RetentionPolicy._abc_impl
    • RetentionPolicy._backup_report()
    • RetentionPolicy._propagate_retention_status_to_children()
    • RetentionPolicy._wal_report()
    • RetentionPolicy.backup_status()
    • RetentionPolicy.create()
    • RetentionPolicy.debug()
    • RetentionPolicy.first_backup()
    • RetentionPolicy.first_wal()
    • RetentionPolicy.report()
    • RetentionPolicy.to_json()
  • RetentionPolicyFactory
    • RetentionPolicyFactory.create()
    • RetentionPolicyFactory.policy_classes
  • ServerMetadata
    • ServerMetadata.__init__()
    • ServerMetadata.available_backups
    • ServerMetadata.get_keep_target()
  • ServerMetadataLive
    • ServerMetadataLive.__init__()
    • ServerMetadataLive.available_backups
    • ServerMetadataLive.get_keep_target()
    • ServerMetadataLive.minimum_redundancy
    • ServerMetadataLive.name
    • ServerMetadataLive.retention_policy
  • SimpleWALRetentionPolicy
    • SimpleWALRetentionPolicy.__init__()
    • SimpleWALRetentionPolicy._abc_impl
    • SimpleWALRetentionPolicy._backup_report()
    • SimpleWALRetentionPolicy._re
    • SimpleWALRetentionPolicy._wal_report()
    • SimpleWALRetentionPolicy.create()
    • SimpleWALRetentionPolicy.debug()
    • SimpleWALRetentionPolicy.first_wal()
• barman.server module
  • CheckOutputStrategy
    • CheckOutputStrategy.__init__()
    • CheckOutputStrategy.result()
  • CheckStrategy
    • CheckStrategy.CheckResult
      • CheckStrategy.CheckResult._asdict()
      • CheckStrategy.CheckResult._field_defaults
      • CheckStrategy.CheckResult._fields
      • CheckStrategy.CheckResult._make()
      • CheckStrategy.CheckResult._replace()
      • CheckStrategy.CheckResult.check
      • CheckStrategy.CheckResult.server_name
      • CheckStrategy.CheckResult.status
    • CheckStrategy.NON_CRITICAL_CHECKS
    • CheckStrategy.__init__()
    • CheckStrategy._check_name()
    • CheckStrategy.init_check()
    • CheckStrategy.result()
  • Server
    • Server.XLOG_DB
    • Server.__default_check_strategy
    • Server.__init__()
    • Server._abc_impl
    • Server._build_path()
    • Server._check_has_monitoring_privileges()
    • Server._check_replication_slot()
    • Server._check_standby()
    • Server._check_streaming_supported()
    • Server._check_wal_info()
    • Server._check_wal_level()
    • Server._check_wal_queue()
    • Server._check_wal_streaming_preflight()
    • Server._init_archivers()
    • Server._init_bandwidth_limits()
    • Server._init_minimum_redundancy()
    • Server._init_postgres()
    • Server._init_retention_policies()
    • Server._make_directories()
    • Server.archive_wal()
    • Server.background_receive_wal()
    • Server.backup()
    • Server.check()
    • Server.check_archive()
    • Server.check_archiver_errors()
    • Server.check_backup()
    • Server.check_backup_validity()
    • Server.check_configuration()
    • Server.check_directories()
    • Server.check_identity()
    • Server.check_postgres()
    • Server.check_retention_policy_settings()
    • Server.check_sync_required()
    • Server.check_wal_streaming()
    • Server.check_wal_validity()
    • Server.close()
    • Server.create_physical_repslot()
    • Server.cron()
    • Server.cron_archive_wal()
    • Server.cron_check_backup()
    • Server.delete_backup()
    • Server.drop_repslot()
    • Server.fetch_remote_status()
    • Server.get_available_backups()
    • Server.get_backup()
    • Server.get_backup_ext_info()
    • Server.get_backup_id_from_name()
    • Server.get_children_timelines()
    • Server.get_first_backup_id()
    • Server.get_identity_file_path()
    • Server.get_last_backup_id()
    • Server.get_last_full_backup_id()
    • Server.get_next_backup()
    • Server.get_previous_backup()
    • Server.get_required_xlog_files()
    • Server.get_wal()
    • Server.get_wal_full_path()
    • Server.get_wal_info()
    • Server.get_wal_possible_paths()
    • Server.get_wal_sendfile()
    • Server.get_wal_until_next_backup()
    • Server.is_backup_locally_obsolete()
    • Server.kill()
    • Server.list_backups()
    • Server.load_primary_info()
    • Server.load_sync_wals_info()
    • Server.perform_delete_backup()
    • Server.primary_node_info()
    • Server.put_wal()
    • Server.read_identity_file()
    • Server.rebuild_xlogdb()
    • Server.receive_wal()
    • Server.recover()
    • Server.replication_status()
    • Server.report_backups()
    • Server.restart_processes()
    • Server.set_sync_starting_point()
    • Server.show()
    • Server.show_backup()
    • Server.status()
    • Server.status_postgres()
    • Server.status_retention_policies()
    • Server.status_wal_archiver()
    • Server.switch_wal()
    • Server.sync_backup()
    • Server.sync_cron()
    • Server.sync_status()
    • Server.sync_wals()
    • Server.systemid
    • Server.wait_for_wal()
    • Server.write_identity_file()
    • Server.write_sync_wals_info_file()
    • Server.xlogdb()
    • Server.xlogdb_file_name
  • SyncWalInfo
    • SyncWalInfo._asdict()
    • SyncWalInfo._field_defaults
    • SyncWalInfo._fields
    • SyncWalInfo._make()
    • SyncWalInfo._replace()
    • SyncWalInfo.last_position
    • SyncWalInfo.last_wal
• barman.utils module
  • BarmanEncoder
    • BarmanEncoder._datetime_to_str()
    • BarmanEncoder._decimal_to_float()
    • BarmanEncoder._timedelta_to_str()
    • BarmanEncoder._to_json()
    • BarmanEncoder.binary_to_str()
    • BarmanEncoder.default()
    • BarmanEncoder.method_list
    • BarmanEncoder.version_to_str()
  • BarmanEncoderV2
    • BarmanEncoderV2._datetime_to_str()
  • ChecksumAlgorithm
    • ChecksumAlgorithm._abc_impl
    • ChecksumAlgorithm.checksum()
    • ChecksumAlgorithm.checksum_from_str()
    • ChecksumAlgorithm.get_name()
  • SHA256
    • SHA256._abc_impl
    • SHA256.checksum()
  • check_aws_expiration_date_format()
  • check_aws_snapshot_lock_cool_off_period_range()
  • check_aws_snapshot_lock_duration_range()
  • check_aws_snapshot_lock_mode()
  • check_backup_name()
  • check_non_negative()
  • check_positive()
  • check_size()
  • check_tli()
  • configure_logging()
  • drop_privileges()
  • edit_config()
  • file_hash()
  • force_str()
  • fsync_dir()
  • fsync_file()
  • get_backup_id_using_shortcut()
  • get_backup_info_from_name()
  • get_log_levels()
  • human_readable_timedelta()
  • is_backup_id()
  • is_power_of_two()
  • lock_files_cleanup()
  • mkpath()
  • parse_log_level()
  • pretty_size()
  • range_fun()
  • redact_passwords()
  • simplify_version()
  • timeout()
  • timestamp()
  • total_seconds()
  • which()
  • with_metaclass()
• barman.version module
• barman.wal_archiver module
  • FileWalArchiver
    • FileWalArchiver.__init__()
    • FileWalArchiver._abc_impl
    • FileWalArchiver.check()
    • FileWalArchiver.fetch_remote_status()
    • FileWalArchiver.get_next_batch()
    • FileWalArchiver.status()
  • StreamingWalArchiver
    • StreamingWalArchiver.__init__()
    • StreamingWalArchiver._abc_impl
    • StreamingWalArchiver._is_synchronous()
    • StreamingWalArchiver._reset_streaming_status()
    • StreamingWalArchiver._truncate_partial_file_if_needed()
    • StreamingWalArchiver.check()
    • StreamingWalArchiver.fetch_remote_status()
    • StreamingWalArchiver.get_next_batch()
    • StreamingWalArchiver.receive_wal()
    • StreamingWalArchiver.status()
  • WalArchiver
    • WalArchiver.__init__()
    • WalArchiver._abc_impl
    • WalArchiver.archive()
    • WalArchiver.archive_wal()
    • WalArchiver.check()
    • WalArchiver.get_next_batch()
    • WalArchiver.receive_wal()
    • WalArchiver.status()
    • WalArchiver.summarise_error_files()
  • WalArchiverQueue
    • WalArchiverQueue.__init__()
    • WalArchiverQueue.run_size
    • WalArchiverQueue.size
• barman.xlog module
  • DEFAULT_XLOG_SEG_SIZE
  • HistoryFileData
    • HistoryFileData._asdict()
    • HistoryFileData._field_defaults
    • HistoryFileData._fields
    • HistoryFileData._make()
    • HistoryFileData._replace()
    • HistoryFileData.parent_tli
    • HistoryFileData.reason
    • HistoryFileData.switchpoint
    • HistoryFileData.tli
  • _validate_timeline()
  • _wal_archive_filter_fun()
  • check_archive_usable()
  • decode_hash_dir()
  • decode_history_file()
  • decode_segment_name()
  • diff_lsn()
  • encode_history_file_name()
  • encode_segment_name()
  • format_lsn()
  • generate_segment_names()
  • hash_dir()
  • is_any_xlog_file()
  • is_backup_file()
  • is_history_file()
  • is_partial_file()
  • is_wal_file()
  • location_from_xlogfile_name_offset()
  • location_to_xlogfile_name_offset()
  • parse_lsn()
  • xlog_segment_mask()
  • xlog_segments_per_file()

Module contents

The main Barman module