pg

Documentation

Index

• Constants
• Variables
• func DeleteGarbageArgsValidator(cmd *cobra.Command, args []string) error
• func Execute()

Constants

const (
	PrettyFlag = "pretty"
	JSONFlag   = "json"
	DetailFlag = "detail"
)

const (
	BackupMarkShortDescription = "Marks a backup permanent or impermanent"
	BackupMarkLongDescription  = `` /* 147-byte string literal not displayed */

	ImpermanentDescription = "Marks a backup impermanent"
	ImpermanentFlag        = "impermanent"
)

const (
	CatchupFetchShortDescription = "Fetches an incremental backup from storage"
	UseNewUnwrapDescription      = "Use the new implementation of catchup unwrap (beta)"
)

const (
	WalRestoreUsage            = "wal-restore target-pgdata source-pgdata"
	WalRestoreShortDescription = "Restores WAL segments from storage."
	WalRestoreLongDescription  = "Restores the missing WAL segments that will be needed to perform pg_rewind from storage."
)

const (
	WalShowUsage            = "wal-show"
	WalShowShortDescription = "Show storage WAL segments info grouped by timelines."
	WalShowLongDescription  = "Show information such as missing segments for each timeline found in storage. " +
		"Optionally, show available backups for each timeline."
)

const (
	WalVerifyUsage            = "wal-verify"
	WalVerifyShortDescription = "Verify WAL storage folder. Available checks: integrity, timeline."
	WalVerifyLongDescription  = "Run a set of specified checks to ensure WAL storage health."
)

const DaemonShortDescription = "Uploads a WAL file to storage"

const DeleteGarbageExamples = `` /* 226-byte string literal not displayed */

const DeleteGarbageUse = "garbage [ARCHIVES|BACKUPS]"

const UseSentinelTimeDescription = "Use backup creation time from sentinel for backups ordering."

const UseSentinelTimeFlag = "use-sentinel-time"

const WalFetchShortDescription = "Fetches a WAL file from storage"

const WalPrefetchShortDescription = `Used for prefetching process forking
and should not be called by user.`

const WalPushShortDescription = "Uploads a WAL file to storage"

const WalgShortDescription = "PostgreSQL backup tool"

Variables

var (
	Cmd = &cobra.Command{
		Use:     "wal-g",
		Short:   WalgShortDescription,
		Version: strings.Join([]string{walgVersion, gitRevision, buildDate, "PostgreSQL"}, "\t"),
		PersistentPreRun: func(cmd *cobra.Command, args []string) {
			err := internal.AssertRequiredSettingsSet()
			tracelog.ErrorLogger.FatalOnError(err)

			if viper.IsSet(internal.PgWalSize) {
				postgres.SetWalSize(viper.GetUint64(internal.PgWalSize))
			}
		},
	}
)

var WalPrefetchCmd = &cobra.Command{
	Use:    "wal-prefetch wal_name prefetch_location",
	Short:  WalPrefetchShortDescription,
	Args:   cobra.ExactArgs(2),
	Hidden: true,
	Run: func(cmd *cobra.Command, args []string) {
		reconfigureLoggers()

		folder, err := internal.ConfigureFolder()
		tracelog.ErrorLogger.FatalOnError(err)

		failover, err := internal.InitFailoverStorages()
		tracelog.ErrorLogger.FatalOnError(err)

		folderReader, err := multistorage.NewStorageFolderReader(folder, failover)
		tracelog.ErrorLogger.FatalOnError(err)

		postgres.HandleWALPrefetch(folderReader, args[0], args[1])
	},
}

WalPrefetchCmd represents the walPrefetch command

Functions

func DeleteGarbageArgsValidator

func DeleteGarbageArgsValidator(cmd *cobra.Command, args []string) error

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the PgCmd.