backup

package module

Go to main page

Versions in this module

v0

v0.5.1

Jul 8, 2025

v0.5.0

Jul 7, 2025

v0.4.0

May 14, 2025

Changes in this version

type ConfigBackup

+ PipelinesMode pipeline.Mode

v0.3.1

Dec 23, 2024

v0.3.0

Dec 1, 2024

v0.2.0

Nov 20, 2024

Changes in this version

+ func ReadPrivateKey(encPolicy *EncryptionPolicy, saConfig *SecretAgentConfig) ([]byte, error)

type BackupConfig

+ Compact bool

+ Continue bool

+ NoTTLOnly bool

+ NodeList []string

+ OutputFilePrefix string

+ PageSize int64

+ ParallelNodes bool

+ ParallelRead int

+ ParallelWrite int

+ PartitionFilters []*a.PartitionFilter

+ StateFile string

+ SyncPipelines bool

type RestoreConfig

+ ExtraTTL int64

+ IgnoreRecordError bool

v0.1.0

Aug 20, 2024

Changes in this version

+ type BackupConfig struct

+ Bandwidth int

+ BinList []string

+ CompressionPolicy *CompressionPolicy

+ EncoderType EncoderType

+ EncryptionPolicy *EncryptionPolicy

+ FileLimit int64

+ InfoPolicy *a.InfoPolicy

+ ModAfter *time.Time

+ ModBefore *time.Time

+ Namespace string

+ NoIndexes bool

+ NoRecords bool

+ NoUDFs bool

+ Parallel int

+ Partitions PartitionRange

+ RecordsPerSecond int

+ ScanPolicy *a.ScanPolicy

+ SecretAgentConfig *SecretAgentConfig

+ SetList []string

type CompressionPolicy

+ func (p *CompressionPolicy) Validate() error

type EncryptionPolicy

+ func (p *EncryptionPolicy) ReadPrivateKey(agent *SecretAgentConfig) ([]byte, error)

+ func (p *EncryptionPolicy) Validate() error

+ type PartitionRange struct

+ Begin int

+ Count int

+ func NewPartitionRange(begin, count int) PartitionRange

+ func PartitionRangeAll() PartitionRange

+ type RestoreConfig struct

+ Bandwidth int

+ BatchSize int

+ BinList []string

+ CompressionPolicy *CompressionPolicy

+ DisableBatchWrites bool

+ EncoderType EncoderType

+ EncryptionPolicy *EncryptionPolicy

+ InfoPolicy *a.InfoPolicy

+ MaxAsyncBatches int

+ Namespace *RestoreNamespaceConfig

+ NoIndexes bool

+ NoRecords bool

+ NoUDFs bool

+ Parallel int

+ RecordsPerSecond int

+ RetryPolicy *models.RetryPolicy

+ SecretAgentConfig *SecretAgentConfig

+ SetList []string

+ WritePolicy *a.WritePolicy

type RestoreNamespaceConfig

+ func (n *RestoreNamespaceConfig) Validate() error

type SecretAgentConfig

+ func (s *SecretAgentConfig) GetSecret(key string) (string, error)

+ func (s *SecretAgentConfig) Validate() error

type StreamingReader

+ func NewStreamingReaderLocal(dir string, eType EncoderType) (StreamingReader, error)

+ func NewStreamingReaderS3(ctx context.Context, cfg *s3.Config, eType EncoderType) (StreamingReader, error)

type Writer

+ func NewWriterLocal(dir string, removeFiles bool) (Writer, error)

+ func NewWriterS3(ctx context.Context, cfg *s3.Config, removeFiles bool) (Writer, error)

v0.0.1

Jun 29, 2025

v0.0.0

Jun 29, 2025

Changes in this version

+ const CompressNone

+ const CompressZSTD

+ const EncryptAES128

+ const EncryptAES256

+ const EncryptNone

+ const MaxParallel

+ const MaxPartitions

+ const MinParallel

+ func NewPartitionFilterAfterDigest(namespace, digest string) (*a.PartitionFilter, error)

+ func NewPartitionFilterAll() *a.PartitionFilter

+ func NewPartitionFilterByDigest(namespace, digest string) (*a.PartitionFilter, error)

+ func NewPartitionFilterByID(partitionID int) *a.PartitionFilter

+ func NewPartitionFilterByRange(begin, count int) *a.PartitionFilter

