Skip to content

Legacy Aerospike backup tool (asbackup)

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

asbackup is the legacy CLI tool for creating backups from an Aerospike Database cluster.

Overview

asbackup backs up data from Aerospike Database according to a user-defined scope of specific namespaces, sets, or both. The scope supports further refinement with partition or time-based filters.

asbackup scans the database and fetches matching records, capturing essential data needed for recovery and ignoring non-critical system or secondary data.

As asbackup identifies records for backup, it serializes the data into a predefined format and writes it to a backup file or directory. Serialization converts the in-memory representation of records into a stable format that can be safely stored on disk.

asbackup supports backing up locally (see Get started) or to an Amazon S3 bucket.

asbackup limitations

asbackup has the following limitations:

  • asbackup requires read privileges or higher. See Configuring access control for more information.

  • Direct backups are supported only to S3, but you can use other services for storing the backup files after creating them locally.

  • You can control the size of backup files created by asbackup with the --file-limit option. When a backup file reaches the configured size, asbackup creates another file. asbackup does not have an upper limit for the size of an individual backup file.

  • When running in directory mode, each worker thread creates its own backup file. If the backup file is less than the size specified in --file-limit, the backup file is placed on a queue to be reused by another backup job.

  • Zstandard (zstd) is the only compression algorithm that asbackup supports.

Default backup content

asbackup backs up the following data by default:

  • Keys
    • Key metadata: digest, TTL, generation count, and key
    • Regular bins: String, Integer, Boolean, and Bytes
    • Collection data type (CDT) bins: List and Map
    • GeoJSON data type bins
    • HyperLogLog data type bins
  • Secondary index definitions
  • User-defined function (UDF) modules
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?