Skip to content

Commit 10fb11b

Browse files
seebiseebi
committed
update cmemc documentation for v25.3.0
1 parent ffac484 commit 10fb11b

4 files changed

Lines changed: 135 additions & 18 deletions

File tree

‎docs/automate/cmemc-command-line-interface/command-reference/graph/imports/index.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: "cmemc: Command Group - graph imports"
3+
description: "List, create, delete and show graph imports."
4+
icon: material/family-tree
5+
tags:
6+
- KnowledgeGraph
7+
- cmemc
8+
---
9+
# graph imports Command Group
10+
<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->
11+
12+
List, create, delete and show graph imports.
13+
14+
Graphs are identified by an IRI. Statement imports are managed by creating owl:imports statements such as '`FROM_GRAPH` owl:imports `TO_GRAPH`' in the `FROM_GRAPH`. All statements in the `TO_GRAPH` are then available in the `FROM_GRAPH`.
15+
16+
!!! note
17+
The get a list of existing graphs, execute the `graph list` command or use tab-completion.
18+
19+
20+
21+
## graph imports tree
22+
23+
Show graph tree(s) of the imports statement hierarchy.
24+
25+
```shell-session title="Usage"
26+
$ cmemc graph imports tree [OPTIONS] [IRIS]...
27+
```
28+
29+
30+
31+
32+
You can output one or more trees of the import hierarchy.
33+
34+
Imported graphs which do not exist are shown as `[missing: IRI]`. Imported graphs which will result in an import cycle are shown as `[ignored: IRI]`. Each graph is shown with label and IRI.
35+
36+
37+
38+
??? info "Options"
39+
```text
40+
41+
-a, --all Show tree of all (readable) graphs.
42+
--raw Outputs raw JSON of the graph importTree API response.
43+
--id-only Lists only graph identifier (IRIs) and no labels or other
44+
metadata. This is useful for piping the IRIs into other
45+
commands. The output with this option is a sorted, flat, de-
46+
duplicated list of existing graphs.
47+
```
48+
49+
## graph imports list
50+
51+
List accessible graph imports statements.
52+
53+
```shell-session title="Usage"
54+
$ cmemc graph imports list [OPTIONS]
55+
```
56+
57+
58+
59+
60+
Graphs are identified by an IRI. Statement imports are managed by creating owl:imports statements such as "`FROM_GRAPH` owl:imports `TO_GRAPH`" in the `FROM_GRAPH`. All statements in the `TO_GRAPH` are then available in the `FROM_GRAPH`.
61+
62+
63+
64+
??? info "Options"
65+
```text
66+
67+
--raw Outputs raw JSON response.
68+
--filter <TEXT TEXT>... Filter imports by one of the following filter names
69+
and a corresponding value: from-graph, to-graph.
70+
```
71+
72+
## graph imports create
73+
74+
Add statement to import a TO_GRAPH into a FROM_GRAPH.
75+
76+
```shell-session title="Usage"
77+
$ cmemc graph imports create FROM_GRAPH TO_GRAPH
78+
```
79+
80+
81+
82+
83+
Graphs are identified by an IRI. Statement imports are managed by creating owl:imports statements such as "`FROM_GRAPH` owl:imports `TO_GRAPH`" in the `FROM_GRAPH`. All statements in the `TO_GRAPH` are then available in the `FROM_GRAPH`.
84+
85+
!!! note
86+
The get a list of existing graphs, execute the `graph list` command or use tab-completion.
87+
88+
89+
90+
91+
## graph imports delete
92+
93+
Delete statement to import a TO_GRAPH into a FROM_GRAPH.
94+
95+
```shell-session title="Usage"
96+
$ cmemc graph imports delete FROM_GRAPH TO_GRAPH
97+
```
98+
99+
100+
101+
102+
Graphs are identified by an IRI. Statement imports are managed by creating owl:imports statements such as "`FROM_GRAPH` owl:imports `TO_GRAPH`" in the `FROM_GRAPH`. All statements in the `TO_GRAPH` are then available in the `FROM_GRAPH`.
103+
104+
!!! note
105+
The get a list of existing graph imports, execute the `graph imports list` command or use tab-completion.
106+
107+
108+
109+

