archiver

Documentation

Overview

Package archiver contains the logic of the CloudNativePG WAL archiver

Index

• func ArchiveAllReadyWALs(ctx context.Context, cluster *apiv1.Cluster, pgData string) error
• func Run(ctx context.Context, podName, pgData string, cluster *apiv1.Cluster, ...) error
• type ErrMissingWALArchiverPlugin
  • func (e ErrMissingWALArchiverPlugin) Error() string

Functions

func ArchiveAllReadyWALs

func ArchiveAllReadyWALs(
	ctx context.Context,
	cluster *apiv1.Cluster,
	pgData string,
) error

ArchiveAllReadyWALs ensures that all WAL files that are in the "ready" queue have been archived. This is used to ensure that a former primary will archive the WAL files in its queue even in case of an unclean shutdown.

func Run

func Run(
	ctx context.Context,
	podName, pgData string,
	cluster *apiv1.Cluster,
	walName string,
) error

Run implements the WAL archiving process given the current cluster definition and the current Pod Name.

Types

type ErrMissingWALArchiverPlugin

type ErrMissingWALArchiverPlugin struct {
	// PluginName is the name of the plugin that is missing
	PluginName string
}

ErrMissingWALArchiverPlugin is raised when we try to archive a WAL file with a CNPG-i plugin whose socket does not exist.

func (ErrMissingWALArchiverPlugin) Error

func (e ErrMissingWALArchiverPlugin) Error() string

Error implements the error interface