begriffs open source - ai-pg/blob - full-docs/man7/LOAD.7

   1 '\" t
   2 .\"     Title: LOAD
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "LOAD" "7" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 LOAD \- load a shared library file
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 LOAD \*(Aq\fIfilename\fR\*(Aq
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 This command loads a shared library file into the
  40 PostgreSQL
  41 server\*(Aqs 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
  42 \fBLOAD\fR
  43 is usually only needed to load a library that modifies the server\*(Aqs behavior through
  44 \(lqhooks\(rq
  45 rather than providing a set of functions\&.
  46 .PP
  47 The library file name is typically given as just a bare file name, which is sought in the server\*(Aqs library search path (set by
  48 dynamic_library_path)\&. Alternatively it can be given as a full path name\&. In either case the platform\*(Aqs standard shared library file name extension may be omitted\&. See
  49 Section\ \&36.10.1
  50 for more information on this topic\&.
  51 .PP
  52 Non\-superusers can only apply
  53 \fBLOAD\fR
  54 to library files located in
  55 $libdir/plugins/
  56 \(em the specified
  57 \fIfilename\fR
  58 must begin with exactly that string\&. (It is the database administrator\*(Aqs responsibility to ensure that only
  59 \(lqsafe\(rq
  60 libraries are installed there\&.)
  61 .SH "COMPATIBILITY"
  62 .PP
  63 \fBLOAD\fR
  64 is a
  65 PostgreSQL
  66 extension\&.
  67 .SH "SEE ALSO"
  68 .PP
  69 CREATE FUNCTION (\fBCREATE_FUNCTION\fR(7))