Skip to content

Commit 5db7bc8

Browse files
authored
Merge branch 'main' into feature/include_wsl_documentation
2 parents 35da1fd + b4a9a9a commit 5db7bc8

File tree

103 files changed

+2407
-3304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+2407
-3304
lines changed

.github/workflows/pages.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,12 +75,12 @@ jobs:
7575
run: task clean build
7676

7777
- name: upload artifact
78-
uses: actions/upload-pages-artifact@v1
78+
uses: actions/upload-pages-artifact@v3
7979
with:
8080
# Upload entire repository
8181
path: 'site'
8282

8383
- name: deploy to gitHub pages
8484
id: deployment
85-
uses: actions/deploy-pages@v1
85+
uses: actions/deploy-pages@v4
8686

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you consider to contribute to this project, please have a look on [CONTRIBUTI
1313

1414
## License
1515

16-
Copyright © 2024 [eccenca GmbH](https://eccenca.com)
16+
Copyright © 2025 [eccenca GmbH](https://eccenca.com)
1717

1818
This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
1919

Taskfile.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ version: '3'
55

66
vars:
77
PUBLIC_BRANCH: published
8-
CURRENT_VERSION: 24.3
9-
MATERIAL_TAG: 9.5.44
10-
MATERIAL_INSIDER_TAG: 9.5.44-insiders-4.53.14
8+
CURRENT_VERSION: 25.2
9+
MATERIAL_TAG: 9.6.14
10+
MATERIAL_INSIDER_TAG: 9.6.14-insiders-4.53.16
1111

1212
tasks:
1313

@@ -108,7 +108,7 @@ tasks:
108108
desc: re-generates the cmemc command reference
109109
cmds:
110110
- rm -rf {{.REFERENCE_DIR}}/*
111-
- CMEMC_MANUAL_DIR={{.REFERENCE_DIR}} cmemc -q config
111+
- cmemc manual --format markdown-multi-page --output-dir {{.REFERENCE_DIR}}
112112
vars:
113113
REFERENCE_DIR: docs/automate/cmemc-command-line-interface/command-reference
114114

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ $ cmemc admin status [OPTIONS]
2626

2727
This command outputs version and health information of the selected deployment. If the version information cannot be retrieved, UNKNOWN is shown.
2828

29-
Additionally, this command informs you in one of these cases: (1) A warning, if the target version of your cmemc client is newer than the version of your backend. (2) A warning, if the ShapeCatalog has a different version than your DataPlatform component. (3) An error, if your Corporate Memory license is expired (grace period). (4) A warning, if your Graph DB license will expire in less than a month.
29+
Additionally, this command informs you in one of these cases: (1) A warning, if the target version of your cmemc client is newer than the version of your backend. (2) A warning, if the ShapeCatalog has a different version than your Explore component. (3) An error, if your Corporate Memory license is expired (grace period). (4) A warning, if your Graph DB license will expire in less than a month.
3030

3131
To get status information of all configured deployments use this command in combination with parallel.
3232

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
status: new
32
title: "cmemc: Command Group - admin metrics"
43
description: "List and get metrics."
54
icon: material/chart-line-variant

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
status: new
32
title: "cmemc: Command Group - admin migration"
43
description: "List and apply migration recipes."
54
icon: material/database-arrow-up-outline
@@ -15,7 +14,7 @@ With this command group, you can check your instance for needed migration activi
1514

1615
Beside an ID and a description, migration recipes have the following metadata: 'First Version' is the first Corporate Memory version, where this recipe is maybe applicable. The recipe will never be applied to a version below this version. 'Tags' is a classification of the recipe with regard to the target data, it migrates.
1716

18-
The following tags are important: 'system' recipes target data structures which are needed to run the most basic functionality properly. These recipes can and should be applied after each version upgrade. 'user' recipes can change user and / or customizing data. 'acl' recipes migrate access condition data. 'shapes' recipes migrate shape data. 'config' recipes migrate configuration data.
17+
The following tags are important: `system` recipes target data structures which are needed to run the most basic functionality properly. These recipes can and should be applied after each version upgrade. `user` recipes can change user and / or customizing data. `acl` recipes migrate access condition data. `shapes` recipes migrate shape data. `config` recipes migrate configuration data.
1918

2019

2120
## admin migration list
@@ -59,7 +58,7 @@ This command executes one or more migration recipes. Each recipe has a check met
5958

6059
Recipes are executed ordered by first_version.
6160

62-
Here are some argument examples, in order to see how to use this command: `execute `--all` `--test-only`` will list all needed migrations (but not execute them), `execute `--filter` tag system` will apply all migrations which target system data, `execute bootstrap-data` will apply bootstrap-data migration if needed.
61+
Here are some argument examples, in order to see how to use this command: execute `--all` `--test-only` will list all needed migrations (but not execute them), execute `--filter` tag system will apply all migrations which target system data, execute bootstrap-data will apply bootstrap-data migration if needed.
6362

6463

6564

docs/automate/cmemc-command-line-interface/command-reference/admin/workspace/python/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ tags:
1111

1212
List, install, or uninstall python packages.
1313

14-
Python packages are used to extend the DataIntegration workspace with python plugins. To get a list of installed packages, execute the list command.
14+
Python packages are used to extend the Build (DataIntegration) workspace with python plugins. To get a list of installed packages, execute the list command.
1515

1616
!!! warning
1717
Installing packages from unknown sources is not recommended. Plugins are not verified for malicious code.
@@ -133,3 +133,18 @@ With this command, you can open the pypi.org page of a published package in your
133133

134134

135135

136+
## admin workspace python reload
137+
138+
Reload / Register all installed plugins.
139+
140+
```shell-session title="Usage"
141+
$ cmemc admin workspace python reload
142+
```
143+
144+
145+
146+
147+
This command will register all installed plugins into the Build (DataIntegration) workspace. This command is useful, when you are installing packages into the Build Python environment without using the provided cmemc commands (e.g. by mounting a prepared filesystem in the docker container).
148+
149+
150+

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

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,51 +12,51 @@ tags:
1212
```text
1313
List and edit configs as well as get config values.
1414
15-
Configurations are identified by the section identifier in the
16-
config file. Each configuration represent a Corporate Memory deployment
17-
with its specific access method as well as credentials.
18-
19-
A minimal configuration which uses client credentials has the following
20-
entries:
21-
22-
23-
[example.org]
24-
CMEM_BASE_URI=https://cmem.example.org/
25-
OAUTH_GRANT_TYPE=client_credentials
26-
OAUTH_CLIENT_ID=cmem-service-account
27-
OAUTH_CLIENT_SECRET=my-secret-account-pass
28-
29-
Note that OAUTH_GRANT_TYPE can be either client_credentials, password or
30-
prefetched_token.
31-
32-
In addition to that, the following config parameters can be used as well:
33-
34-
35-
SSL_VERIFY=False - for ignoring certificate issues (not recommended)
36-
DP_API_ENDPOINT=URL - to point to a non-standard DataPlatform location
37-
DI_API_ENDPOINT=URL - to point to a non-standard DataIntegration location
38-
OAUTH_TOKEN_URI=URL - to point to an external IdentityProvider location
39-
OAUTH_USER=username - only if OAUTH_GRANT_TYPE=password
40-
OAUTH_PASSWORD=password - only if OAUTH_GRANT_TYPE=password
41-
OAUTH_ACCESS_TOKEN=token - only if OAUTH_GRANT_TYPE=prefetched_token
42-
43-
In order to get credential information from an external process, you can
44-
use the parameter OAUTH_PASSWORD_PROCESS, OAUTH_CLIENT_SECRET_PROCESS and
45-
OAUTH_ACCESS_TOKEN_PROCESS to set up an external executable.
46-
47-
48-
OAUTH_CLIENT_SECRET_PROCESS=/path/to/getpass.sh
49-
OAUTH_PASSWORD_PROCESS=["getpass.sh", "parameter1", "parameter2"]
50-
51-
The credential executable can use the cmemc environment for fetching the
52-
credential (e.g. CMEM_BASE_URI and OAUTH_USER).
53-
If the credential executable is not given with a full path, cmemc
54-
will look into your environment PATH for something which can be executed.
55-
The configured process needs to return the credential on the first line
56-
of stdout. In addition to that, the process needs to exit with exit
57-
code 0 (without failure). There are examples available in the online
58-
manual.
59-
15+
Configurations are identified by the section identifier in the
16+
config file. Each configuration represent a Corporate Memory deployment
17+
with its specific access method as well as credentials.
18+
19+
A minimal configuration which uses client credentials has the following
20+
entries:
21+
22+
23+
[example.org]
24+
CMEM_BASE_URI=https://cmem.example.org/
25+
OAUTH_GRANT_TYPE=client_credentials
26+
OAUTH_CLIENT_ID=cmem-service-account
27+
OAUTH_CLIENT_SECRET=my-secret-account-pass
28+
29+
Note that OAUTH_GRANT_TYPE can be either client_credentials, password or
30+
prefetched_token.
31+
32+
In addition to that, the following config parameters can be used as well:
33+
34+
35+
SSL_VERIFY=False - for ignoring certificate issues (not recommended)
36+
DP_API_ENDPOINT=URL - to point to a non-standard Explore backend (DataPlatform) location
37+
DI_API_ENDPOINT=URL - to point to a non-standard Build (DataIntegration) location
38+
OAUTH_TOKEN_URI=URL - to point to an external IdentityProvider location
39+
OAUTH_USER=username - only if OAUTH_GRANT_TYPE=password
40+
OAUTH_PASSWORD=password - only if OAUTH_GRANT_TYPE=password
41+
OAUTH_ACCESS_TOKEN=token - only if OAUTH_GRANT_TYPE=prefetched_token
42+
43+
In order to get credential information from an external process, you can
44+
use the parameter OAUTH_PASSWORD_PROCESS, OAUTH_CLIENT_SECRET_PROCESS and
45+
OAUTH_ACCESS_TOKEN_PROCESS to set up an external executable.
46+
47+
48+
OAUTH_CLIENT_SECRET_PROCESS=/path/to/getpass.sh
49+
OAUTH_PASSWORD_PROCESS=["getpass.sh", "parameter1", "parameter2"]
50+
51+
The credential executable can use the cmemc environment for fetching the
52+
credential (e.g. CMEM_BASE_URI and OAUTH_USER).
53+
If the credential executable is not given with a full path, cmemc
54+
will look into your environment PATH for something which can be executed.
55+
The configured process needs to return the credential on the first line
56+
of stdout. In addition to that, the process needs to exit with exit
57+
code 0 (without failure). There are examples available in the online
58+
manual.
59+
6060
```
6161

6262
## config list
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

0 commit comments

Comments
 (0)