↑↓ select ↵ open ⌫ change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

SQL Commands / Extensions & Access Methods

load a shared library file

Reading PG 18current·documented in 30 of 30 versions, 6.4 to 20

Syntax

LOAD 'filename'
Syntax diagrams

Read left to right. Branches are choices, bypasses are optional, loops repeat. Select an underlined parameter to open its rule.

LOAD ' filename '

Description

This command loads a shared library file into the PostgreSQL server's address space. If the file has been loaded already, the command does nothing. Shared library files that contain C functions are automatically loaded whenever one of their functions is called. Therefore, an explicit LOAD is usually only needed to load a library that modifies the server's behavior through “hooks” rather than providing a set of functions.

The library file name is typically given as just a bare file name, which is sought in the server's library search path (set by dynamic_library_path). Alternatively it can be given as a full path name. In either case the platform's standard shared library file name extension may be omitted. See Section 36.10.1 for more information on this topic.

Non-superusers can only apply LOAD to library files located in $libdir/plugins/ — the specified filename must begin with exactly that string. (It is the database administrator's responsibility to ensure that only “safe” libraries are installed there.)

Compatibility

LOAD is a PostgreSQL extension.

See Also

CREATE FUNCTION

Version history 15
  1. 16 → 17 changed
  2. 13 → 14 changed
  3. 11 → 12 changed
  4. 10 → 11 changed
  5. 9.6 → 10 changed
  6. 9.5 → 9.6 changed
  7. 8.4 → 9.0 changed
  8. 8.2 → 8.3 changed
  9. 8.1 → 8.2 changed
  10. 8.0 → 8.1 changed
  11. 7.4 → 8.0 changed
  12. 7.3 → 7.4 changed
  13. 7.1 → 7.2 changed
  14. 7.0 → 7.1 changed
  15. 6.4 → 6.5 changed

Related entries

Definition snapshot: b7bd9cda · English manual source