OWLIM Frequently Asked Questions

General

What is OWLIM?

OWLIM is a sematic repository - a software component for storing and manipulating huge quantities of RDF data. OWLIM is packaged as a Storage and Inference Layer (SAIL) for the Sesame OpenRDF framework (http://www.aduna-software.com/technology/sesame).

What is a Semantic Repository?

A semantic repository is a software component for storing and manipulating RDF data. It is made up of three distinct components:

• An RDF database for storing, retrieving, updating and deleting RDF statements (triples)
• An inference engine that uses rules to infer 'new' knowledge from explicit statements
• A powerful query engine for accessing the explicit and implicit knowledge

Where does the name "OWLIM" come from?

The name originally comes from the term "OWL In Memory" and is fitting for what became OWLIM-Lite. However, OWLIM-SE uses a transactional, index-based file-storage layer where "In Memory" is no longer appropriate. Nevertheless, the name has stuck and it is seldom that anyone ever asks where it came from...

How do I use OWLIM?

OWLIM is packaged as a Storage and Inference Layer (SAIL) for the Sesame RDF framework (http://www.aduna-software.com/technology/sesame). OWLIM can be used in two different ways:

One approach is to use it as a library, an example of which is provided in the release distribution that can be started by using 'example.cmd' in the 'getting-started' folder.

Another approach is to download the full version of Sesame and configure OWLIM-SE as a plug-in. This method uses the Sesame HTTP server hosted in Tomcat (or similar) and in this way you can use Sesame togther with OWLIM as a server application, accessed via the standard Sesame APIs.

Sesame version 2.2 onwards includes the Sesame Workbench - a convenient Web Application for managing repositories, importing/exporting RDF data, executing queries, etc. For more information please check the "doc" folder of the OWLIM-SE archive.

What is the difference between OWLIM-Lite and OWLIM-SE?

OWLIM-Lite and OWLIM-SE are identical in terms of usage and integration for storing and managing RDF data. They share the same inference mechanisms and semantics (rule-compiler, etc). The different editions of OWLIM use different indexing, inference, and query evaluation implementations, which results in different performance, memory requirements, and scalability.

OWLIM-Lite is designed for medium data volumes (below 100 million statements) and for prototyping. Its key characteristics are as follows:

• reasoning and query evaluation are performed in main memory
• it employs a persistence strategy that ensures data preservation and consistency
• the loading of data, including reasoning, is extremely fast
• easy configuration

OWLIM-SE is suitable for handling massive volumes of data and very intensive querying activities. It is designed as an enterprise-grade database management system. This has been made possible through:

• file-based indices, which enable it to scale to billions of statements even on desktop machines
• special-purpose index and query optimization techniques, ensuring fast query evaluation against very large volumes of data
• optimized handling of owl:sameAs (identifier equality) to boost efficiency for data integration tasks
• efficient retraction of explicit statements and their inferences, which allows for efficient delete operations
• a range of powerful 'advanced features' including: Full text search (Node search, RDF search), ranking, selection and notifications

See http://ontotext.com/owlim/version-map.html for more details.

What kind of SPARQL conformance is supported?

All editions of OWLIM support:

• SPARQL 1.1 Update (May 2011 draft)
• SPARQL 1.1 Query (May 2011 draft)
• SPARQL 1.1 protocol (January 2010 draft)
• SPARQL 1.1 Federation extensions

The the SPARQL 1.1 Graph Store Protocol will be supported in subsequent versions of OWLIM.

Technical information

How does OWLIM-SE index triples?

There are several types of indices available, *all* of which apply to *all* triples, whether explicit or implicit. These indices are maintained automatically.

The main indexes that are always used are:

• predicate-object-subject-context (POSC)
• predicate-subject-object-context (PSOC)

There are other optional indices and these have advantages for specific datasets, retrieval patterns and query loads. These are switched off by default.

For some datasets, or when executing queries with triples patterns with a wild-card for the predicate, a pair of indices can be used that map from resources (subject, object) to predicate, i.e.

• subject-predicate (SP)
• object-predicate (OP)

This pair of indices are known as 'predicate lists', see enablePredicateList in the user guide.

For more efficient processing of named graphs, two other indexes can be used:

• predicate-context-subject-object (PCSO)
• predicate-context-object-subject (PCOS)

These can be switched on using the enable-context-index parameter.

There are also several variations on full-text-search indexes for both Node Search and lucene-based RDF Search. Details of these can be found in the user guide.

How much disk space does OWLIM-SE require to load my dataset?

There is no simple answer to this question, since it depends on reasoning complexity (how many inferred triples), how long the URIs are, what additional indices are used, etc. For an example, the following table shows the disk space requirement in bytes per explicit statement when loading the wordnet dataset with various OWLIM-SE configurations:

When planning for storage capacity based on input RDF file size, this depends not only on the OWLIM-SE configuration, but also the RDF file format used and the complexity of its contents. The following table can be used to give a rough estimate for the expansion to be expected from an input RDF file to OWLIM-SE storage requirements, e.g. when using OWL2-RL with all optional indices turned on, OWLIM-SE will need about 6.7GB of storage space to load a one gigabyte N3 file - with no inference ('empty') and no optional indices, OWLIM-SE will need about 0.7GB of storage space to load a one gigabyte Trix file. Again, these results were created with the Wordnet dataset:

How much disk space does OWLIM-SE need per statement?

Firstly, note that OWLIM-SE computes inferences as new explicit statements are committed to the repository. The number of inferred statements can be zero (when using the 'empty' rule set) or many multiples of the number of explicit statements (it depends on the chosen ruleset and the complexity of the data).

The disk space required for each statement further depends on the size of the URIs and literals, but for typical datasets around 200 bytes is required with only the default indices, up to about 300 bytes when all optional indices are turned on.

So when using the default indices, a good estimate for the amount of disk space you will need is 200 bytes per statement (explicit and inferred), i.e.

• 1 million statements => ~200 Megabytes storage
• 1 billion statements => ~200 Gigabytes storage
• 10 billion statements => ~2 Terabytes storage

How much memory does OWLIM-Lite need?

OWLIM-Lite uses a similar mechanism to OWLIM-SE for maintaining a dictionary of internal identifiers that map to resources. This allows the internal identifiers to be used for indexing statements rather than using the full URI/blank-node/literal for every statement where a resource is referenced. Every unique resource requires some disk storage space and a further 12 bytes in RAM.

Explicit statements are stored in RAM and require 13 bytes per statement. Implicit statements require 8 bytes per statement.

Assuming roughly 3 unique explicit statements to every 1 unique resources then total memory requires will vary from approximately 17 bytes per explicit statement (empty rule-set) to around 40 bytes per statement (expressive rule-sets). However, this will also vary depending on the 'geometry' of the input data and the amount of use of complex (OWL) language features.

The above figures give the memory footprint for storing statements. In order to be useful, an OWLIM-Lite instance needs more memory for maintaining these data structures, executing queries, loading and inferencing. A safe figure is to allow twice as much memory, i.e. the storage space of the statements + resources multiplied by 2. Therefore, for practical purposes OWLIM-Lite will need between 34 and 80+ bytes per statement.

What is the maximum amount of data that can be stored in OWLIM-Lite?

OWLIM-Lite is only capable of storing up to 1 billion unique resources. This sets a practical limit of approximately 3 billion explicit statements (assuming 3:1 ratio). Using the above metrics, storing this much data will require between 100 and 240 GB of RAM (or more).

It should be noted that these are theoretical limits and Ontotext have not attempted to load this much data in to an OWLIM-Lite instance.

Can OWLIM answer queries in parallel?

Yes. Both OWLIM-Lite and OWLIM-SE can process queries concurrently.

Furthermore, when OWLIM-SE is used in a cluster configuration, the throughput of parallel query answering can be scaled (almost) linearly by adding more nodes.

What kind of transaction isolation is supported?

OWLIM supports the read-committed isolation level, i.e. pending updates are not visible to other connected users until the complete update transaction has been committed. However, for efficiency reasons and unlike typical relational database behaviour, uncommitted changes are not 'visible' even using the connection that made the updates.

Are solid-state drives better than hard-disk drives for OWLIM-SE (and OWLIM-Enterprise)?

Yes. Unlike relational databases, a semantic database needs to conduct inference for inserted and deleted statements. This involves making highly unpredictable joins using statements anywhere in the indices for all new/deleted statements. Despite paging as best as possible, a large number of disk seeks can be expected and SSDs perform far better than HDDs in this task.

The difference between performance on SSDs and HDDs is most pronounced when OWLIM-SE is running in the safe transaction mode (the default). In fast mode, updated pages are not flushed to disk at the end of a commit operation - instead they are only swapped to disk when the cache memory is exhausted. However, in safe mode all updated pages are flushed to disk before a commit operation returns and the higher number of writes causes a small slow-down when using SSDs, but a large slow-down when using HDDs. In performance tests using LUBM(1000) (approximately 135 million statements) with a 1 GB cache, the difference in load times in fast and safe modes increases quite differently when comparing SSDs and HDDs:

• SSD: safe mode loading is between 40% and 50% slower than fast mode
• HDD: safe mode loading is approximately 16 times slower than fast mode

The recommended transaction mode is 'safe'. However, if only HDDs are available then there is the option of using the 'fast' transaction mode with the corresponding increase in performance and the increased risk of data loss in the event of an abnormal termination. Switching modes is straightforward and just requires a restart of OWLIM.

What kind of RAID set-up is best?

RAID-0 gives good performance, but is more likely to suffer problems due to disk failure. RAID-5 is a good balance between resilience/redundancy and cost. Using SSDs, we have (little more than anecdotal) evidence that RAID-0 is fast, RAID-1 is slower, and RAID-5 is slower with less than 4 disks and abut the same as RAID-0 with 4 or more disks.

Configuration

How can I retrieve my repository configurations from the Sesame SYSTEM repository?

When using a LocalRepositoryManager, Sesame will store the configuration data for repositories in its own 'SYSTEM' repository. A tomcat instance will do the same and you will see 'SYSTEM' under the list of repositories that the instance is managing. To see what configuration data is stored, connect to the SYSTEM repository and execute the following query:

PREFIX sys:  <http://www.openrdf.org/config/repository#>
PREFIX sail: <http://www.openrdf.org/config/repository/sail#>

select ?id ?type ?param ?value
where {
  ?rep sys:repositoryID ?id .
  ?rep sys:repositoryImpl ?impl .
  ?impl sys:repositoryType ?type .
  optional {
    ?impl sail:sailImpl ?sail .
    ?sail ?param ?value .
  }
  # FILTER( ?id = "specific_repository_id" ) .
}
ORDER BY ?id ?param

This will return the repository ID and type, followed by name-value pairs of configuration data for SAIL repositories, including the SAIL type - "owlim:Sail" for OWLIM-SE and "swiftowlim:Sail" for OWLIM-Lite. OWLIM-Enterprise master nodes are not SAIL repositories and have the type "owlim:ReplicationCluster".

If you uncomment the FILTER clause you can substitute a repository id to get the configuration just for that repository.

How do I change the configuration of an OWLIM Sesame repository after it has been created?

There is no easy generic way of changing the configuration - it is stored in the SYSTEM repository created and maintained by Sesame. However, OWLIM allows overriding of these parameters by specifying the parameter values as JVM options. For instance, by passing -Dcache-memory=1g option to the JVM, OWLIM-SE will read it and use its value to override whatever was configured by the .ttl file. This is convenient for temporary set-ups that require easy and fast configuration change, e.g. for experimental purposes.

Changing the configuration in the SYSTEM repository is trickier, because the configurations are usually structured using blank node identifiers - which are always unique, so attempting to modify a statement with a blank node by using the same blank node identifier will fail. However, this can be achieved with SPARQL UPDATE using a DELETE-INSERT-WHERE command as follows:

PREFIX sys:  <http://www.openrdf.org/config/repository#>
PREFIX sail: <http://www.openrdf.org/config/repository/sail#>
PREFIX onto: <http://www.ontotext.com/trree/owlim#>
DELETE { GRAPH ?g {?sail ?param ?old_value } }
INSERT { GRAPH ?g {?sail ?param ?new_value } }
WHERE {
  GRAPH ?g { ?rep sys:repositoryID ?id . }
  GRAPH ?g { ?rep sys:repositoryImpl ?impl . }
  GRAPH ?g { ?impl sys:repositoryType ?type . }
  GRAPH ?g { ?impl sail:sailImpl ?sail . }
  GRAPH ?g { ?sail ?param ?old_value . }
  FILTER( ?id = "repo_id" ) .
  FILTER( ?param = onto:enable-context-index ) .
  BIND( "true" AS ?new_value ) .
}

Modify the last three lines of the update command to specify the repository ID, the parameter and the new value. Then execute against the SYSTEM repository. In this example, the enable-context-index is changed, but there are other parameters that can not be changed once the repository is created, e.g. the rule-set (in the case of OWLIM-SE).

A restart of Sesame/OWLIM is required. If deployed using Tomcat then the easiest way is just to restart Tomcat itself.

How can the rule set be changed?

Using OWLIM-Lite, the rule-set parameter can be changed like any other parameter. After the repository is restarted, insert and delete a statement in order to trigger a full re-computation of the inferred statements.

Using OWLIM-SE or OWLIM-Enterprise, this is more difficult. It will be necessary to export/backup all explicit statements and recreate a new repository with the required rule-set. Once created, the explicit statements exported from the old repository can be imported in to the new one.

How do I rename a repository?

For an existing repository that has already been used:

1. Restart tomcat to ensure that the repository is not loaded in to memory (with locked/open files)
2. Select the SYSTEM repository
3. Execute the following SPARQL update with the appropriate old and new names substituted in the last two lines

   PREFIX sys:<http://www.openrdf.org/config/repository#>
   DELETE { GRAPH ?g { ?repository sys:repositoryID ?old_name } }
   INSERT { GRAPH ?g { ?repository sys:repositoryID ?new_name } }
   WHERE {
     GRAPH ?g { ?repository a sys:Repository . }
     GRAPH ?g { ?repository sys:repositoryID ?old_name . }
     FILTER( ?old_name = "old_repository_name" ) .
     BIND( "new_repository_name" AS ?new_name ) . }
   

4. Rename the folder for this repository on the file system
   • mv /usr/share/tomcat6/.aduna/openrdf-sesame/repositories/OLD_NAME /usr/share/tomcat6/.aduna/openrdf-sesame/repositories/NEW_NAME (linux/unix)
   • The location for the 'repositories' folder under Windows varies depending on the version of Windows and the installation method for Tomcat - some possibilities are:
     • C:\Users\<username>\AppData\Roaming\Aduna\repositories (Windows 7 when running Tomcat as a user)
     • C:\Documents and Settings\LocalService\Application Data\Aduna\OpenRDF Sesame\repositories (Windows XP running Tomcat as a service)
5. Reselect the SYSTEM repository and press F5

There is one other consideration regarding the storage folder: http://www.ontotext.com/trree/owlim#storage-folder If this is set to an absolute pathname and moving the repository requires an update of this parameter as well then you will now need to the value of this parameter (with the new name) as described in the question further up about modifying a repository configuration.

How do I set up license files for OWLIM-SE and OWLIM-Enterprise

Both OWLIM-SE and OWLIM-Enterprise worker nodes require license files for long term use. These can be obtained from Ontotext. When purchasing OWLIM-SE, you will receive one license file. When purchasing OWLIM-Enterprise, you will receive a license file for the worker nodes. Master nodes do not require a license file. License files should be stored where they are accessible to the processes that need to read them to validate the software, i.e. Tomcat instances or application software that embeds OWLIM.

When installing OWLIM-SE or OWLIM-Enterprise worker nodes, the license file can be set in several ways:

• Environment variable
  • Set the OWLIM_LICENSE_FILE environment variable to point to the license file. This will be overridden by the following methods.
• Repository configuration parameter
  • Set owlim:owlim-license in a Turtle configuration/template file, e.g. when using the Sesame console.
  • Set the 'License file' field when using the Sesame workbench (the repackaged version in the OWLIM distribution).
• System property
  • Use -Dowlim-license=<full_path_to_license> for the Java virtual machine that is running OWLIM.
  • When deployed using Tomcat, the CATALINA_OPTS or JAVA_OPTS environment variables can be set, i.e. -Dowlim-license=<full_path_to_license>, which will apply to all OWLIM-SE repositories as it overrides each configured repository's license file setting and the environment variable.
  • For linux installations, you can also set JAVA_OPTS in the /etc/default/tomcat6 file.

OWLIM-SE and OWLIM-Enterprise worker node licenses are different and will not work if used with the wrong software.

How do I run OWLIM-SE or an OWLIM-Enterprise worker node on a machine with more CPUs than licensed?

The maximum CPU count is checked during OWLIM initialisation by checking for the number of CPU cores available to the Java Virtual Machine (JVM) in which OWLIM is running. If the number of CPU cores available is greater than specified in the license file then OWLIM will still run, but it will throttle itself to use the equivalent of the licensed number of CPU cores.

OWLIM can be embedded in a user application or deployed using Tomcat/Sesame. In both cases, the user should restrict the number of CPUs available to the JVM in which OWLIM is running. The method to do this depends upon the operating system:

When deploying with Tomcat/Sesame, the easiest method is to edit the startup script(s) for tomcat using the above modifications. The scripts can be found in a variety of locations depending on the operating system, distribution and installation method. Some command locations are:

• /usr/share/tomcat6/bin/startup.sh
• /etc/init.d/tomcat6
• C:\Program Files\Apache Software Foundation\Tomcat 6

MacOS does not provide an easy means to set the processor affinity. The most straightforward method to limit CPU usage is to create a virtual machine (VM) (using VirtualBox for example) and set the number of processors for this VM to the number of licensed CPU cores. A free linux distribution can then be installed in the VM and Sesame/OWLIM/Tomcat set up as necessary. Alternatively, just use OWLIM as normal and rely on the internal throttling to manage CPU utilisation.

How can I script (automate) the creation of remote repositories?

This can be achieved on the command line using a repository configuration file (usually in Turtle format) and curl. The following steps must be followed:

• Create a repository configuration file containing the repository ID and its configuration parameters, e.g. filename config.ttl containing:

@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
@prefix rep: <http://www.openrdf.org/config/repository#>.
@prefix sr: <http://www.openrdf.org/config/repository/sail#>.
@prefix sail: <http://www.openrdf.org/config/sail#>.
@prefix owlim: <http://www.ontotext.com/trree/owlim#>.

[] a rep:Repository ;
   rep:repositoryID "my_repo_id" ;
   rdfs:label "Description of my repository" ;
   rep:repositoryImpl [
     rep:repositoryType "openrdf:SailRepository" ;
     sr:sailImpl [
       owlim:ruleset "owl-horst-optimized" ;
       sail:sailType "owlim:Sail" ;
       owlim:base-URL "http://example.org/owlim#" ;
       owlim:repository-type "file-repository" ;
      ]
   ].

• Update the Sesame SYSTEM repository with this configuration by issuing the following on the command line (all in one line) replacing the filename (config.ttl), URL to the remote server's SYSTEM directory (http://localhost:8080/openrdf-sesame/repositories/SYSTEM) and a unique context in which to put the repository configuration (http://example.com#g1):

curl -X POST -H "Content-Type:application/x-turtle"
    -T config.ttl
    http://localhost:8080/openrdf-sesame/repositories/SYSTEM/rdf-graphs/service?graph=http://example.com#g1

• Finally, update the SYSTEM repository with a single statement to indicate that the unique context is an instance of sys:RepositoryContext:

curl -X POST -H "Content-Type:application/x-turtle"
    -d "<http://example.com#g1> a <http://www.openrdf.org/config/repository#RepositoryContext>."
    http://localhost:8080/openrdf-sesame/repositories/SYSTEM/statements

Problems

Why am I getting this exception: java.lang.NoSuchMethodError: org.apache.lucene.queryParser.QueryParser?

You must add the Lucene jar file to the Java classpath (the Lucene core jar is included with the distribution). OWLIM-SE 4 is known to work properly with Lucene 3.0

I am getting this exception: java.lang.NoClassDefFoundError: Could not initialize class com.infomatiq.jsi.rtree.RTreeWithCoords

The jsi, log4j, sil and trove4j jar files (included with the distribution) must be added to the classpath.

Can not connect the JMX client (jconsole) to the Apache Tomcat instance.

Make sure that Tomcat has been configured to expose the JMX interface using either JAVA_OPTS, CATALINA_OPTS or by configuring the Windows Tomcat monitor application.

Why does my repository report a different number of explicit statements with different rule sets?

Each rule set defines both rules and some schema statements, otherwise known as axiomatic triples. These (read-only) triples are inserted in to the repository at intialisation time and count towards the total number of reported 'explicit' triples. The variation may be up to the order of hundreds depending upon the rule set.

Why can't I delete some statements?

Statements that were added during repository initialisation, either because they are asserted in rule files or because they were loaded using the "imports" parameter are marked read-only. Having read-only statements (especially schema definition statements) are one way to ensure that 'smooth delete' can operate very quickly.

OWLIM-SE does now allow read-only/schema statements to be modified when the repository is in a special mode. This feature will allow fast delete operations at the same time as ensuring that schemas can be changed when necessary. Full details on how to do this can be found in the OWLIM-SE user guide .

Why won't Sesame start in Tomcat?

This problem will manifest itself in many ways after deploying the Sesame/OWLIM war files to Tomcat's webapps directory. If you are unable to set the server URL in the Workbench then this is an indication that the problem has occurred. It will likely be due to a permissions problem on the logging directory for the openrdf-sesame server. To check this, point your browser directly at the Sesame server with a URL similar to the following:

http://localhost:8080/openrdf-sesame

If you receive a stack trace containing the following:

Invocation of init method failed; nested exception is java.io.IOException: Unable to create logging directory /usr/share/tomcat6/.aduna/openrdf-sesame/logs

then this indicates that Tomcat does not have write permission to its data directory (where it stores configuration, logs and actual repository data). To fix this, log in as root to the server machine and do the following:

mkdir /usr/share/tomcat6/.aduna/
chown tomcat6.tomcat6 /usr/share/tomcat6/.aduna/

Now when you use the server URL in your browser you should see the Sesame server welcome screen.

Sesame Workbench starts, but gives a memory error on the 'explore' and 'query' menus

The maximum heap space must be increased, i.e. Tomcat's Java virtual machine must be allowed to allocate more memory. This can be done by setting the environment variable 'CATALINA_OPTS' to include the desired value, e.g. -Xmx1024m

Can not copy OWLIM or 3rd party jars files the openrdf-sesame WEB-INF/lib directory.

This directory will not exist until the Sesame war files have been deployed to the [WEBAPPS] directory AND Tomcat is running. If the war files have been deployed, but the directory does not exist, try restarting Tomcat.

Can not connect the Sesame console to the local Sesame server at http://localhost:8080/openrdf-sesame

Make sure that the Sesame war files have been deployed and that Tomcat is running. Restart Tomcat if necessary.

Can not create an OWLIM repository using the Sesame console

Make sure that the repository template file(s) have been copied to the 'templates' sub-directory of the Sesame console's data directory. These files are:

• OWLIM-Lite - owlim-lite.ttl
• OWLIM-SE - owlim-se.ttl
• OWLIM-Enterprise - master.ttl and worker.ttl

Can not create an OWLIM repository, the Sesame console says 'unknown Sail type'

The Sesame console cannot find the OWLIM jar file. Make sure it was copied from the distribution zip file to the 'lib' sub-directory of the Sesame installation directory.

Cannot use my custom rule file (pie file), an exception occurred

To use custom rule files, OWLIM must be running in a Java Virtual Machine that has access to the Java compiler. The easiest way to do this is to use the Java runtime from a Java Development Kit (JDK).

Backup/restore/import/export

How do I preserve contexts when exporting and importing Data

In order to preserve the context (named graph) when exporting/importing the whole database, a context-aware RDF file format must be used, e.g. TriG. After serialising the repository to a file with this format (this can be done through the Sesame workbench Web application) the file can be imported with the following steps:

• Go to [Add]
• Choose Data format: TriG
• Choose RDF Data File: e.g. export.trig
• Clear the context text field (it will have been set to the URL of the file). If this is not cleared then all the imported RDF statements will be given a context of <file://export.trig> or similar.
• Upload

The TriX format (an XML-based context-aware RDF serialisation) can also be used.

How do I backup and restore a repository?

Several options are available:

The simplest method (that works for a small running system) is to export the database contents using the Sesame Workbench. If you want to preserve contexts then choose a suitable output format. However, this can be memory intensive.

Perhaps the best method to make a backup uses the graph store protocol and 'curl'. This can be achieved on the command line in a single step using the graph store protocol (change the repository URL and name of the export file accordingly):

curl -X GET -H "Accept:application/x-trig"
    "http://localhost:8080/openrdf-sesame/repositories/test_repo/rdf-graphs/service?
    graph=http://www.ontotext.com/explicit"  >  export.trig

This method will stream a snapshot of the database's explicit statements in to the 'export.trig' file.

A backup can also be done programmatically using the Sesame API. See the RepositoryConnection.exportStatements() method and the example in the next question.

If it is possible to shutdown the repository then a backup can be effected by copying the OWLIM storage directory (and any sub-directories). See the installation section for information about where OWLIM storage folders are located. To restore a repository from a back up, make sure the repository is not running and then replace the entire contents of the storage directory (and any sub-directories) with the backup. Then restart the repository and check the log file to ensure a successful start up.

OWLIM-Enterprise has an additional online backup feature that copies a binary database image from a worker node to the cluster master - see the OWLIM-Enterprise user guide.

How do I dump the contents of a large repository to RDF?

The Sesame openRDF workbench Web application has an export function that can be used to export the contents of moderately sized repositories. However, using this with large repositories (more than a hundred million statements or more) causes problems, usually time-outs for the Servlet container (Tomcat) hosting the application. Also, the workbench cannot be used when using OWLIM-SE without Tomcat.
Therefore, a more straightforward approach for exporting RDF data from repositories is to do this programmatically. The Sesame RepositoryConnection.getStatements() method can be called with the includeInferred flag set to false (in order not to serialise the inferred statements). Then the returned iterator can be used to visit every explicit statement in the repository and one of the Sesame RDF writer implementations can be used to output the statements in the chosen format. If the data will be re-imported, the N-Triples format is recommended, because this can easily be broken in to large 'chunks' that can be inserted and committed separately. The following code snippet shows how an export can be achieved using this approach:

How do I migrate data between incompatible versions of OWLIM?

While most versions of OWLIM are backward compatible, some major version number increases use such different data structures that disk images can no longer be automatically updated to the latest version.

The basic procedure is to export the RDF data from the old version of OWLIM-SE and then reload it in to a new repository instance that uses the new version of OWLIM-SE. Exporting is straightforward when using the Sesame workbench – simply click the 'Export' button, choose the format and click 'download'. To import in to a new repository, click 'add', select a format, specify the file and base URI, then click 'Upload'.
If not using the Sesame workbench, the export must be done programmatically using the RepositoryConnection.getStatements() API, because the Sesame console does not have an export function. NOTE: It should be possible to export only the explicit statements, as the inferred statements will be recomputed at load time. Fortunately, the Sesame console application does have a 'load' function and this can be used to reload the exported statements.

How can I load a large RDF/XML file without getting an "entity expansion limit exceeded" error?

The XML parser will generate an error similar to the following:

Parser has reached the entity expansion limit "64,000" set by the Application.

when it generates more than a specified number of 'entities'. The default limit for the built-in Java XML parser is 64,000, however it can be configured by using a Java system property. To increase the limit, pass the following to the JVM in which OWLIM/Sesame is running. Note that the actual value can be increased as necessary. Don't forget that if running in Tomcat then this must be passed to the Tomcat instance using the CATALINA_OPTS environment variable.

-DentityExpansionLimit=128000

How can I upgrade to a new version of OWLIM-SE without exporting and reimporting all my data?

There might be subtle differences between versions of OWLIM-SE that mean that exporting and re-importing explicit statements from the older version of the the repository is the best and safest means to upgrade. However, this can be lengthy with large databases.

Probably the fastest way to upgrade is to make a binary copy of the OWLIM storage folder and use the new version 'on top'. This will cause it to automatically upgrade the file formats (there are minor differences between versions) and from then on it should run fine with the new version.

1. Use the new version of OWLIM-SE to create an empty repository (with the right configuration, e.g. ruleset)
2. Shutdown any running OWLIM instance
3. Locate the storage folders for the current instance and the new instance
4. Delete the contents of the new storage folder (will be called something like repo_id/storage)
5. Copy all files and (sub-directories if present) from the old storage folder to the new storage folder
6. Restart the new instance

There is a good chance that it will take quite a long time to initialise as the storage files are modified, but it should be quicker than re-importing all the data.

How do I load large amounts of data in to OWLIM-SE or OWLIM-Enterprise?

In general RDF data can be loaded into a given Sesame repository using the 'load' command in the Sesame console application or directly through the workbench web application. However, neither of these approaches will work when using a very large number of triples, e.g. a billion statements. A common solution would be to convert the RDF data into a line-based RDF format (e.g. N-triples) and then split it into many smaller files (e.g. using the linux command 'split'). This would allow each file to be uploaded separately using either the console or workbench applications.

Developers

There is a fix in Sesame, but I don't want to wait for the next release. How can I build a snapshot version of Sesame?

1. Install ant 1.8 from http://ant.apache.org/
2. Install maven 2.2.1 - just download from http://maven.apache.org/ install in a convenient location and make sure mvn.bat is on your PATH so you can run it from the command line. No additional configuration is required.
3. Check out the desired Sesame branch from SVN - 2.6 is used in these instructions http://repo.aduna-software.org/svn/org.openrdf/sesame/branches/2.6
4. Open a command line and go to the core subdirectory of your branch working directory.
5. Run 'ant package'. It shows a warning about version numbers, just hit enter. Now go for lunch.
6. When you're back from lunch, the release SDK zip and the onejar are available in the target/ directory.

The compiled jars/zips will have 'SNAPSHOT' in their name.