LucidDbSysRoot BACKUP DATABASE IF SPACE AVAILABLE

From Eigenpedia

Jump to: navigation, search

Contents

Syntax

CALL SYS_ROOT.BACKUP_DATABASE_IF_SPACE_AVAILABLE( archive_path, backup_type, compression_mode [, padding_byte_count ] )

Purpose

Executes a system backup of LucidDB, proceeding if and only if LucidDB determines that there is sufficient disk space to write out the data pages. Note that LucidDB is estimating the space requirements, and the estimates may not always be accurate, particularly for compressed backups.

Note that this procedure is currently only supported on Linux.

See LucidDbBackupRestore for an overview of backup and restore in LucidDB.

Parameters

See LucidDbSysRoot_BACKUP_DATABASE#Parameters for a description of the first three parameters.

  • padding_byte_count: [BIGINT] number of bytes that's added to LucidDB's estimate of the amount of space required to write out the backup files; compensates for errors (either positive or negative) in LucidDB's estimate of space requirements; defaults to 0 if unspecified

Output

See LucidDbSysRoot_BACKUP_DATABASE#Output.

Examples

See LucidDbSysRoot_BACKUP_DATABASE#Examples.

Exceptions

Attempting to use this routine on Windows will give an error "Unsupported operation: statvfs". Use BACKUP_DATABASE instead.

Personal tools