+ func ParsePartitionFilterListString(namespace, filters string) ([]*a.PartitionFilter, error)

+ func ParsePartitionFilterString(namespace, filter string) (*a.PartitionFilter, error)

+ func ParseSecret(config *SecretAgentConfig, secret string) (string, error)

+ type AerospikeClient interface

+ BatchOperate func(policy *a.BatchPolicy, records []a.BatchRecordIfc) a.Error

+ Close func()

+ Cluster func() *a.Cluster

+ CreateComplexIndex func(policy *a.WritePolicy, namespace string, set string, indexName string, ...) (*a.IndexTask, a.Error)

+ DropIndex func(policy *a.WritePolicy, namespace string, set string, indexName string) a.Error

+ GetDefaultInfoPolicy func() *a.InfoPolicy

+ GetDefaultScanPolicy func() *a.ScanPolicy

+ GetDefaultWritePolicy func() *a.WritePolicy

+ GetNodes func() []*a.Node

+ Put func(policy *a.WritePolicy, key *a.Key, bins a.BinMap) a.Error

+ PutPayload func(policy *a.WritePolicy, key *a.Key, payload []byte) a.Error

+ RegisterUDF func(policy *a.WritePolicy, udfBody []byte, serverPath string, language a.Language) (*a.RegisterTask, a.Error)

+ ScanNode func(scanPolicy *a.ScanPolicy, node *a.Node, namespace string, setName string, ...) (*a.Recordset, a.Error)

+ ScanPartitions func(scanPolicy *a.ScanPolicy, partitionFilter *a.PartitionFilter, namespace string, ...) (*a.Recordset, a.Error)

+ type BackupHandler struct

+ func (bh *BackupHandler) GetMetrics() *models.Metrics

+ func (bh *BackupHandler) GetStats() *models.BackupStats

+ func (bh *BackupHandler) Wait(ctx context.Context) error

+ type Client struct

+ func NewClient(ac AerospikeClient, opts ...ClientOpt) (*Client, error)

+ func (c *Client) AerospikeClient() AerospikeClient

+ func (c *Client) Backup(ctx context.Context, config *ConfigBackup, writer Writer, ...) (*BackupHandler, error)

+ func (c *Client) BackupXDR(ctx context.Context, config *ConfigBackupXDR, writer Writer) (*HandlerBackupXDR, error)

+ func (c *Client) Estimate(ctx context.Context, config *ConfigBackup, estimateSamples int64) (uint64, error)

+ func (c *Client) Restore(ctx context.Context, config *ConfigRestore, streamingReader StreamingReader) (Restorer, error)

+ type ClientOpt func(*Client)

+ func WithID(id string) ClientOpt

+ func WithLogger(logger *slog.Logger) ClientOpt

+ func WithScanLimiter(sem *semaphore.Weighted) ClientOpt

+ type CompressionPolicy struct

+ Level int

+ Mode string

+ func NewCompressionPolicy(mode string, level int) *CompressionPolicy

+ type ConfigBackup struct

+ Bandwidth int

+ BinList []string

+ Compact bool

+ CompressionPolicy *CompressionPolicy

+ Continue bool

+ EncoderType EncoderType

+ EncryptionPolicy *EncryptionPolicy

+ FileLimit uint64

+ InfoPolicy *a.InfoPolicy

+ InfoRetryPolicy *models.RetryPolicy

+ MetricsEnabled bool

+ ModAfter *time.Time

+ ModBefore *time.Time

+ Namespace string

+ NoIndexes bool

+ NoRecords bool

+ NoTTLOnly bool

+ NoUDFs bool

+ NodeList []string

+ OutputFilePrefix string

+ PageSize int64

+ ParallelNodes bool

+ ParallelRead int

+ ParallelWrite int

+ PartitionFilters []*a.PartitionFilter

+ RackList []int

+ RecordsPerSecond int

+ ScanPolicy *a.ScanPolicy

+ SecretAgentConfig *SecretAgentConfig

+ SetList []string

+ StateFile string

+ func NewDefaultBackupConfig() *ConfigBackup

+ type ConfigBackupXDR struct

+ AckQueueSize int

+ CompressionPolicy *CompressionPolicy

+ DC string

+ EncoderType EncoderType

+ EncryptionPolicy *EncryptionPolicy

+ FileLimit uint64

