ext_plugin_config is used to declare the external table C++ plugins that need to be loaded for the cluster and their dynamic library locations.
Overview
The configuration value is a JSON array. Each element is an object that contains the required name field and the optional path field. name specifies the plugin name (for example, paimon). path specifies the absolute path of the plugin's dynamic library .so file. If path is not specified, the system searches for the file in LD_LIBRARY_PATH according to the naming convention lib_ob_<name>.so (the system first merges _ob_additional_lib_path into the search path). The corresponding .so file must be accessible to each OBServer node.
This configuration adopts a lazy loading mechanism and is read only once during the process lifecycle. When external tables are first identified, the system parses the JSON and loads all entries using dlopen. Modifying the configuration at runtime only updates the persisted values; the loaded plugin set remains unchanged. Changes take effect only after restarting the OBServer.
Attributes
Attribute |
Description |
|---|---|
| Parameter type | String |
| Default Value | [{"name":"paimon"}] |
| Value range | must be a JSON array; empty array[]Indicates not to load any external table plugins. Each element must be an object containing the required fields.name(non-empty, length ≤ 64, case-insensitive, internally converted to lowercase) and optional fields.path(The absolute path. If empty or unspecified, it will be treated aslib_ob_<name>.soParsing). The array can contain up to 256 elements. Excess elements are truncated and logged.name / pathFollow the JSON escape rules (write backslashes as\\). Invalid JSON or non-array values are logged and skipped during loading, and no plugins are loaded. |
| Modifiable | Yes, you can use the following methods:ALTER SYSTEM SETStatement modification. |
| Whether to restart the OBServer node for the change to take effect | Yes, the modification takes effect only after the OBServer node is restarted. |
Usage instructions
- The default configuration declares the loading of the Paimon plugin. Place
lib_ob_paimon.soand its dependency libraries under theLD_LIBRARY_PATHof each OBServer node. If the.sofile is not in the default search path, use thepathfield to specify the absolute path. - After modifying the configuration, you must restart all OBServer nodes. The configuration and
.solayout on each node must be consistent; otherwise, some nodes may report "plugin not loaded".
Configuration example
-- View Current Value
SHOW PARAMETERS LIKE 'ext_plugin_config';
-- Default configuration: searches for lib_ob_paimon.so according to LD_LIBRARY_PATH.
ALTER SYSTEM SET ext_plugin_config = '[{"name":"paimon"}]';
-- Explicitly specify the absolute path of the dynamic library.
ALTER SYSTEM SET ext_plugin_config = '[{"name":"paimon","path":"/home/admin/oceanbase/lib/lib_ob_paimon.so"}]';
-- Declare Multiple Plugins at Once
ALTER SYSTEM SET ext_plugin_config = '[{"name":"paimon"},{"name":"odps","path":"/abs/lib_ob_odps.so"}]';
-- Disable all external table plugins
ALTER SYSTEM SET ext_plugin_config = '[]';