‎docs/automate/cmemc-command-line-interface/command-reference/graph/index.md‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This command lists graphs with their triple count. Counts do not include importe
4242

4343
## graph tree
4444

45-
Show graph tree(s) of the owl:imports hierarchy.
45+
(Hidden) Deprecated: use 'graph imports tree' instead.
4646

4747
```shell-session title="Usage"
4848
$ cmemc graph tree [OPTIONS] [IRIS]...
@@ -51,11 +51,6 @@ $ cmemc graph tree [OPTIONS] [IRIS]...
5151

5252

5353

54-
You can output one or more trees of the import hierarchy.
55-
56-
Imported graphs which do not exist are shown as `[missing: IRI]`. Imported graphs which will result in an import cycle are shown as `[ignored: IRI]`. Each graph is shown with label and IRI.
57-
58-
5954

6055
??? info "Options"
6156
```text
@@ -117,6 +112,9 @@ In case of file export, data from all selected graphs will be concatenated in on
117112
--include-imports Export selected graph(s) and all graphs
118113
which are imported from these selected
119114
graph(s).
115+
--include-import-statements Save graph imports information from other
116+
graphs to the exported graphs and write
117+
*.imports files.
120118
--create-catalog In addition to the .ttl and .graph files,
121119
cmemc will create an XML catalog file
122120
(catalog-v001.xml) which can be used by
@@ -153,9 +151,11 @@ $ cmemc graph delete [OPTIONS] [IRIS]...
153151
??? info "Options"
154152
```text
155153

156-
-a, --all Delete all writeable graphs.
157-
--include-imports Delete selected graph(s) and all writeable graphs which
158-
are imported from these selected graph(s).
154+
-a, --all Delete all writeable graphs.
155+
--include-imports Delete selected graph(s) and all writeable
156+
graphs which are imported from these selected
157+
graph(s).
158+
--include-import-statements Delete import reference of deleted graphs
159159
```
160160

161161
## graph import
@@ -186,12 +186,16 @@ If the ``--replace`` flag is set, the data in the graphs will be overwritten, if
186186
??? info "Options"
187187
```text
188188

189-
--replace Replace / overwrite the graph(s), instead of just adding
190-
the triples to the graph.
191-
--skip-existing Skip importing a file if the target graph already exists in
192-
the store. Note that the graph list is fetched once at the
193-
beginning of the process, so that you can still add
194-
multiple files to one single graph (if it does not exist).
189+
--replace Replace / overwrite the graph(s), instead of
190+
just adding the triples to the graph.
191+
--skip-existing Skip importing a file if the target graph
192+
already exists in the store. Note that the
193+
graph list is fetched once at the beginning of
194+
the process, so that you can still add multiple
195+
files to one single graph (if it does not
196+
exist).
197+
--include-import-statements Use *.imports files to re-apply the graph
198+
imports of the imported graphs.
195199
```
196200

197201
## graph open

