lumber

package module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 14, 2025 License: MIT Imports: 8 Imported by: 0

README

Lumber

A powerful and flexible command-line tool for database backups.

Lumber is a Go-based CLI utility that simplifies the process of creating backups for various databases, including PostgreSQL, MySQL, and MongoDB. It's built on top of the https://github.com/OffbyteSecure/dump_util.git library and offers features like compression, batch processing, and table exclusion to ensure efficient and customized database dumps.

Features

  • Multi-Database Support: Works with PostgreSQL, MySQL, and MongoDB.
  • Efficient Dumping: Uses concurrent workers and batch processing for fast backups.
  • Output Compression: Supports Gzip compression to save disk space.
  • Table Exclusion: Easily exclude specific tables or collections from your dump.
  • Customizable: Adjust batch size and the number of workers to fit your needs.

Installation

Install the library using:

go install github.com/OffbyteSecure/lumber@v1.0.1

Documentation

Index

Constants

View Source
const (
	Version = "v0.1.1"
	Author  = "OffbyteSecure"
	Website = "https://offbytesecure.com"
)

Version information

Variables

View Source
var (
	InfoColor    = color.New(color.FgCyan).SprintFunc()
	SuccessColor = color.New(color.FgGreen).SprintFunc()
	ErrorColor   = color.New(color.FgRed).SprintFunc()
	WarnColor    = color.New(color.FgYellow).SprintFunc()
	BannerColor  = color.New(color.FgMagenta, color.Bold).SprintFunc()
)

Colors for output

Functions

func NewRootCmd

func NewRootCmd(config *dt.DumperConfig) *cobra.Command

NewRootCmd creates a new Cobra root command for the dumper CLI.

func NewVersionCmd

func NewVersionCmd() *cobra.Command

NewVersionCmd creates a new Cobra command for displaying version information.

func PrintAnimatedBanner

func PrintAnimatedBanner()

PrintAnimatedBanner displays the ASCII art with a line-by-line animation.

Types

This section is empty.

Directories

Path Synopsis
cmd
lumber command
internal

Jump to

Keyboard shortcuts

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