From 7e8f35a14857533eb2b349bae7564d8b2014fb4e Mon Sep 17 00:00:00 2001 From: Dave Berenbaum Date: Mon, 31 Jul 2023 12:07:36 -0400 Subject: [PATCH] guide: add hash field (#4735) --- content/docs/user-guide/project-structure/dvc-files.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/docs/user-guide/project-structure/dvc-files.md b/content/docs/user-guide/project-structure/dvc-files.md index ebddf1c6ab..4288411937 100644 --- a/content/docs/user-guide/project-structure/dvc-files.md +++ b/content/docs/user-guide/project-structure/dvc-files.md @@ -47,6 +47,7 @@ The following subfields may be present under `outs` entries: | Field | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `path` | (Required) Path to the file or directory (relative to `wdir` which defaults to the file's location) | +| `hash` | Hash algorithm for the file or directory being tracked with DVC (only `md5` is currently supported). | | `md5`
`etag`
`checksum` | Hash value for the file or directory being tracked with DVC. MD5 is used for most locations (local file system and SSH); [ETag] for HTTP, S3, or Azure [external outputs]; and a special _checksum_ for HDFS and WebHDFS. | | `version_id` | Version ID native to the cloud provider. Used to track each file in the cloud if [cloud versioning] is enabled. | | `size` | Size of the file or directory (sum of all files) | @@ -68,6 +69,7 @@ The following subfields may be present under `deps` entries: | Field | Description | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `path` | (Required) Path to the dependency (relative to `wdir`, which defaults to the file's location) | +| `hash` | Hash algorithm for the file or directory being tracked with DVC (only `md5` is currently supported). | | `md5`
`etag`
`checksum` | Only in external dependencies created with `dvc import-url`: Hash value of the imported file or directory. MD5 is used for local paths and SSH; [ETag] for HTTP, S3, GCS, and Azure; and a special _checksum_ for HDFS and WebHDFS. | | `size` | Size of the file or directory (sum of all files). | | `nfiles` | If this dependency is a directory, the number of files inside (recursive). |