Struct controller::cloudnativepg::backups::BackupOnlineConfiguration

pub struct BackupOnlineConfiguration {
    pub immediate_checkpoint: Option<bool>,
    pub wait_for_archive: Option<bool>,
}

Configuration parameters to control the online/hot backup with volume snapshots Overrides the default settings specified in the cluster ‘.backup.volumeSnapshot.onlineConfiguration’ stanza

Fields

immediate_checkpoint: Option<bool>

Control whether the I/O workload for the backup initial checkpoint will be limited, according to the checkpoint_completion_target setting on the PostgreSQL server. If set to true, an immediate checkpoint will be used, meaning PostgreSQL will complete the checkpoint as soon as possible. false by default.

wait_for_archive: Option<bool>

If false, the function will return immediately after the backup is completed, without waiting for WAL to be archived. This behavior is only useful with backup software that independently monitors WAL archiving. Otherwise, WAL required to make the backup consistent might be missing and make the backup useless. By default, or when this parameter is true, pg_backup_stop will wait for WAL to be archived when archiving is enabled. On a standby, this means that it will wait only when archive_mode = always. If write activity on the primary is low, it may be useful to run pg_switch_wal on the primary in order to trigger an immediate segment switch.

Trait Implementations

impl Clone for BackupOnlineConfiguration

fn clone(&self) -> BackupOnlineConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BackupOnlineConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BackupOnlineConfiguration

fn default() -> BackupOnlineConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BackupOnlineConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for BackupOnlineConfiguration

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for BackupOnlineConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.