Stardog Studio

This chapter discusses Stardog Studio - the IDE for the Knowledge Graph Engineer designed to make Stardog functionality easier for everyday users.

<details open markdown="block"> <summary> Page Contents </summary> 1. TOC </details>

Overview

Stardog Studio is the IDE for the Knowledge Graph Engineer designed to make Stardog functionality easier for everyday users.

Aside from administering Stardog clusters, almost all functionality that exists through the CLI and other APIs is available in Studio, and most non-admin users are able to use Studio without need for the command line.

To authenticate using Kerberos, both the Stardog server and your browser must be correctly configured. Check out the documentation on how.

Studio’s UI is split into the sections below.

This is not a comprehensive list of functionality but a general summary of functionality in each section.

Provenance:

Get a high-level overview of your knowledge graph
Visualize connections between data sources (including virtualized sources) and entities in your data

Workspace:

Write, execute, and see query plans for queries in SPARQL and GraphQL
Interact with constraints and rules in SHACL and Stardog Rules Syntax
Edit RDF with TriG and Turtle
Edit Virtual Graph mappings with Stardog Mapping Syntax
See query plans
Visualize query results as nodes and edges
Create and edit Stored Queries

Models:

Visualize your schema
Create and edit OWL- and RDFS-defined schemas in a form-based experience
Write, edit, and validate constraints

Virtual Graphs:

Create and configure virtual graphs and virtual graph mappings

Data:

Create and configure data sources

Databases:

Manage databases
Update database properties and namespaces
See and kill running queries
Load and remove data
Manage GraphQL Schemas
Manage BI Mapping

Security:

Create users and roles
Assign permissions to users and roles

If your Stardog server users and roles are managed through LDAP, Stardog Studio will restrict the creation of users and assigning of roles. From the Security hub, admins will only have the ability to manage permissions for users and roles.

Studio Preference options

Stardog Studio has a number of preferences that can be set based on user choice.

To change a preference:

Open Studio’s preferences with the following keyboard shortcuts.

Mac: cmd ,
Windows/Linux: Meta + ,. The meta key is likely alt or cmd.

Update the preference attribute to the desired value.
Save your preferences - the theme should immediately take effect.

Mac: cmd s
Windows/Linux: Meta s. The meta key is likely alt or cmd.

Preference	Description	Default Value	Additional notes
editorFontSize	Font size of all editor inputs.	14
editorToolTips	If `true` (the default), Studio will provide tooltips for definitions and errors in text editors. If `false`, Studio will not show any tooltips in any editor.	true
includeConstraintsInModelsHub	If `true` (the default), Studio will dynamically query for and write constraints from your database to a named graph for Constraints when creating and editing models in the Models hub. If `false`, Studio will not include that information. In rare cases, setting this to false can improve Studio performance.	true
labelPredicatesByDatabase	Label predicates order for search and visualization. These must be the full URI.
modelsBaseIriByDatabase	Base IRI for creating new items in the Models Hub. This must be the full IRI.
queryLimit	The LIMIT to apply (specifying maximum number of results) to all non-CONSTRUCT/DESCRIBE SPARQL queries run inside of Studio.	1000	If set to 0, this preference will be ignored. The maximum limit is 50000.
theme	Studio color theme. If `dark` (the default), Studio will be displayed in a dark theme. If `light`, Studio will be displayed in a light theme.	"dark"
useSchemaForAutocompletion	If `true` (the default), Studio will dynamically include schema information from your databases, such as types and relationships, in autocomplete suggestions. If `false`, Studio will not include that information. In rare cases, setting this to `false` can improve Studio performance.	true
useSchemaForNamedGraphs	If `true` (the default), Studio will include named graph information from your databases in the named graph selector. If `false`, Studio will not include that information. In rare cases, setting this to `false` can improve Studio performance.	true

Getting Support

For questions, comments, or feature requests, please post in the Studio section of the Stardog Community.

Learning More

The Stardog blog includes post about new Studio functionality. All of those posts are available under the Studio Tag.

Blog posts cover topics like SHACL support, Stored Queries, Query Plans, and Visualization.

Contributing

Stardog.js

Stardog.js is a Javascript library for communicating with a Stardog server. This is what Studio uses to interact with Stardog, and it can be easily plugged into your own Stardog-based application.

Parsers

The parsers used by Stardog Studio are available on Github. These provide support for all of the languages supported by Studio, from the standards like SPARQL and Turtle to Stardog specific syntaxes like SMS.

Language extensions

In case you’d like to have Stardog Studio’s language intelligence available in other IDEs, we’ve made Studio’s language servers freely available as Visual Studio Code Extensions and as unpackaged JavaScript modules.

Collecting usage data

To improve Stardog Studio, we collect anonymous usage data. We only collect information like session duration, feature usage, and the size of queries and results. We never collect the actual content of queries or results. To opt-out, set telemetryConsent to false in your Preferences. You can access your preferences using the following keyboard shortcuts:

Mac: cmd ,
Windows/Linux: Meta + ,. The meta key is likely alt or cmd.