+ Forward bool

+ InfoPolicy *a.InfoPolicy

+ InfoPolingPeriod time.Duration

+ InfoRetryPolicy *models.RetryPolicy

+ LocalAddress string

+ LocalPort int

+ MaxConnections int

+ MaxThroughput int

+ MetricsEnabled bool

+ Namespace string

+ ParallelWrite int

+ ReadTimeout time.Duration

+ ResultQueueSize int

+ Rewind string

+ SecretAgentConfig *SecretAgentConfig

+ StartTimeout time.Duration

+ TLSConfig *tls.Config

+ WriteTimeout time.Duration

+ type ConfigRestore struct

+ Bandwidth int

+ BatchSize int

+ BinList []string

+ CompressionPolicy *CompressionPolicy

+ DisableBatchWrites bool

+ EncoderType EncoderType

+ EncryptionPolicy *EncryptionPolicy

+ ExtraTTL int64

+ IgnoreRecordError bool

+ InfoPolicy *a.InfoPolicy

+ InfoRetryPolicy *models.RetryPolicy

+ MaxAsyncBatches int

+ MetricsEnabled bool

+ Namespace *RestoreNamespaceConfig

+ NoIndexes bool

+ NoRecords bool

+ NoUDFs bool

+ Parallel int

+ RecordsPerSecond int

+ RetryPolicy *models.RetryPolicy

+ SecretAgentConfig *SecretAgentConfig

+ SetList []string

+ ValidateOnly bool

+ WritePolicy *a.WritePolicy

+ func NewDefaultRestoreConfig() *ConfigRestore

+ type Decoder interface

+ NextToken func() (T, error)

+ func NewDecoder[T models.TokenConstraint](eType EncoderType, src io.Reader, fileNumber uint64, fileName string) (Decoder[T], error)

+ type Encoder interface

+ EncodeToken func(T) ([]byte, error)

+ GenerateFilename func(prefix, suffix string) string

+ GetHeader func(uint64) []byte

+ func NewEncoder[T models.TokenConstraint](eType EncoderType, namespace string, compact bool) Encoder[T]

+ type EncoderType int

+ const EncoderTypeASB

+ const EncoderTypeASBX

+ type EncryptionPolicy struct

+ KeyEnv *string

+ KeyFile *string

+ KeySecret *string

+ Mode string

+ type HandlerBackupXDR struct

+ func (bh *HandlerBackupXDR) GetMetrics() *models.Metrics

+ func (bh *HandlerBackupXDR) GetStats() *models.BackupStats

+ func (bh *HandlerBackupXDR) Wait(ctx context.Context) error

+ type RestoreHandler struct

+ func (rh *RestoreHandler[T]) GetMetrics() *models.Metrics

+ func (rh *RestoreHandler[T]) GetStats() *models.RestoreStats

+ func (rh *RestoreHandler[T]) Wait(ctx context.Context) error

+ type RestoreNamespaceConfig struct

+ Destination *string

+ Source *string

+ type Restorer interface

+ GetMetrics func() *models.Metrics

+ GetStats func() *models.RestoreStats

+ Wait func(ctx context.Context) error

+ type SecretAgentConfig struct

+ Address *string

+ CaFile *string

+ ConnectionType *string

+ IsBase64 *bool

+ Port *int

+ TimeoutMillisecond *int

+ type State struct

+ Counter int

+ FileName string

+ FilePath string

+ RecordStates map[int]models.PartitionFilterSerialized

+ RecordStatesSaved map[int]models.PartitionFilterSerialized

+ RecordsStateChan chan models.PartitionFilterSerialized

+ SaveCommandChan chan int

+ func NewState(ctx context.Context, config *ConfigBackup, reader StreamingReader, ...) (*State, error)

+ type StreamingReader interface

+ GetNumber func() int64

+ GetSize func() int64

+ GetType func() string

+ ListObjects func(ctx context.Context, path string) ([]string, error)

+ StreamFile func(ctx context.Context, filename string, readersCh chan<- models.File, ...)

+ StreamFiles func(context.Context, chan<- models.File, chan<- error)

+ type Writer interface

+ GetType func() string

+ NewWriter func(ctx context.Context, filename string) (io.WriteCloser, error)

+ Remove func(ctx context.Context, path string) error

+ RemoveFiles func(ctx context.Context) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL