From ba63dbd9edc0d58e5f0891ead979674b1b45ad17 Mon Sep 17 00:00:00 2001 From: Tom Lane Date: Tue, 20 Jun 2017 13:39:57 -0400 Subject: [PATCH] Upgrade documentation connected with shared_preload_libraries et al. Noplace in the documentation actually defined what these variables contain. Define them as lists of arguments for LOAD, and improve that command's documentation a bit. Discussion: https://postgr.es/m/CAB-oJtxHVDc3H+Km3CjB9mY1VDzuyaVH_ZYSz7iXcRqCtb93Ew@mail.gmail.com --- doc/src/sgml/config.sgml | 27 +++++++++++++++++---------- doc/src/sgml/ref/create_function.sgml | 5 +++-- doc/src/sgml/ref/load.sgml | 11 ++++++----- 3 files changed, 26 insertions(+), 17 deletions(-) diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 0b943f4c63..3aca6479b1 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -7003,12 +7003,6 @@ SET XML OPTION { DOCUMENT | CONTENT }; tcl, or python. - - For each parameter, if more than one library is to be loaded, separate - their names with commas. All library names are converted to lower case - unless double-quoted. - - Only shared libraries specifically intended to be used with PostgreSQL can be loaded this way. Every PostgreSQL-supported library has @@ -7037,6 +7031,10 @@ SET XML OPTION { DOCUMENT | CONTENT }; This variable specifies one or more shared libraries that are to be preloaded at connection start. + It contains a comma-separated list of library names, where each name + is interpreted as for the command. + Whitespace between entries is ignored; surround a library name with + double quotes if you need to include whitespace or commas in the name. The parameter value only takes effect at the start of the connection. Subsequent changes have no effect. If a specified library is not found, the connection attempt will fail. @@ -7083,10 +7081,15 @@ SET XML OPTION { DOCUMENT | CONTENT }; This variable specifies one or more shared libraries that are to be - preloaded at connection start. Only superusers can change this setting. + preloaded at connection start. + It contains a comma-separated list of library names, where each name + is interpreted as for the command. + Whitespace between entries is ignored; surround a library name with + double quotes if you need to include whitespace or commas in the name. The parameter value only takes effect at the start of the connection. Subsequent changes have no effect. If a specified library is not found, the connection attempt will fail. + Only superusers can change this setting. @@ -7120,9 +7123,13 @@ SET XML OPTION { DOCUMENT | CONTENT }; This variable specifies one or more shared libraries to be preloaded at - server start. This parameter can only be set at server - start. If a specified library is not found, the server will fail to - start. + server start. + It contains a comma-separated list of library names, where each name + is interpreted as for the command. + Whitespace between entries is ignored; surround a library name with + double quotes if you need to include whitespace or commas in the name. + This parameter can only be set at server start. If a specified + library is not found, the server will fail to start. diff --git a/doc/src/sgml/ref/create_function.sgml b/doc/src/sgml/ref/create_function.sgml index 3f86141f80..072e033687 100644 --- a/doc/src/sgml/ref/create_function.sgml +++ b/doc/src/sgml/ref/create_function.sgml @@ -541,8 +541,9 @@ CREATE [ OR REPLACE ] FUNCTION dynamically loadable C language functions when the function name in the C language source code is not the same as the name of the SQL function. The string obj_file is the name of the - file containing the dynamically loadable object, and + class="parameter">obj_file is the name of the shared + library file containing the compiled C function, and is interpreted + as for the command. The string link_symbol is the function's link symbol, that is, the name of the function in the C language source code. If the link symbol is omitted, it is assumed diff --git a/doc/src/sgml/ref/load.sgml b/doc/src/sgml/ref/load.sgml index a5a6ef8e67..6e9182fa3b 100644 --- a/doc/src/sgml/ref/load.sgml +++ b/doc/src/sgml/ref/load.sgml @@ -38,11 +38,12 @@ LOAD 'filename' - The file name is specified in the same way as for shared library - names in ; in particular, one - can rely on a search path and automatic addition of the system's standard - shared library file name extension. See for - more information on this topic. + 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 ). 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 for more information on this topic.