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.

Sign up for GitHub

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

cmd: add dvc update --to-remote docs #2175

Merged
merged 2 commits into from
Feb 18, 2021
+16 −2
Merged

cmd: add dvc update --to-remote docs #2175

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e89c12f
cmd: add dvc update --to-remote docs
isidentical Feb 10, 2021
2f23613
Update content/docs/command-reference/update.md
shcheklein Feb 17, 2021
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
18 changes: 16 additions & 2 deletions content/docs/command-reference/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ repositories</abbr>, and the corresponding import stage `.dvc` files.
## Synopsis

```usage
usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R]
targets [targets ...]
usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R] [--to-remote]
[-r <name>] [-j <number>] targets [targets ...]

positional arguments:
targets Import stage .dvc files to update. Using -R, directories
Expand Down Expand Up @@ -49,6 +49,20 @@ $ dvc update --rev master
directory and its subdirectories for import stage `.dvc` files to inspect. If
there are no directories among the targets, this option is ignored.

- `--to-remote` - update the import `.dvc` file and
[transfer](/doc/command-reference/import-url#example-import-straight-to-the-remote)
the new data directly to remote storage (the default one unless `-r` is used).
No changes are done in the <abbr>workspace</abbr>. Use `dvc pull` to get the
data locally.
Comment on lines +52 to +56
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We forgot to mention that this only works for import-url imports @isidentical — per iterative/dvc/pull/5475

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

p.s. can you update --to-remote data import-urled without --to-remote? I assume there's no restriction to do so but just curious.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

p.s. can you update --to-remote data import-urled without --to-remote

yes


- `-r <name>`, `--remote <name>` - name of the
[remote storage](/doc/command-reference/remote) (can only be used with
`--to-remote`).

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from the source. The default value is `4 * cpu_count()`. For SSH remotes, the
default is `4`. Using more jobs may speed up the operation.

- `-h`, `--help` - prints the usage/help message, and exit.

- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
Expand Down