TABLESLURP(1)

NAME
tableslurp - cassandra backup utility

SYNOPSIS
tableslurp [-hp] [-k AWS_KEY ] [-s AWS_SECRET ] [--token AWS_TOKEN ] [-o OWNER ] [-g GROUP ] [-t THREADS ] [-f FILE ] [--force] [-n NAME ] bucket origin target

DESCRIPTION
tableslurp This is the companion script to the tablesnap(1) program which you can use to restore files from an Amazon S3 bucket to a local directory which you have write permissions on. While the code is straightforward, the program assumes the files you are restoring were previously backed up with tablesnap(1)

OPTIONS

-k, --aws-key=AWS_KEY
    Amazon S3 Key (defaults to AWS_ACCESS_KEY_ID in environment)

-s, --aws-secret=AWS_SECRET
    Amazon S3 Secret (defaults to AWS_SECRET_ACCESS_KEY in environment)

--token=AWS_SECURITY_TOKEN
    Amazon S3 Token (defaults to AWS_SECURITY_TOKEN in environment)

-p, --preserve
    preserve permissions (if they exist) from the source. This overrides -o and -g

-o OWNER, --owner=OWNER
    after download, chown files to this user

-g GROUP, --group=GROUP
    after download, chgrp files to this group

-t THREADS, --threads=THREADS
    split the download between this many threads (default 4)

-f FILE, --file=FILE
    if specified, will download the fileset this file belongs to instead of the latest one available

--force
    force download of files even if they already exist locally

-n NAME, --name=NAME
    use this name instead of the FQDN to prefix the bucket directory

ENVIRONMENT

AWS_ACCESS_KEY_ID
    Amazon access key to be used if --aws-key is not specified

AWS_SECRET_ACCESS_KEY
    Amazon secret key to be used if --aws-secret is not specified

AWS_SECURITY_TOKEN
    Amazon security token to be used if --aws-token is not specified

TDEBUG
    If set, logs are emitted at the DEBUG level (default INFO)

USER
    Used to determine the default uid/gid to chown files after download

DIAGNOSTICS
The following diagnostics may be issued on stderr:

Could not parse stat metadata for filename
    The JSON object downloaded from the bucket's "stat" key did not contain valid JSON
Cannot find anything to restore from PATH
    No -listdir.json files were found in the bucket with the specified prefix and name.
Incomplete stat metadata for PATH will ignore
    The JSON object downloaded from the bucket's "stat" key did not contain user and group keys.
Failed to download filename retrying
    The S3 download failed, it will be retried up to 5 times.

BUGS
Please report all bugs to the maintainers at https://github.com/JeremyGrosser/tablesnap/issues

AUTHORS
Jeremy Grosser <jeremy@synack.me> Jorge A Gallegos <kad@blegh.net>

SEE ALSO
tablechop(1), tablesnap(1)