Skip to content

Plugin settings

Plugins are dynamically loaded at PgDog startup. These settings control which plugins are loaded.

Plugins are a TOML list, so for each plugin you want to enable, add a [[plugins]] entry to pgdog.toml. For example:

[[plugins]]
name = "bob_router"

[[plugins]]
name = "alice_router"

Note

Plugins can only be configured at PgDog startup. They cannot be changed after the process is running.

name

Name of the plugin to load. This is used by PgDog to look up the shared library object in LD_LIBRARY_PATH. For example, if your plugin name is router, PgDog will look for librouter.so on Linux, librouter.dll on Windows, and librouter.dylib on Mac OS.

Additionally, you can pass the relative or absolute path to the shared library itself:

name = "/opt/plugins/librouter.so"

Make sure the user running PgDog has read & execute permissions on the library.