Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document export and unhide from CLI #915

Merged
merged 3 commits into from
Nov 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions cmd/lakectl/cmd/export.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ import (
)

var exportCmd = &cobra.Command{
Use: "export",
Hidden: true,
Short: "create and manage continuous export",
Long: `Read set and update continuous export configurations and trigger exports`,
Use: "export",
Short: "create and manage continuous export",
Long: `Read set and update continuous export configurations and trigger exports`,
}

// exportGetCmd get continuous export configuration for branch
Expand Down
2 changes: 1 addition & 1 deletion ddl/000009_export_current.down.sql
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BEGIN;

DROP TABLE IF EXISTS catalog_branches_export_state;
DROP TYPE catalog_branches_export_status;
DROP TYPE IF EXISTS catalog_branch_export_status;

END;
53 changes: 53 additions & 0 deletions docs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -846,6 +846,59 @@ Global Flags:

````

#### `lakectl export get `
````text
get continuous export configuration for branch

Usage:
lakectl export get <branch uri> [flags]

Flags:
-h, --help help for get

Global Flags:
-c, --config string config file (default is $HOME/.lakectl.yaml)
-f, --force without prompting for confirmation
--no-color don't use fancy output colors (default when not attached to an interactive terminal)

````

#### `lakectl export set `
````text
set continuous export configuration for branch

Usage:
lakectl export set <branch uri> [flags]

Flags:
-h, --help help for set
--path string export objects to this path
--prefix-regex stringArray list of regexps of keys to exported last in each prefix (for signalling)
--status-path string write export status object to this path

Global Flags:
-c, --config string config file (default is $HOME/.lakectl.yaml)
-f, --force without prompting for confirmation
--no-color don't use fancy output colors (default when not attached to an interactive terminal)

````

#### `lakectl export run `
````text
export requested branch now

Usage:
lakectl export run [flags]

Flags:
-h, --help help for run

Global Flags:
-c, --config string config file (default is $HOME/.lakectl.yaml)
-f, --force without prompting for confirmation
--no-color don't use fancy output colors (default when not attached to an interactive terminal)

````
### lakeFS URI pattern

Different CLI and UI operations use `lakefs://` URIs.
Expand Down