Add missing documentation for BGWORKER_BYPASS_ALLOWCONN
authorMagnus Hagander
Sun, 22 Apr 2018 12:03:36 +0000 (14:03 +0200)
committerMagnus Hagander
Sun, 22 Apr 2018 12:03:36 +0000 (14:03 +0200)
This was missed in eed1ce72e1593d3e8b7461d7744808d4d6bf402b.

Reported by Michael Paquier

doc/src/sgml/bgworker.sgml

index ac71fb2c41f968d0c7c009ff54af3aac50fe8cdd..bc5a52584b9eeb31cd11012ed137459e51859971 100644 (file)
@@ -189,15 +189,17 @@ typedef struct BackgroundWorker
   
 
   Once running, the process can connect to a database by calling
-   BackgroundWorkerInitializeConnection(char *dbnamechar *username) or
-   BackgroundWorkerInitializeConnectionByOid(Oid dboidOid useroid).
+   BackgroundWorkerInitializeConnection(char *dbnamechar *usernameuint32 flags) or
+   BackgroundWorkerInitializeConnectionByOid(Oid dboidOid useroiduint32 flags).
    This allows the process to run transactions and queries using the
    SPI interface.  If dbname is NULL or
    dboid is InvalidOid, the session is not connected
    to any particular database, but shared catalogs can be accessed.
    If username is NULL or useroid is
    InvalidOid, the process will run as the superuser created
-   during initdb.
+   during initdb. If BGWORKER_BYPASS_ALLOWCONN
+   is specified as flags it is possible to bypass the restriction
+   to connect to databases not allowing user connections.
    A background worker can only call one of these two functions, and only
    once.  It is not possible to switch databases.