Enum pliantdb_local::backup::Command

pub enum Command {
    Save {
        output_directory: Option<PathBuf>,
        output_name: Option<String>,
    },
    Load {
        backup: PathBuf,
    },
}

The command to execute.

Variants

Save

Exports all of the data into a straightforward file structure.

This command will create a single folder within output_directory named output_name. Within that folder, one subfolder will be created for each collection collection::Id. Each folder will contain files named <Document.header.id>.<Document.header.revision.id>, and the files will contain the raw bytes stored inside of the documents. Assuming you’re using the built in Serialization, the data will be in the CBOR format, otherwise it will be the bytes you stored within the database.

This format should make it easy to migrate data as well as back it up using many traditional methods, and should be considered the official way to do a full export of a database without using the API.

Fields of Save

output_directory: Option<PathBuf>

The directory to export the data within. The process will create a subfolder using output_name. If omitted, the export is performed next to the source database.

output_name: Option<String>

The name of the folder to export the data to. If not specified, the “.backup” is appended to the source database’s name and used.

Load

Loads all of the data from a previously saved backup. Any documents with the same IDs will be overwritten by the documents in this backup.

Fields of Load

backup: PathBuf

The path to the previously saved backup.

Implementations

impl Command

pub async fn execute(&self, database_path: PathBuf) -> Result<()>

Executes the command.

Trait Implementations

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl StructOpt for Command

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

pub fn from_args() -> Self

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

pub fn from_args_safe() -> Result<Self, Error>

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

pub fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

pub fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.

impl StructOptInternal for Command

fn augment_clap<'a, 'b>(app: App<'a, 'b>) -> App<'a, 'b>

fn from_subcommand<'a, 'b>(
    sub: (&'b str, Option<&'b ArgMatches<'a>>)
) -> Option<Self>

fn is_subcommand() -> bool