Skip to content

Commit c50f012

Browse files
rpietzschrpietzsch
committed
Merge branch 'main' into feature/linter-adjustments
# Conflicts: # docs/automate/cmemc-command-line-interface/command-reference/admin/store/index.md # docs/automate/cmemc-command-line-interface/command-reference/admin/workspace/index.md # docs/automate/cmemc-command-line-interface/command-reference/package/index.md # docs/automate/cmemc-command-line-interface/command-reference/query/index.md # docs/build/integrations/index.md # docs/build/snowflake-tutorial/index.md # docs/deploy-and-configure/configuration/label-resolution-and-full-text-search/index.md
2 parents d723849 + 2b21631 commit c50f012

14 files changed

Lines changed: 264 additions & 178 deletions

File tree

‎data/integrations.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,21 +303,21 @@ integrations:
303303
SQLite can be accessed with the {{p.Jdbc}} dataset and a
304304
[Custom JDBC driver](https://central.sonatype.com/artifact/org.xerial/sqlite-jdbc).
305305
Please have a look at
306-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
306+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
307307
308308
- name: Trino
309309
icon: ":simple-trino:"
310310
content: |
311311
[Trino](https://github.com/trinodb/trino) can be access with the {{p.Jdbc}} dataset and a
312312
[Custom JDBC driver](https://trino.io/docs/current/client/jdbc.html).
313313
Please have a look at
314-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
314+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
315315
316316
- name: Databricks
317317
icon: ":simple-databricks:"
318318
content: |
319319
[Databricks](http://databricks.com/) can be accessed with the {{p.Jdbc}} dataset and a
320320
[Custom JDBC driver](https://github.com/databricks/databricks-jdbc).
321321
Please have a look at
322-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
322+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
323323

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,4 +97,3 @@ The backup file is a ZIP archive containing all knowledge graphs (one Turtle fi
9797
The command will load a single backup ZIP archive into the triple store by replacing all graphs with the content of the Turtle files in the archive and deleting all graphs which are not in the archive.
9898

9999
This command will create lots of load on the server. It can take a long time to complete. The backup file will be transferred to the server, then unzipped and imported graph by graph. After the initial transfer the network connection is not used anymore and may be closed by proxies. This does not mean that the import failed.
100-

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,10 @@ Reload the workspace from the backend.
6262
cmemc admin workspace reload
6363
```
6464

65+
## admin workspace thread-dump
66+
67+
Request a thread dump for all live threads.
68+
69+
```shell-session title="Usage"
70+
$ cmemc admin workspace thread-dump
71+
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ In case of file export, data from all selected graphs will be concatenated in on
8989
the current date as YYYY-MM-DD. The file
9090
suffix will be appended. Needed directories
9191
will be created. [default: {{hash}}]
92-
--mime-type [application/n-triples|text/turtle|application/rdf+xml]
92+
--mime-type [application/n-triples|text/turtle|text/turtle+pretty|application/rdf+xml]
9393
Define the requested mime type [default:
9494
text/turtle]
9595
--compress [gzip] Compress the exported graph files.

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ tags:
5151
| [admin workspace](admin/workspace/index.md) | [export](admin/workspace/index.md#admin-workspace-export) | Export the complete workspace (all projects) to a ZIP file. |
5252
| [admin workspace](admin/workspace/index.md) | [import](admin/workspace/index.md#admin-workspace-import) | Import the workspace from a file. |
5353
| [admin workspace](admin/workspace/index.md) | [reload](admin/workspace/index.md#admin-workspace-reload) | Reload the workspace from the backend. |
54+
| [admin workspace](admin/workspace/index.md) | [thread-dump](admin/workspace/index.md#admin-workspace-thread-dump) | Request a thread dump for all live threads. |
5455
| [admin workspace python](admin/workspace/python/index.md) | [install](admin/workspace/python/index.md#admin-workspace-python-install) | Install a python package to the workspace. |
5556
| [admin workspace python](admin/workspace/python/index.md) | [uninstall](admin/workspace/python/index.md#admin-workspace-python-uninstall) | Uninstall a python packages from the workspace. |
5657
| [admin workspace python](admin/workspace/python/index.md) | [list](admin/workspace/python/index.md#admin-workspace-python-list) | List installed python packages. |
@@ -115,12 +116,16 @@ tags:
115116
| [project variable](project/variable/index.md) | [delete](project/variable/index.md#project-variable-delete) | Delete project variables. |
116117
| [project variable](project/variable/index.md) | [create](project/variable/index.md#project-variable-create) | Create a new project variable. |
117118
| [project variable](project/variable/index.md) | [update](project/variable/index.md#project-variable-update) | Update data of an existing project variable. |
118-
| [query](query/index.md) | [execute](query/index.md#query-execute) | Execute queries which are loaded from files or the query catalog. |
119-
| [query](query/index.md) | [list](query/index.md#query-list) | List available queries from the catalog. |
120-
| [query](query/index.md) | [open](query/index.md#query-open) | Open queries in the editor of the query catalog in your browser. |
119+
| [query](query/index.md) | [execute](query/index.md#query-execute) | Execute queries which are loaded from files or a query catalog. |
120+
| [query](query/index.md) | [list](query/index.md#query-list) | List available queries from a query catalog. |
121+
| [query](query/index.md) | [open](query/index.md#query-open) | Open queries in the editor of a query catalog in your browser. |
121122
| [query](query/index.md) | [status](query/index.md#query-status) | Get status information of executed and running queries. |
122123
| [query](query/index.md) | [replay](query/index.md#query-replay) | Re-execute queries from a replay file. |
123124
| [query](query/index.md) | [cancel](query/index.md#query-cancel) | Cancel a running query. |
125+
| [query](query/index.md) | [explain](query/index.md#query-explain) | Explain queries by showing their logical execution plan. |
126+
| [query](query/index.md) | [create](query/index.md#query-create) | Create a new query in a query catalog. |
127+
| [query](query/index.md) | [update](query/index.md#query-update) | Update an existing query in a query catalog. |
128+
| [query](query/index.md) | [delete](query/index.md#query-delete) | Delete queries from a query catalog. |
124129
| [vocabulary](vocabulary/index.md) | [open](vocabulary/index.md#vocabulary-open) | Open / explore a vocabulary graph in the browser. |
125130
| [vocabulary](vocabulary/index.md) | [list](vocabulary/index.md#vocabulary-list) | Output a list of vocabularies. |
126131
| [vocabulary](vocabulary/index.md) | [install](vocabulary/index.md#vocabulary-install) | Install one or more vocabularies from the catalog. |

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

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -160,17 +160,11 @@ This command creates one or more new projects. Existing projects will not be ove
160160
??? info "Options"
161161
```text
162162

163-
--from-transformation TEXT This option can be used to explicitly create the
164-
link specification, which is internally executed
165-
when using the mapping suggestion of a
166-
transformation task. You need the task ID of the
167-
transformation task.
168-
--label TEXT Give the label of the project. You can give more
169-
than one label if you create more than one
170-
project.
171-
--description TEXT Give the description of the project. You can
172-
give more than one description if you create
173-
more than one project.
163+
--label TEXT Give the label of the project. You can give more than
164+
one label if you create more than one project.
165+
--description TEXT Give the description of the project. You can give more
166+
than one description if you create more than one
167+
project.
174168
```
175169

176170
## project reload

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

Lines changed: 134 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Queries can use a mustache like syntax to specify placeholder for parameter valu
2424

2525
## query execute
2626

27-
Execute queries which are loaded from files or the query catalog.
27+
Execute queries which are loaded from files or a query catalog.
2828

2929
```shell-session title="Usage"
3030
cmemc query execute [OPTIONS] QUERIES...
@@ -76,7 +76,7 @@ Limitations: All optional parameters (e.g. accept, base64, ...) are provided for
7676

7777
## query list
7878

79-
List available queries from the catalog.
79+
List available queries from a query catalog.
8080

8181
```shell-session title="Usage"
8282
cmemc query list [OPTIONS]
@@ -101,7 +101,7 @@ You can filter queries based on ID, type, placeholder, or regex pattern.
101101

102102
## query open
103103

104-
Open queries in the editor of the query catalog in your browser.
104+
Open queries in the editor of a query catalog in your browser.
105105

106106
```shell-session title="Usage"
107107
cmemc query open [OPTIONS] QUERIES...
@@ -187,3 +187,134 @@ cmemc query cancel QUERY_ID
187187

188188
With this command, you can cancel a running query. Depending on the backend triple store, this will result in a broken result stream (stardog, neptune and virtuoso) or a valid result stream with incomplete results (graphdb)
189189

190+
191+
192+
## query explain
193+
194+
Explain queries by showing their logical execution plan.
195+
196+
```shell-session title="Usage"
197+
$ cmemc query explain [OPTIONS] QUERIES...
198+
```
199+
200+
201+
202+
203+
Queries are identified either by a file path, a URI from the query catalog, or a shortened URI (qname, using a default namespace).
204+
205+
The explain command shows the query optimization plan, including: - Optimization groups and their evaluation order - Collection sizes and complexity estimates - Unique subject and object counts - Estimated number of iterations
206+
207+
This helps understand query performance and identify optimization opportunities.
208+
209+
210+
211+
??? info "Options"
212+
```text
213+
214+
--catalog-graph TEXT The used query catalog graph. [default:
215+
https://ns.eccenca.com/data/queries/]
216+
-p, --parameter <TEXT TEXT>... In case of a parameterized query
217+
(placeholders with the '{{key}}' syntax),
218+
this option fills all placeholder with a
219+
given value before the query is explained.
220+
Pairs of placeholder/value need to be given
221+
as a tuple 'KEY VALUE'. A key can be used
222+
only once.
223+
```
224+
225+
## query create
226+
227+
Create a new query in a query catalog.
228+
229+
```shell-session title="Usage"
230+
$ cmemc query create [OPTIONS] QUERY_FILE
231+
```
232+
233+
234+
235+
236+
Creates a new query in a query catalog from a SPARQL query file.
237+
238+
The query type (SELECT, CONSTRUCT, UPDATE, etc.) is automatically detected from the query text.
239+
240+
```shell-session title="Example"
241+
$ cmemc query create my-query.sparql $ cmemc query create my-query.sparql --id :customName
242+
```
243+
244+
245+
246+
247+
??? info "Options"
248+
```text
249+
250+
--catalog-graph TEXT The used query catalog graph. [default:
251+
https://ns.eccenca.com/data/queries/]
252+
--id TEXT The local ID for the new query. The full URI will be
253+
catalog graph + ID. If not provided, a UUID is
254+
generated.
255+
--label TEXT Human-readable label for the query. If not provided
256+
but an ID is given, the ID will be used. If neither
257+
label nor ID is given, a default label is used.
258+
--description TEXT Description for the query.
259+
```
260+
261+
## query update
262+
263+
Update an existing query in a query catalog.
264+
265+
```shell-session title="Usage"
266+
$ cmemc query update [OPTIONS] QUERY_ID
267+
```
268+
269+
270+
271+
272+
Updates an existing query in the query catalog. You can update the query text, label, and/or description. At least one update option must be provided.
273+
274+
The `QUERY_ID` can be either a short URI (e.g., :myQuery) or a full URI.
275+
276+
277+
278+
??? info "Options"
279+
```text
280+
281+
--catalog-graph TEXT The used query catalog graph. [default:
282+
https://ns.eccenca.com/data/queries/]
283+
--query-file FILE Update the query text from a SPARQL file.
284+
--label TEXT Update the query label.
285+
--description TEXT Update the query description.
286+
```
287+
288+
## query delete
289+
290+
Delete queries from a query catalog.
291+
292+
```shell-session title="Usage"
293+
$ cmemc query delete [OPTIONS] [QUERY_IDS]...
294+
```
295+
296+
297+
298+
299+
Permanently removes one or more queries from the query catalog. Queries are identified by their URI or shortened URI (qname).
300+
301+
You can delete specific queries by providing their IDs, or use `--filter` to select queries based on criteria, or use `--all` to delete all queries in the catalog.
302+
303+
!!! warning
304+
Deleted queries cannot be recovered. Use with caution!
305+
306+
307+
308+
309+
??? info "Options"
310+
```text
311+
312+
--catalog-graph TEXT The used query catalog graph. [default:
313+
https://ns.eccenca.com/data/queries/]
314+
--filter <TEXT TEXT>... Filter catalog queries by one of the following
315+
filter names and a corresponding value: id, type,
316+
placeholder, regex.
317+
--all Delete all queries from the catalog. Use with
318+
caution!
319+
```
320+

‎docs/build/integrations/index.md‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ to interact with any [Azure AI Foundry provided Large Language Models](https://a
5656
[Databricks](http://databricks.com/) can be accessed with the [Remote SQL endpoint](../../build/reference/dataset/Jdbc.md) dataset and a
5757
[Custom JDBC driver](https://github.com/databricks/databricks-jdbc).
5858
Please have a look at
59-
60-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
59+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
6160

6261

6362
- :material-email-outline:{ .lg .middle } eMail / SMTP
@@ -336,8 +335,7 @@ execute a [SOQL query (Salesforce)](../../build/reference/customtask/cmem_plugin
336335
SQLite can be accessed with the [Remote SQL endpoint](../../build/reference/dataset/Jdbc.md) dataset and a
337336
[Custom JDBC driver](https://central.sonatype.com/artifact/org.xerial/sqlite-jdbc).
338337
Please have a look at
339-
340-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
338+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
341339

342340

343341
- :material-ssh:{ .lg .middle } SSH
@@ -367,8 +365,7 @@ Tentris can be used as the integrated Quad Store as well (beta).
367365
[Trino](https://github.com/trinodb/trino) can be access with the [Remote SQL endpoint](../../build/reference/dataset/Jdbc.md) dataset and a
368366
[Custom JDBC driver](https://trino.io/docs/current/client/jdbc.html).
369367
Please have a look at
370-
371-
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/).
368+
[Setup and use of JDBC Drivers](../../deploy-and-configure/configuration/dataintegration/jdbc/index.md).
372369

373370

374371
- :black_large_square:{ .lg .middle } Virtuoso

0 commit comments

Comments
 (0)