HomeGetting StartedInstallation & SetupDevelopment & IntegrationDeployment & OperationsData ManagementTechnical SupportPlatform Updates
Development & Integration / API & Client References

Overview

Documentation on api & client references.

`stardog data add`
Name, shorthand | Description ---|--- `--compression <Compression>` | Compression format [GZIP, BZ2, ZIP] for the input data. `-f <rdf format>, --format <rdf format>` | Data format. The supported form
Reference
`stardog data export`
Name, shorthand | Description ---|--- `--compression <Compression>` | Compression format [GZIP, BZ2] for the exported data. `-f <RDF Format>, --format <RDF Format>` | RDF Format [NTRIPLES, RDF/XML, TU
Reference
`stardog data model`
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, T
Reference
`stardog data obfuscate`
Name, shorthand | Description ---|--- `-c <obfuscation configuration>, --config <obfuscation configuration>` | Configuration file for obfuscation. This file should exist on the client-side. `--compres
Reference
`stardog data remove`
Name, shorthand | Description ---|--- `-a, --all` | Remove all flag. If this flag is set, all data in the database will be removed. `--compression <Compression>` | Compression format [GZIP, BZ2, ZIP]
Reference
`stardog data size`
Name, shorthand | Description ---|--- `--exact` | Ensures that the returned value is exact at the time of the call. This may require the server to scan the entire database `--krb5` | Use the Kerberos
Reference
`data`
The table below contains the CLI commands for working with data in Stardog.
Reference
`stardog entity-resolution resolve`
Name, shorthand | Description ---|--- `-c <compute source>, --compute <compute source>` | The external compute data source for the entity resolution. If provided, the entity resolution process will ru
Reference
`entity-resolution`
Stardog Entity Resolution provides a way to match real-world entities based on their properties using fuzzy matching techniques. Read more about [Entity Resolution](../../entity-resolution).
Reference
`stardog file cat`
Name, shorthand | Description ---|--- `-f <rdf format>, --format <rdf format>` | RDF Format for the output. The supported formats are NTRIPLES, RDF/XML, TURTLE, PRETTY_TURTLE, TRIG, N3, NQUADS, JSONLD
Reference
`stardog file obfuscate`
Name, shorthand | Description ---|--- `-c <obfuscation configuration>, --config <obfuscation configuration>` | Configuration file for obfuscation `-f <rdf format>, --format <rdf format>` | RDF Format
Reference
`stardog file split`
Name, shorthand | Description ---|--- `-b <byteCount[k|m]>` | Create smaller files byteCount bytes in length. Suffix 'k', 'm', or 'g' can be used after the byteCount to indicate kilobyte, megabyte, or
Reference
`file`
Stardog provides some CLI commands that work directly over files. For example, you can use the `file cat` command to concatenate multiple RDF files into a single file and `file split` command to split
Reference
`stardog graphql execute`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog graphql explain`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog graphql schema`
Name, shorthand | Description ---|--- `-a <schemaName>, --add <schemaName>` | Adds a new GraphQL schema. `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for
Reference
`graphql`
Stardog supports querying data stored (or mapped) in a Stardog database using GraphQL queries. You can load data into Stardog as usual and execute GraphQL queries without creating a GraphQL schema. Re
Reference
`stardog icv export`
Name, shorthand | Description ---|--- `-f <format>, --format <format>` | RDF Format [N-TRIPLES, RDF/XML, TURTLE, TRIG] for the constraints. `--krb5` | Use the Kerberos environment. `--krb5-disable-rdn
Reference
`stardog icv report`
Name, shorthand | Description ---|--- `-f <format>, --format <format>` | RDF Format [N-TRIPLES, RDF/XML, TURTLE, TRIG] for the constraints. `-g <named graph(s)>, --named-graph <named graph(s)>, --name
Reference
`stardog icv validate`
Name, shorthand | Description ---|--- `-f <format>, --format <format>` | RDF Format [N-TRIPLES, RDF/XML, TURTLE, TRIG] for the constraints. `-g <named graph(s)>, --named-graph <named graph(s)>, --name
Reference
`icv`
Stardog Integrity Constraint Validation (“ICV”) validates RDF data stored in a Stardog database according to constraints described by users and that make sense for their domain, application, and data.
Reference
Stardog CLI Reference
As described in the [Command Line Interface](../operating-stardog/command-line-interface) section of [Operating Stardog](../operating-stardog), Stardog's CLI comes in two parts, `stardog-admin` (the a
Reference
`namespace`
Stardog allows database administrators to persist and manage custom namespace prefix bindings. Read more about namespaces in [Database Administration](../../operating-stardog/database-administration#n
Reference
`stardog namespace add`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog namespace export`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog namespace import`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog namespace list`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog namespace remove`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`query`
Stardog supports the SPARQL query language along with OWL & Rule Reasoning. It supports SPARQL 1.1. Read more about [executing queries](../../query-stardog).
Reference
`stardog query execute`
Name, shorthand | Description ---|--- `-b <variables to bind>, --bind <variables to bind>` | Variable bindings. One or more variable bindings to apply before executing query. Each binding is provided
Reference
`stardog query explain`
Name, shorthand | Description ---|--- `-b <variables to bind>, --bind <variables to bind>` | Variable bindings. One or more variable bindings to apply before executing query. Each binding is provided
Reference
`stardog query obfuscate`
Name, shorthand | Description ---|--- `-c <obfuscation configuration>, --config <obfuscation configuration>` | Configuration file for obfuscation. This file should exist on the client-side. `--krb5` |
Reference
`stardog query search`
Name, shorthand | Description ---|--- `-g <named graphs>, --named-graph <named graphs>, --named-graphs <named graphs>` | Named graph(s) to search. Multiple graphs are separated by whitespaces, e.g., '
Reference
`reasoning`
Reasoning is the software service that lets Stardog infer new, unstated (i.e., implicit) information from the known (i.e., explicit) data. Read all about Stardog's [reasoning capabilities](../../infer
Reference
`stardog reasoning consistency`
Name, shorthand | Description ---|--- `-g <contexts>, --named-graph <contexts>, --named-graphs <contexts>` | The list of named graphs to check the consistency of; if none are specified, consistency of
Reference
`stardog reasoning explain`
Name, shorthand | Description ---|--- `-f <format>, --format <format>` | Input data format: NTRIPLES, RDF/XML, TURTLE, PRETTY_TURTLE, TRIG, N3, NQUADS, JSONLD `-i, --inconsistency` | Explain inconsist
Reference
`stardog reasoning schema`
Name, shorthand | Description ---|--- `-a <schemaName>, --add <schemaName>` | Adds a new reasoning schema with the given name. The named graphs for the schema should be provided with the {-g, --graphs
Reference
`test`
The table below contains the CLI commands to create and run correctness and performance tests.
Reference
`stardog test create`
Name, shorthand | Description ---|--- `--glob <glob>` | The glob expression to use for finding files in the directory. The default is looking for fileswith extension ,sparql or .rq. `--krb5` | Use the
Reference
`stardog test run`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`tx`
The table below contains the CLI commands to manage transactions.
Reference
`stardog tx begin`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog tx commit`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog tx list`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference
`stardog tx rollback`
Name, shorthand | Description ---|--- `--krb5` | Use the Kerberos environment. `--krb5-disable-rdns` | Disable reverse DNS lookup for Kerberos clients. `-p <password>, --passwd <password>` | Password.
Reference