‎docs/automate/cmemc-command-line-interface/command-reference/index.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,16 @@ tags:
7171
| [dataset resource](dataset/resource/index.md) | [inspect](dataset/resource/index.md#dataset-resource-inspect) | Display all metadata of a file resource. |
7272
| [dataset resource](dataset/resource/index.md) | [usage](dataset/resource/index.md#dataset-resource-usage) | Display all usage data of a file resource. |
7373
| [graph](graph/index.md) | [count](graph/index.md#graph-count) | Count triples in graph(s). |
74-
| [graph](graph/index.md) | [tree](graph/index.md#graph-tree) | Show graph tree(s) of the owl:imports hierarchy. |
74+
| [graph](graph/index.md) | [tree](graph/index.md#graph-tree) | (Hidden) Deprecated: use 'graph imports tree' instead. |
7575
| [graph](graph/index.md) | [list](graph/index.md#graph-list) | List accessible graphs. |
7676
| [graph](graph/index.md) | [export](graph/index.md#graph-export) | Export graph(s) as NTriples to stdout (-), file or directory. |
7777
| [graph](graph/index.md) | [delete](graph/index.md#graph-delete) | Delete graph(s) from the store. |
7878
| [graph](graph/index.md) | [import](graph/index.md#graph-import) | Import graph(s) to the store. |
7979
| [graph](graph/index.md) | [open](graph/index.md#graph-open) | Open / explore a graph in the browser. |
80+
| [graph imports](graph/imports/index.md) | [tree](graph/imports/index.md#graph-imports-tree) | Show graph tree(s) of the imports statement hierarchy. |
81+
| [graph imports](graph/imports/index.md) | [list](graph/imports/index.md#graph-imports-list) | List accessible graph imports statements. |
82+
| [graph imports](graph/imports/index.md) | [create](graph/imports/index.md#graph-imports-create) | Add statement to import a TO_GRAPH into a FROM_GRAPH. |
83+
| [graph imports](graph/imports/index.md) | [delete](graph/imports/index.md#graph-imports-delete) | Delete statement to import a TO_GRAPH into a FROM_GRAPH. |
8084
| [graph validation](graph/validation/index.md) | [execute](graph/validation/index.md#graph-validation-execute) | Start a new validation process. |
8185
| [graph validation](graph/validation/index.md) | [list](graph/validation/index.md#graph-validation-list) | List running and finished validation processes. |
8286
| [graph validation](graph/validation/index.md) | [inspect](graph/validation/index.md#graph-validation-inspect) | List and inspect errors found with a validation process. |

‎docs/automate/cmemc-command-line-interface/command-reference/workflow/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,12 @@ With this command, you can execute a workflow that uses replaceable datasets as
7979
Please note that the io command will not
8080
warn you on overwriting existing output
8181
files.
82-
--input-mimetype [application/x-plugin-file|application/x-plugin-file|application/x-plugin-csv|application/x-plugin-json|application/x-plugin-xml|application/x-plugin-text|application/x-plugin-excel|application/x-plugin-multiCsv|application/json|application/xml|text/csv|guess]
82+
--input-mimetype [application/x-plugin-file|application/x-plugin-file|application/x-plugin-csv|application/x-plugin-json|application/x-plugin-xml|application/x-plugin-text|application/x-plugin-text|application/x-plugin-excel|application/x-plugin-multiCsv|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/json|application/xml|text/csv|application/octet-stream|guess]
8383
Which input format should be processed: If
8484
not given, cmemc will try to guess the mime
8585
type based on the file extension or will
8686
fail.
87-
--output-mimetype [application/x-plugin-file|application/x-plugin-file|application/x-plugin-csv|application/x-plugin-json|application/x-plugin-xml|application/x-plugin-text|application/x-plugin-excel|application/x-plugin-multiCsv|application/json|application/xml|application/n-triples|application/vnd.openxmlformats-officedocument.spreadsheetml.sheet|text/csv|guess]
87+
--output-mimetype [application/x-plugin-file|application/x-plugin-file|application/x-plugin-csv|application/x-plugin-json|application/x-plugin-xml|application/x-plugin-text|application/x-plugin-text|application/x-plugin-excel|application/x-plugin-multiCsv|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/x-plugin-binaryFile|application/json|application/xml|application/n-triples|application/vnd.openxmlformats-officedocument.spreadsheetml.sheet|text/csv|application/octet-stream|guess]
8888
Which output format should be requested: If
8989
not given, cmemc will try to guess the mime
9090
type based on the file extension or will

0 commit comments

Comments
 (0)