Link Search Menu Expand Document
Start for Free

stardog data model


Generates a data model from the specified input and outputs the model in the desired format.


stardog [ --krb5 ] [ --krb5-disable-rdns ] data model [ {-f | --format} <RDF Format> ] [ {-g | --graph} <named graph(s)>... ] [ --include-provenance ] [ --input <input> ] [ --input-limit <N> ] [ --output <output> ] [ {-p | --passwd} <password> ] [ {-P | --ask-password} ] [ {-r | --reasoning} ] [ --rdfs-domain-range ] [ --run-as <username> ] [ --schema <mSchema> ] [ {-u | --username} <username> ] [ {-v | --verbose} ] [--] <database>


Name, shorthand Description
-f <RDF Format>, --format <RDF Format> RDF format for outputs that are serialized in RDF. Allowed RDF formats are [NTRIPLES, RDF/XML, TURTLE, PRETTY_TURTLE, TRIG, N3, NQUADS, JSONLD].
-g <named graph(s)>, --graph <named graph(s)> (Applicable to OWL input without reasoning) The named graphs from which the data model will be generated. By default all the named graphs with schema information will be used.
--include-provenance Whether to include provenance metadata with the model.
--input <input> The input source that will be used to generate the data model. Valid values are [OWL, SHACL, VIRTUAL]. Default is OWL.
--input-limit <N> (Applicable to OWL input without reasoning) Limit the number of triples that will be read from the input graphs to generate the data model. If there are more triples in the input graphs the data model generation will fail.
--krb5 Use the Kerberos environment.
--krb5-disable-rdns Disable reverse DNS lookup for Kerberos clients.
--output <output> The output format for serializing the data model. Valid values are [GraphQL, OWL, SHACL, SQL, TEXT]. Default is TEXT.
-p <password>, --passwd <password> Password.
-P, --ask-password Prompt for password.
-r, --reasoning Turn reasoning on with the default schema.
--rdfs-domain-range (Applicable to OWL output) Use RDFS domain and range properties instead of domainIncludes and rangeIncludes properties.
--run-as <username> User to impersonate when running the command
--schema <mSchema> Turn reasoning on with the specified schema.
-u <username>, --username <username> User name.
-v, --verbose Flag that can cause more detailed information to be printed such as errors and status. Exact output depends upon the command and options used.
-- This option can be used to separate command-line options from the list of argument(s). (Useful when an argument might be mistaken for a command-line option)
<database> The name of the database or the full connection string of the database to connect to. If only the name is provided, the default server URL will be prepended to the name of the database in order to construct the connection string. Connection parameters such as ‘;reasoning=true’ can be included in the provided database name. Connection parameters specified like this can be overridden by specific options on the command. The default server URL will be read from the JVM argument ‘stardog.default.cli.server’. If the JVM argument is not set, the default value ‘http://localhost:5820’ is used. If the server URL has no explicit port value, the default port value ‘5820’ is used. To use a secure connection, you should specify the full connection string and postfix ‘s’ to the protocol, e.g. https.


Generate a data model from the RDFS/OWL schema into a GraphQL schema:

    $ stardog data model --input OWL --output GraphQL myDb > schema.graphqls

Convert the SHACL schema into SQL table mappings that can be used by Stardog’s BI/SQL server:

    $ stardog data model --input SHACL --output SQL myDb > tableMappings.ttl