HDFql Reference Manual v2.6.0

6.8.18SET PLUGIN PATH

Syntax

SET PLUGIN PATH {{path_name [, path_name]*} | DEFAULT}

Description

Set the path57 where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library. Multiple paths can be specified at once by separating their names with a comma (,). In other words, to perform certain actions, HDFql/HDF5 library needs to find and dynamically load the appropriate shared library responsible for the action (e.g. to write a result set into an Excel file, HDFql needs to find and dynamically load a shared library named “libxl” that is responsible for handling files of this type). In case the keyword DEFAULT is specified, the path where plugins are searched for and dynamically loaded by HDFql/HDF5 library is set to directory “%ALLUSERSPROFILE%/hdf5/lib/plugin” (on Windows) or “/usr/local/hdf5/lib/plugin” (on Linux/macOS), as well as the working directory currently in use (i.e. “.”).

Parameter(s)

path_name – mandatory string that specifies the name of the path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library.

Return

Nothing

Example(s)

# set path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library to "/home/dummy" and "/usr/lib"
SET PLUGIN PATH /home/dummy, /usr/lib

# show (i.e. get) path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library (should return "/home/dummy" and "/usr/lib")
SHOW PLUGIN PATH 

# set path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library to the default value
SET PLUGIN PATH DEFAULT 

# show (i.e. get) path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library (should return "%ALLUSERSPROFILE%/hdf5/lib/plugin" (on Windows) or "/usr/local/hdf5/lib/plugin" (on Linux/macOS), as well as ".")
SHOW PLUGIN PATH

Notes

  1. By default (i.e. upon initialization of the HDFql library), the path where plugins (in the form of shared libraries) are searched for and dynamically loaded by HDFql/HDF5 library is set to directory “%ALLUSERSPROFILE%/hdf5/lib/plugin” (on Windows) or “/usr/local/hdf5/lib/plugin” (on Linux/macOS), as well as the working directory currently in use (i.e. “.”). ↩