Contributing to Barman#
Barman is an open-source project and we welcome contributions from the community.
Follow these guidelines when playing with Barman code and contributing patches to the project.
- Setting up a development installation
- Writing code
- Writing and running tests
- Writing and building documentation
- Style guide
- Tense and voice
- Future and conditional tenses
- Person
- Line length
- Sentence length
- Contractions
- Numbers
- Dates
- Capitalization
- Punctuation
- “This” without a noun
- Directing users up and down through a topic
- Bold (text)
- Courier (AKA inline code or monospace
text) - Code blocks
- Italics (text)
- Links
- Admonitions (notes, warnings, hints, etc.)
- Tables
- Lists
- Images
- Cross-reference labels standard
- Building the documentation
- Style guide
- Opening a PR
- Barman API docs
- barman package
- Subpackages
- barman.clients package
- Submodules
- barman.clients.cloud_backup module
- barman.clients.cloud_backup_delete module
- barman.clients.cloud_backup_keep module
- barman.clients.cloud_backup_list module
- barman.clients.cloud_backup_show module
- barman.clients.cloud_check_wal_archive module
- barman.clients.cloud_cli module
- barman.clients.cloud_compression module
- barman.clients.cloud_restore module
- barman.clients.cloud_walarchive module
- barman.clients.cloud_walrestore module
- barman.clients.walarchive module
ChecksumTarFileChecksumTarInfoChecksumTarInfo.__init__()ChecksumTarInfo._link_targetChecksumTarInfo._sparse_structsChecksumTarInfo.chksumChecksumTarInfo.devmajorChecksumTarInfo.devminorChecksumTarInfo.gidChecksumTarInfo.gnameChecksumTarInfo.linknameChecksumTarInfo.modeChecksumTarInfo.mtimeChecksumTarInfo.nameChecksumTarInfo.offsetChecksumTarInfo.offset_dataChecksumTarInfo.pax_headersChecksumTarInfo.sizeChecksumTarInfo.sparseChecksumTarInfo.tarfileChecksumTarInfo.typeChecksumTarInfo.uidChecksumTarInfo.uname
RemotePutWalbuild_ssh_command()connectivity_test()exit_with_error()hashCopyfileobj()main()parse_arguments()
- barman.clients.walrestore module
- Module contents
- Submodules
- barman.cloud_providers package
- Submodules
- Module contents
CloudProviderOptionUnsupportedCloudProviderUnsupported_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
- barman.clients package
- Submodules
- barman.annotations module
AnnotationManagerAnnotationManagerCloudAnnotationManagerCloud.__init__()AnnotationManagerCloud._abc_implAnnotationManagerCloud._get_annotation_path()AnnotationManagerCloud._get_base_path()AnnotationManagerCloud._populate_annotation_cache()AnnotationManagerCloud.delete_annotation()AnnotationManagerCloud.get_annotation()AnnotationManagerCloud.put_annotation()
AnnotationManagerFileKeepManagerKeepManagerMixinKeepManagerMixinCloud
- barman.backup module
BackupManagerBackupManager.DEFAULT_STATUS_FILTERBackupManager.DELETE_ANNOTATIONBackupManager.__init__()BackupManager._abc_implBackupManager._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.modeBackupManager.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
BackupExecutorBackupExecutor.__init__()BackupExecutor._abc_implBackupExecutor._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.modeBackupExecutor.status()
BackupStrategyBackupStrategy.START_TIME_REBackupStrategy.WAL_REBackupStrategy.__init__()BackupStrategy._abc_implBackupStrategy._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()
ConcurrentBackupStrategyExclusiveBackupStrategyExternalBackupExecutorExternalBackupExecutor.__init__()ExternalBackupExecutor._abc_implExternalBackupExecutor._local_check()ExternalBackupExecutor._remote_check()ExternalBackupExecutor._update_action_from_strategy()ExternalBackupExecutor.backup()ExternalBackupExecutor.backup_copy()ExternalBackupExecutor.check()ExternalBackupExecutor.fetch_remote_status()ExternalBackupExecutor.status()
LocalConcurrentBackupStrategyPassiveBackupExecutorPostgresBackupExecutorPostgresBackupExecutor.__init__()PostgresBackupExecutor._abc_implPostgresBackupExecutor._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()
PostgresBackupStrategyRsyncBackupExecutorSnapshotBackupExecutorSnapshotBackupExecutor.__init__()SnapshotBackupExecutor._abc_implSnapshotBackupExecutor._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
- barman.cli module
OrderedHelpFormatterarchive_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
BackupFileInfoCloudBackupCloudBackup.__init__()CloudBackup._abc_implCloudBackup._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()
CloudBackupCatalogCloudBackupCatalog.__init__()CloudBackupCatalog._abc_implCloudBackupCatalog._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()
CloudBackupSnapshotCloudBackupSnapshot.__init__()CloudBackupSnapshot._abc_implCloudBackupSnapshot._add_stats_to_backup_info()CloudBackupSnapshot._check_backup_preconditions()CloudBackupSnapshot._finalise_copy()CloudBackupSnapshot._take_backup()CloudBackupSnapshot._upload_backup_label()CloudBackupSnapshot.backup()
CloudBackupUploaderCloudBackupUploader.__init__()CloudBackupUploader._abc_implCloudBackupUploader._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_dirCloudBackupUploader._take_backup()CloudBackupUploader._upload_backup_label()CloudBackupUploader.backup()
CloudBackupUploaderBarmanCloudInterfaceCloudInterface.MAX_ARCHIVE_SIZECloudInterface.MAX_CHUNKS_PER_FILECloudInterface.MAX_DELETE_BATCH_SIZECloudInterface.MIN_CHUNK_SIZECloudInterface.__init__()CloudInterface._abc_implCloudInterface._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()
CloudProviderErrorCloudSnapshotInterfaceCloudSnapshotInterface._abc_implCloudSnapshotInterface._required_config_for_backupCloudSnapshotInterface._required_config_for_restoreCloudSnapshotInterface.delete_snapshot_backup()CloudSnapshotInterface.get_attached_volumes()CloudSnapshotInterface.instance_exists()CloudSnapshotInterface.take_snapshot_backup()CloudSnapshotInterface.validate_backup_config()CloudSnapshotInterface.validate_restore_config()
CloudTarUploaderCloudUploadControllerCloudUploadController.__init__()CloudUploadController._build_dest_name()CloudUploadController._get_tar()CloudUploadController.add_file()CloudUploadController.add_fileobj()CloudUploadController.close()CloudUploadController.copy_end_timeCloudUploadController.copy_start_timeCloudUploadController.statistics()CloudUploadController.upload_directory()CloudUploadController.upload_stats
CloudUploadingErrorDecompressingStreamingIOFileUploadStatisticsSnapshotMetadataSnapshotsInfoTarFileIgnoringTruncateVolumeMetadataconfigure_logging()copyfileobj_pad_truncate()
- barman.command_wrappers module
- barman.compression module
BZip2CompressorCommandCompressorCompressionCompressionManagerCompressorCustomCompressorGZipCompressionGZipCompressorGZipPgBaseBackupCompressionOptionInternalCompressorLZ4CompressionLZ4CompressorLZ4PgBaseBackupCompressionOptionNoneCompressionNonePgBaseBackupCompressionOptionPgBaseBackupCompressionPgBaseBackupCompressionConfigPgBaseBackupCompressionOptionPigzCompressorPyBZip2CompressorPyGZipCompressorXZCompressorZSTDCompressionZSTDCompressorZSTDPgBaseBackupCompressionOption_try_import_lz4()_try_import_zstd()get_pg_basebackup_compression()
- barman.config module
BackupOptionsBaseChangeBaseConfigConfigConfig.CONFIG_FILESConfig._QUOTE_REConfig.__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()
ConfigChangeConfigChangeSetConfigChangeSetEncoderConfigChangesProcessorConfigChangesQueueConfigMappingCsvOptionModelConfigPathConflictRecoveryOptionsServerConfigServerConfig.BARMAN_KEYSServerConfig.DEFAULTSServerConfig.FIXEDServerConfig.KEYSServerConfig.PARSERSServerConfig.__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
RsyncCopyControllerRsyncCopyController.CONFIG_CLASSRsyncCopyController.LIST_ONLY_RERsyncCopyController.PGCONTROL_CLASSRsyncCopyController.PGDATA_CLASSRsyncCopyController.TABLESPACE_CLASSRsyncCopyController.VANISHED_RERsyncCopyController.__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_timeRsyncCopyController.copy_start_timeRsyncCopyController.current_stepRsyncCopyController.item_listRsyncCopyController.jobs_doneRsyncCopyController.rsync_cacheRsyncCopyController.statistics()RsyncCopyController.temp_dirRsyncCopyController.total_steps
_FileItem_RsyncCopyItem_RsyncJob_init_worker()_run_worker()_worker_callable
- barman.diagnose module
- barman.exceptions module
AbortedRetryHookScriptArchivalBackupExceptionArchiverFailureBackupExceptionBackupFunctionsAccessRequiredBackupInfoBadInitialisationBackupManifestExceptionBackupPreconditionExceptionBadHistoryFileContentsBadXlogPrefixBadXlogSegmentNameBarmanExceptionCommandExceptionCommandFailedExceptionCommandMaxRetryExceededCompressionExceptionCompressionIncompatibilityConfigurationExceptionConninfoExceptionDataTransferFailureDuplicateWalFileFileNotFoundExceptionFsOperationFailedHookScriptExceptionInvalidRetentionPolicyLockFileBusyLockFileExceptionLockFileParsingErrorLockFilePermissionDeniedMatchingDuplicateWalFilePostgresAppNameErrorPostgresCheckpointPrivilegesRequiredPostgresConnectionErrorPostgresConnectionLostPostgresDuplicateReplicationSlotPostgresExceptionPostgresInvalidReplicationSlotPostgresIsInRecoveryPostgresObsoleteFeaturePostgresReplicationSlotInUsePostgresReplicationSlotsFullPostgresSuperuserRequiredPostgresUnsupportedFeatureRecoveryExceptionRecoveryInvalidTargetExceptionRecoveryPreconditionExceptionRecoveryStandbyModeExceptionRecoveryTargetActionExceptionRsyncListFilesFailureSnapshotBackupExceptionSnapshotInstanceNotFoundExceptionSshCommandExceptionSyncErrorSyncExceptionSyncNothingToDoSyncToBeDeletedTimeoutErrorUnknownBackupIdExceptionUnrecoverableHookScriptErrorWALFileExceptionWalArchiveContentError
- barman.fs module
LocalLibPathDeletionCommandPathDeletionCommandUnixCommandPathDeletionCommandUnixLocalCommandUnixLocalCommand.__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_match_path()_translate_to_regexp()_wildcard_match_path()path_allowed()unix_command_factory()
- barman.hooks module
- barman.infofile module
BackupInfoBackupInfo.DONEBackupInfo.EMPTYBackupInfo.FAILEDBackupInfo.KEEP_FULLBackupInfo.KEEP_STANDALONEBackupInfo.NONEBackupInfo.OBSOLETEBackupInfo.POTENTIALLY_OBSOLETEBackupInfo.RETENTION_STATUSBackupInfo.STARTEDBackupInfo.STATUS_ALLBackupInfo.STATUS_ARCHIVINGBackupInfo.STATUS_COPY_DONEBackupInfo.STATUS_NOT_EMPTYBackupInfo.SYNCINGBackupInfo.VALIDBackupInfo.WAITING_FOR_WALSBackupInfo.__init__()BackupInfo._hide_if_nullBackupInfo.backup_idBackupInfo.backup_labelBackupInfo.backup_nameBackupInfo.backup_typeBackupInfo.backup_versionBackupInfo.begin_offsetBackupInfo.begin_timeBackupInfo.begin_walBackupInfo.begin_xlogBackupInfo.children_backup_idsBackupInfo.cluster_sizeBackupInfo.compressionBackupInfo.config_fileBackupInfo.copy_statsBackupInfo.data_checksumsBackupInfo.deduplicated_sizeBackupInfo.deduplication_ratioBackupInfo.end_offsetBackupInfo.end_timeBackupInfo.end_walBackupInfo.end_xlogBackupInfo.errorBackupInfo.from_json()BackupInfo.get_external_config_files()BackupInfo.get_required_wal_segments()BackupInfo.has_childrenBackupInfo.hba_fileBackupInfo.ident_fileBackupInfo.included_filesBackupInfo.is_incrementalBackupInfo.modeBackupInfo.parent_backup_idBackupInfo.pg_major_version()BackupInfo.pgdataBackupInfo.server_nameBackupInfo.set_attribute()BackupInfo.sizeBackupInfo.snapshots_infoBackupInfo.statusBackupInfo.summarize_walBackupInfo.systemidBackupInfo.tablespacesBackupInfo.timelineBackupInfo.to_dict()BackupInfo.to_json()BackupInfo.versionBackupInfo.wal_directory()BackupInfo.xlog_segment_size
FieldFieldListFileLocalBackupInfoLocalBackupInfo.__init__()LocalBackupInfo.backup_managerLocalBackupInfo.configLocalBackupInfo.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_orphanLocalBackupInfo.save()LocalBackupInfo.serverLocalBackupInfo.walk_backups_tree()LocalBackupInfo.walk_to_root()
SyntheticBackupInfoTablespaceTypedFileWalFileInfodump_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
- barman.output module
AVAILABLE_WRITERSConsoleOutputWriterConsoleOutputWriter.SERVER_OUTPUT_PREFIXConsoleOutputWriter.__init__()ConsoleOutputWriter._err()ConsoleOutputWriter._out()ConsoleOutputWriter._print()ConsoleOutputWriter._record_check()ConsoleOutputWriter.activeConsoleOutputWriter.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.minimalConsoleOutputWriter.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_listConsoleOutputWriter.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_WRITERJsonOutputWriterJsonOutputWriter.__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_outputJsonOutputWriter.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()
NagiosOutputWriterclose()close_and_exit()debug()error()error_occurredexception()info()result()set_output_writer()warning()
- barman.postgres module
PostgreSQLPostgreSQL.CHECK_QUERYPostgreSQL.MINIMAL_VERSIONPostgreSQL.__init__()PostgreSQL._abc_implPostgreSQL._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_versionPostgreSQL.parse_dsn()PostgreSQL.server_major_versionPostgreSQL.server_txt_versionPostgreSQL.server_version
PostgreSQLConnectionPostgreSQLConnection.ANY_STREAMING_CLIENTPostgreSQLConnection.HEARTBEAT_QUERYPostgreSQLConnection.STANDBYPostgreSQLConnection.WALSTREAMERPostgreSQLConnection.__init__()PostgreSQLConnection._abc_implPostgreSQLConnection.archive_timeoutPostgreSQLConnection.checkpoint()PostgreSQLConnection.checkpoint_timeoutPostgreSQLConnection.connect()PostgreSQLConnection.create_restore_point()PostgreSQLConnection.current_sizePostgreSQLConnection.current_xlog_file_namePostgreSQLConnection.current_xlog_infoPostgreSQLConnection.current_xlog_locationPostgreSQLConnection.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_privilegesPostgreSQLConnection.has_checkpoint_privilegesPostgreSQLConnection.has_connectionPostgreSQLConnection.has_monitoring_privilegesPostgreSQLConnection.is_in_recoveryPostgreSQLConnection.is_superuserPostgreSQLConnection.name_mapPostgreSQLConnection.send_heartbeat_query()PostgreSQLConnection.server_txt_versionPostgreSQLConnection.start_concurrent_backup()PostgreSQLConnection.start_exclusive_backup()PostgreSQLConnection.stop_concurrent_backup()PostgreSQLConnection.stop_exclusive_backup()PostgreSQLConnection.switch_wal()PostgreSQLConnection.xlog_segment_size
PostgresKeepAliveStandbyPostgreSQLConnectionStandbyPostgreSQLConnection.__init__()StandbyPostgreSQLConnection._abc_implStandbyPostgreSQLConnection._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_atexit()_live_connections
- barman.postgres_plumbing module
- barman.process module
- barman.recovery_executor module
AssertionConfigIssueDetectionConfigurationFileMangelerIncrementalRecoveryExecutorIncrementalRecoveryExecutor.__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()
RecoveryExecutorRecoveryExecutor.__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()
RemoteConfigRecoveryExecutorSnapshotRecoveryExecutorSnapshotRecoveryExecutor._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()
TarballRecoveryExecutorrecovery_executor_factory()
- barman.remote_status module
- barman.retention_policies module
RecoveryWindowRetentionPolicyRecoveryWindowRetentionPolicy.__init__()RecoveryWindowRetentionPolicy._abc_implRecoveryWindowRetentionPolicy._backup_report()RecoveryWindowRetentionPolicy._kwRecoveryWindowRetentionPolicy._point_of_recoverability()RecoveryWindowRetentionPolicy._reRecoveryWindowRetentionPolicy._wal_report()RecoveryWindowRetentionPolicy.create()RecoveryWindowRetentionPolicy.debug()
RedundancyRetentionPolicyRetentionPolicyRetentionPolicy.__init__()RetentionPolicy._abc_implRetentionPolicy._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()
RetentionPolicyFactoryServerMetadataServerMetadataLiveSimpleWALRetentionPolicy
- barman.server module
CheckOutputStrategyCheckStrategyServerServer.XLOG_DBServer.__default_check_strategyServer.__init__()Server._abc_implServer._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.systemidServer.wait_for_wal()Server.write_identity_file()Server.write_sync_wals_info_file()Server.xlogdb()Server.xlogdb_file_name
SyncWalInfo
- barman.utils module
BarmanEncoderBarmanEncoderV2ChecksumAlgorithmSHA256check_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
FileWalArchiverStreamingWalArchiverStreamingWalArchiver.__init__()StreamingWalArchiver._abc_implStreamingWalArchiver._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()
WalArchiverWalArchiverQueue
- barman.xlog module
DEFAULT_XLOG_SEG_SIZEHistoryFileData_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()
- barman.annotations module
- Module contents
- Subpackages
- barman package