Using plugins¶
What’s in this document?
Multiple GraphDB features are implemented as plugins based on the GraphDB Plugin API. Each is described in a section of the GraphDB documentation that is most relevant to the features that the plugin enables.
Plugin |
Description |
|---|---|
Exploring and searching semantic similarity in RDF resources. |
|
Ranking entities by interconnectedness with the RDF Rank Plugin |
Identifying the more important or more popular entities in the repository by examining their interconnectedness. |
Defining and executing JavaScript code, further enhancing data manipulation with SPARQL. |
|
Tracking changes within the context of a transaction identified by a unique ID. |
|
Generation of inference closure from a specific named graph at query time. |
|
Finding out how a given statement has been derived by the inferencer. |
|
Exploring complex relationships between resources. |
Several of the plugins let you create and access user-defined indexes. These are created with SPARQL and differ from the system indexes in that they can be configured dynamically at runtime. Any user with write access to a given repository can define such an index.
These are:
Plugin |
Description |
|---|---|
Suggestions for the IRIs’ local names in the SPARQL editor and the View Resource page. |
|
Support for GeoSPARQL, a standard for representing and querying geospatial linked data for the Semantic Web from the Open Geospatial Consortium (OGC). The plugin allows the conversion of Well-Known Text from different coordinate reference systems (CRS) into the CRS84 format, which is the default CRS according to the OGC. |
|
Support of 2-dimensional geospatial data that uses the WGS84 Geo Positioning RDF vocabulary (World Geodetic System 1984). |
|
Accessing past states of your database through versioning of the RDF data model level. |
|
Calling of text mining algorithms and generation of new relationships between entities. |
|
Providing transactional sequences for GraphDB. A sequence is a long counter that can be atomically incremented in a transaction to provide incremental IDs. |
The GraphDB Connectors are also user-defined indexes.
Activate or deactivate plugins¶
GraphDB plugins can be in an active or inactive state. This means attaching them to or detaching them from GraphDB on a fundamental level.
From the Workbench¶
Most of the plugins can be activated or deactivated from the Workbench in . By default, all plugins available there are activated.
Plugins are activated or deactivated for individual repositories. For example, you might have the change-tracking plugin active for one repository and inactive for another. In the example below, all plugins are on for the my_repo repository.
Note
The Provenance plugin needs to be registered first in order to be activated. Once registered, it will appear in the list.
If you deactivate a plugin, you will not be able to enable it. For example:
In , deactivate Autocomplete.
If you go to , you will get the following error message:
With a SPARQL query¶
To activate a plugin with a query from the SPARQL editor, run:
INSERT DATA { <u:a> <http://www.ontotext.com/owlim/system#startplugin> "plugin-name".}
To deactivate it:
INSERT DATA { <u:a> <http://www.ontotext.com/owlim/system#stopplugin> "plugin-name".}
The subject of these triple patterns can be anything. The important thing is to use the predicate shown and to name the plugin to toggle.
Note
Spell out the plugin names the way they are displayed in the Workbench page shown above.
List plugins and their state¶
To get a list of all plugins and their current state (active/inactive), run:
SELECT ?plugin ?state { ?plugin <http://www.ontotext.com/owlim/system#listplugins> ?state .}
Enable or disable plugins¶
Some of the plugins also have an enabled and disabled state, provided that they have been activated before that. These include:
Autocomplete index¶
The index can be enabled both from in the Workbench and with a SPARQL query.
Change tracking¶
You can enable change tracking for a certain transaction ID. See how in the Usage section of the Change tracking page.
Data history and versioning¶
See how to enable or disable this plugin at Enable or disable a plugin.
GeoSPARQL support¶
See how to enable this plugin in the Enable plugin section of the GeoSPARQL support page.
RDF Rank¶
This refers to the RDF Rank filtered mode when you want to calculate the rank only of certain entities. Learn more about this in the Rank filtering section of the Ranking results page.