diff --git a/docs/automate/cmemc-command-line-interface/command-reference/dataset/resource/index.md b/docs/automate/cmemc-command-line-interface/command-reference/dataset/resource/index.md index 253bca6d1..eb852504f 100644 --- a/docs/automate/cmemc-command-line-interface/command-reference/dataset/resource/index.md +++ b/docs/automate/cmemc-command-line-interface/command-reference/dataset/resource/index.md @@ -1,7 +1,7 @@ --- title: "cmemc: Command Group - dataset resource" description: "List, inspect or delete dataset file resources." -icon: eccenca/artefact-file +icon: octicons/cross-reference-24 tags: - cmemc --- @@ -12,6 +12,10 @@ List, inspect or delete dataset file resources. File resources are identified by their paths and project IDs. +!!! warning + This command group is deprecated and will be removed with the next major release. Please use the `project file` command group instead. + + ## dataset resource list @@ -24,7 +28,7 @@ $ cmemc dataset resource list [OPTIONS] -Outputs a table or a list of dataset resources (files). +Outputs a table or a list of file resources. @@ -32,9 +36,8 @@ Outputs a table or a list of dataset resources (files). ```text --raw Outputs raw JSON. - --id-only Lists only resource names and no other metadata. - This is useful for piping the IDs into other - commands. + --id-only Lists only resource IDs and no other metadata. This + is useful for piping the IDs into other commands. --filter ... Filter file resources based on metadata. First parameter CHOICE can be one of ['project', 'regex']. The second parameter is based on CHOICE, @@ -52,7 +55,7 @@ $ cmemc dataset resource delete [OPTIONS] [RESOURCE_IDS]... -There are three selection mechanisms: with specific IDs, only those specified resources will be deleted; by using `--filter`, resources based on the filter type and value will be deleted; using `--all` will delete all resources. +There are three selection mechanisms: with specific IDs - only those specified resources will be deleted; by using `--filter` - resources based on the filter type and value will be deleted; by using `--all`, which will delete all resources. diff --git a/docs/automate/cmemc-command-line-interface/command-reference/index.md b/docs/automate/cmemc-command-line-interface/command-reference/index.md index de5da3414..deb7a5a00 100644 --- a/docs/automate/cmemc-command-line-interface/command-reference/index.md +++ b/docs/automate/cmemc-command-line-interface/command-reference/index.md @@ -98,6 +98,12 @@ tags: | [project](project/index.md) | [delete](project/index.md#project-delete) | Delete projects. | | [project](project/index.md) | [create](project/index.md#project-create) | Create projects. | | [project](project/index.md) | [reload](project/index.md#project-reload) | Reload projects from the workspace provider. | +| [project file](project/file/index.md) | [list](project/file/index.md#project-file-list) | List available file resources. | +| [project file](project/file/index.md) | [delete](project/file/index.md#project-file-delete) | Delete file resources. | +| [project file](project/file/index.md) | [download](project/file/index.md#project-file-download) | Download file resources to the local file system. | +| [project file](project/file/index.md) | [upload](project/file/index.md#project-file-upload) | Upload a file to a project. | +| [project file](project/file/index.md) | [inspect](project/file/index.md#project-file-inspect) | Display all metadata of a file resource. | +| [project file](project/file/index.md) | [usage](project/file/index.md#project-file-usage) | Display all usage data of a file resource. | | [project variable](project/variable/index.md) | [list](project/variable/index.md#project-variable-list) | List available project variables. | | [project variable](project/variable/index.md) | [get](project/variable/index.md#project-variable-get) | Get the value or other data of a project variable. | | [project variable](project/variable/index.md) | [delete](project/variable/index.md#project-variable-delete) | Delete a project variable. | diff --git a/docs/automate/cmemc-command-line-interface/command-reference/project/file/index.md b/docs/automate/cmemc-command-line-interface/command-reference/project/file/index.md new file mode 100644 index 000000000..66577b561 --- /dev/null +++ b/docs/automate/cmemc-command-line-interface/command-reference/project/file/index.md @@ -0,0 +1,184 @@ +--- +title: "cmemc: Command Group - project file" +description: "List, inspect, up-/download or delete project file resources." +icon: eccenca/artefact-file +tags: + - Files + - cmemc +--- +# project file Command Group + + +List, inspect, up-/download or delete project file resources. + +File resources are identified with a `RESOURCE_ID` which is a concatenation of its project ID and its relative path, e.g. `my-project:path-to/table.csv`. + +!!! note + To get a list of existing file resources, execute the `project file list` command or use tab-completion. + + + +## project file list + +List available file resources. + +```shell-session title="Usage" +$ cmemc project file list [OPTIONS] +``` + + + + +Outputs a table or a list of file resources. + + + +??? info "Options" + ```text + + --raw Outputs raw JSON. + --id-only Lists only resource IDs and no other metadata. This + is useful for piping the IDs into other commands. + --filter ... Filter file resources based on metadata. First + parameter CHOICE can be one of ['project', + 'regex']. The second parameter is based on CHOICE, + e.g. a project ID or a regular expression string. + ``` + +## project file delete + +Delete file resources. + +```shell-session title="Usage" +$ cmemc project file delete [OPTIONS] [RESOURCE_IDS]... +``` + + + + +There are three selection mechanisms: with specific IDs - only those specified resources will be deleted; by using `--filter` - resources based on the filter type and value will be deleted; by using `--all`, which will delete all resources. + + + +??? info "Options" + ```text + + --force Delete resource even if in use by a task. + -a, --all Delete all resources. This is a dangerous option, + so use it with care. + --filter ... Filter file resources based on metadata. First + parameter CHOICE can be one of ['project', + 'regex']. The second parameter is based on CHOICE, + e.g. a project ID or a regular expression string. + ``` + +## project file download + +Download file resources to the local file system. + +```shell-session title="Usage" +$ cmemc project file download [OPTIONS] [RESOURCE_IDS]... +``` + + + + +This command downloads one or more file resources from projects to your local file system. Files are saved with their resource names in the output directory. + +Resources are identified by their IDs in the format `PROJECT_ID`:`RESOURCE_NAME`. + +```shell-session title="Example" +$ cmemc project file download my-proj:my-file.csv +``` + + +```shell-session title="Example" +$ cmemc project file download my-proj:file1.csv my-proj:file2.csv --output-dir /tmp +``` + + + + +??? info "Options" + ```text + + --output-dir DIRECTORY The directory where the downloaded files will be + saved. If this directory does not exist, it will be + created. [default: .] + --replace Replace existing files. This is a dangerous option, + so use it with care! + ``` + +## project file upload + +Upload a file to a project. + +```shell-session title="Usage" +$ cmemc project file upload [OPTIONS] INPUT_PATH +``` + + + + +This command uploads a file to a project as a file resource. + +!!! note + If you want to create a dataset from your file, the `dataset create` command is maybe the better option. + + +```shell-session title="Example" +$ cmemc project file upload my-file.csv --project my-project +``` + + + + +??? info "Options" + ```text + + --project TEXT The project where you want to upload the file. If there is + only one project in the workspace, this option can be + omitted. + --path TEXT The path/name of the file resource in the project (e.g., + 'data/file.csv'). If not specified, the local file name will + be used. + --replace Replace existing file resource. This is a dangerous option, + so use it with care! + ``` + +## project file inspect + +Display all metadata of a file resource. + +```shell-session title="Usage" +$ cmemc project file inspect [OPTIONS] RESOURCE_ID +``` + + + + + +??? info "Options" + ```text + + --raw Outputs raw JSON. + ``` + +## project file usage + +Display all usage data of a file resource. + +```shell-session title="Usage" +$ cmemc project file usage [OPTIONS] RESOURCE_ID +``` + + + + + +??? info "Options" + ```text + + --raw Outputs raw JSON. + ``` + diff --git a/docs/release-notes/corporate-memory-25-3/index.md b/docs/release-notes/corporate-memory-25-3/index.md index 6beac136e..6c8d1d73c 100644 --- a/docs/release-notes/corporate-memory-25-3/index.md +++ b/docs/release-notes/corporate-memory-25-3/index.md @@ -11,7 +11,7 @@ Corporate Memory 25.3 is the third major release in 2025. ![25.3: Explore - Companion Chat-Based Data Interaction](25-3-explore-companion.png "25.3: Explore - Companion Chat-Based Data Interaction"){ class="bordered" } -![25.3: Explore - Graph Insights](25-3-explore-graph-insights.png "Explore - Graph Insights"){ class="bordered" } +![25.3: Explore - Graph Insights](25-3-explore-graph-insights.png "25.3: Explore - Graph Insights"){ class="bordered" } The highlights of this release are: @@ -37,7 +37,7 @@ This release delivers the following component versions: - eccenca DataIntegration v25.3.1 - eccenca Explore v25.3.0 -- eccenca Corporate Memory Control (cmemc) v25.5.0 +- eccenca Corporate Memory Control (cmemc) v25.6.0 We tested this release with the following dependency components: @@ -186,9 +186,30 @@ We are pleased to announce Explore v25.3.0, which delivers the new **Companion** - Removed the deprecated LLM assistance feature. -## eccenca Corporate Memory Control (cmemc) v25.5.0 +## eccenca Corporate Memory Control (cmemc) v25.6.0 -We are excited to announce cmemc v25.5.0, which introduces new features, improvements and bug fixes. +We are excited to announce cmemc v25.6.0, which introduces new features, improvements and bug fixes. + +**v25.6.0 of cmemc adds the following new features:** + +- `project file` command group + - `list` command - List available file resources + - `delete` command - Delete file resources + - `inspect` command - Display all metadata of a file resource + - `usage` command - Display all usage data of a file resource + - `upload` command - Upload a file to a project file resource + - `download` command - Download file resources to the local file system + +**v25.6.0 of cmemc ships the following fixes:** + +- `query execute` command + - placeholder query result without description do not crash the app anymore + +**v25.6.0 of cmemc deprecates following functionality:** + +- `dataset resource` command group + - command group is now hidden + - use the more generic `project file` command group instead **v25.5.0 of cmemc adds the following new features:**