Skip to content

Commit 5473444

Browse files
authored
Update cli.md
1 parent cb2667c commit 5473444

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

guide/cli.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,9 @@ $ ./ontop endpoint -m university-complete.obda \
200200

201201
## `ontop materialize`
202202

203-
This command provides a "materialization utility". Materialization is helpful when you want to generate RDF data out of your database, using the provided mappings. This utility will take all the triples that the mapping can produce from the data source, and write them to the output. `ontop materialize` does not need any query file, but instead, needs the user to specify a format in which he/she wants the output (either to terminal or output file). The user can choose between three output formats: [Turtle](https://www.w3.org/TR/2014/REC-turtle-20140225/), [N-triples](https://www.w3.org/TR/2014/REC-n-triples-20140225/) or [RDF/XML](https://www.w3.org/TR/2014/REC-rdf-syntax-grammar-20140225/). For very large datasets, producing the output might take some time.
203+
This command provides a "materialization utility". Materialization is helpful when you want to generate RDF data out of your database, using the provided mappings. This utility will take all the triples that the mapping can produce from the data source, and write them to the output. `ontop materialize` does not need any query file, but instead, needs the user to specify a format in which he/she wants the output (either to terminal or output file). The user can choose between three output formats: [Turtle](https://www.w3.org/TR/2014/REC-turtle-20140225/), [N-triples](https://www.w3.org/TR/2014/REC-n-triples-20140225/) or [RDF/XML](https://www.w3.org/TR/2014/REC-rdf-syntax-grammar-20140225/). For very large datasets, producing the output might take some time.
204+
205+
The compression option has been added in 5.2.0.
204206

205207
```
206208
$ ./ontop help materialize
@@ -211,13 +213,14 @@ NAME
211213
SYNOPSIS
212214
ontop materialize [ {-a | --facts} <fact file> ]
213215
[ {-c | --constraint} <constraint file> ]
216+
[ --compression <output compression> ]
214217
[ {-d | --db-metadata} <db-metadata file> ]
215218
[ --db-driver <DB driver> ] [ --db-password <DB password> ]
216219
[ --db-url <DB URL> ] [ --enable-annotations ]
217-
[ {-f | --format} <outputFormat> ]
218-
[ --facts-base-iri <Base IRI of facts in fact file> ]
220+
[ {-f | --format} <output format> ]
221+
[ --facts-base-iri <base IRI of facts in fact file> ]
219222
[ --facts-format <format of facts file> ]
220-
[ {-l | --lenses | -v | --ontop-views} <lenses file> ]
223+
[ {-l | --lenses | -v | --ontop-views} <Lenses file> ]
221224
{-m | --mapping} <mapping file> [ --no-streaming ]
222225
[ {-o | --output} <output> ]
223226
[ {-p | --properties} <properties file> ] [ --separate-files ]
@@ -228,11 +231,20 @@ SYNOPSIS
228231
229232
OPTIONS
230233
-a <fact file>, --facts <fact file>
231-
User-supplied constant fact file
234+
RDF fact file
232235
233236
-c <constraint file>, --constraint <constraint file>
234237
User-supplied DB constraint file
235238
239+
--compression <output compression>
240+
The compression format of the materialized RDF graph. Default: no
241+
compression
242+
243+
This options value is restricted to the following set of values:
244+
gzip
245+
zip
246+
no_compression
247+
236248
-d <db-metadata file>, --db-metadata <db-metadata file>
237249
User-supplied db-metadata file
238250
@@ -249,8 +261,8 @@ OPTIONS
249261
enable annotation properties defined in the ontology. Default:
250262
false
251263
252-
-f <outputFormat>, --format <outputFormat>
253-
The format of the materialized ontology. Default: rdfxml
264+
-f <output format>, --format <output format>
265+
The format of the materialized RDF graph. Default: rdfxml
254266
255267
This options value is restricted to the following set of values:
256268
rdfxml
@@ -260,11 +272,12 @@ OPTIONS
260272
trig
261273
jsonld
262274
263-
--facts-base-iri <Base IRI of facts in fact file>
264-
The base IRI used for the facts taken from the fact file.
275+
--facts-base-iri <base IRI of facts in fact file>
276+
The base IRI of facts in the fact file to resolve relative IRIs. If
277+
not provided, a random IRI is generated.
265278
266279
--facts-format <format of facts file>
267-
The format of the materialized ontology. Default: infer from file extension
280+
The format of the 'facts' input file.
268281
269282
This options value is restricted to the following set of values:
270283
rdfxml
@@ -274,8 +287,8 @@ OPTIONS
274287
trig
275288
jsonld
276289
277-
-l <lenses file>, --lenses <lenses file>, -v <lenses file>,
278-
--ontop-views <lenses file>
290+
-l <Lenses file>, --lenses <Lenses file>, -v <Lenses file>,
291+
--ontop-views <Lenses file>
279292
User-supplied lenses file. Lenses were formerly named Ontop views.
280293
281294
-m <mapping file>, --mapping <mapping file>

0 commit comments

Comments
 (0)