Skip to content

qEndpoint CLI commands

Jump to bottom
Antoine Willerval edited this page Jan 23, 2024 · 1 revision

This page explains the different commands of the qEndpoint CLI.

Table of contents

rdfhdt cli

The qEndpoint core is based on the rdfhdt/hdt-java library, its CLI is also based on it and is extending it.

The installation and the usage of the rdfhdt cli is available here, it is not required by qEndpoint CLI.

A mention (QEP specific) was added to the part only relative to the qEndpoint cli.

Installation

To install the CLI, you can follow the cli installation guide available here.

Once this is done, you should have access to all the qendpoint cli commands.

Commands

Here a list of the commands provided by the qEndpoint CLI.

qendpoint (QEP specific)

qendpoint [-client]

This command starts the endpoint inside the current directory.

Options

  • -client Open the endpoint in the userhome instead of the current directory.

rdf2hdt

rdf2hdt (input) (output)
    [-base (uri)] [-canonicalntfile] [-cattree] [-cattreelocation (location)] [-color]
    [-config (configfile)] [-disk] [-disklocation (location)] [-index] [-multithread] 
    [-options (options)] [-printoptions] [-quiet] [-rdftype (type)] [-version]

This command converts an RDF file into an HDT file.

Options

  • -base (uri) Base URI for the dataset
  • -canonicalntfile Only for NTriples input. Use a Fast NT file parser the input should be in a canonical form. See definition.
  • -cattree Use HDTCatTree to split the HDT creation for big dataset
  • -cattreelocation (location) Only with -cattree, set the tree building location
  • -color Print using color (if available)
  • -disk Generate the HDT on disk to reduce memory usage
  • -disklocation (location) Location to run the generate disk, by default in a temporary directory, will be deleted after
  • -index Generate the second index(es) after the HDT generation
  • -multithread Use multithread logger
  • -config (configfile) HDT Conversion options file
  • -options (options) HDT Conversion options (override those of the config file)
  • -printoptions Print available options
  • -quiet Do not show progress of the conversion
  • -rdftype (type) Type of RDF Input (ntriples, nquad, n3, turtle, rdfxml, etc.)
  • -version Prints the HDT version number

hdtconvert (QEP specific)

hdtconvert (input) (output) (newType)
    [-color] [-config (configfile)] [-load] [-options (options)] [-quiet] [-version]

This command converts an HDT based with a particular dictionary to another one with another dictionary. The conversion from the two dictionaries should be available.

Options

  • -color Print using color (if available)
  • -config (configfile) HDT Conversion options file
  • -options (options) HDT Conversion options (override those of the config file)
  • -dict Print HDT dictionaries
  • -load Load the HDT into memory
  • -quiet Do not show progress of the conversion
  • -version Prints the HDT version number

hdtDiffCat (QEP specific)

hdtDiffCat (inputs)+ (output)
    [-color] [-config (configfile)] [-diff (file)] [-index] [-options (options)]
    [-quiet] [-version]

This command adds triples from multiple input HDTs into an output HDT. A diff can be applied with the -diff options via a RDF file.

Options

  • -color Print using color (if available)
  • -diff (diff file) RDF file describing the triples to remove from the input HDTs, the type is guessed on the filename extension.
  • -config (configfile) HDT options file
  • -options (options) HDT options (override those of the config file)
  • -quiet Do not show progress of the conversion
  • -version Prints the HDT version number

hdtVerify

hdtVerify (inputs)+ 
    [-binary] [-color] [-equals] [-load] [-progress] [-quiet] [-unicode]

This command tests if HDT files are valid.

Options

  • -color Print using color (if available)
  • -equals Test that all the input HDTs are equals instead of checking validity
  • -binary Print binaries of the string in case of signum error
  • -load Load the HDTs into memory
  • -progress Show progression
  • -unicode Ignore UNICODE order*
  • -quiet Do not show progress of the conversion
  • -version Prints the HDT version number

* The HDT string order isn't the same as the string order in unicode, without this param, safe HDT would be considered as invalid.

Clone this wiki locally