manpagez: man pages & more
man CREATE_USER_MAPPING(7)
Home | html | info | man
CREATE USER MAPPING(7)   PostgreSQL 18.6 Documentation  CREATE USER MAPPING(7)


NAME

       CREATE_USER_MAPPING - define a new mapping of a user to a foreign
       server


SYNOPSIS

       CREATE USER MAPPING [ IF NOT EXISTS ] FOR { user_name | USER | CURRENT_ROLE | CURRENT_USER | PUBLIC }
           SERVER server_name
           [ OPTIONS ( option 'value' [ , ... ] ) ]


DESCRIPTION

       CREATE USER MAPPING defines a mapping of a user to a foreign server. A
       user mapping typically encapsulates connection information that a
       foreign-data wrapper uses together with the information encapsulated by
       a foreign server to access an external data resource.

       The owner of a foreign server can create user mappings for that server
       for any user. Also, a user can create a user mapping for their own user
       name if USAGE privilege on the server has been granted to the user.


PARAMETERS

       IF NOT EXISTS
           Do not throw an error if a mapping of the given user to the given
           foreign server already exists. A notice is issued in this case.
           Note that there is no guarantee that the existing user mapping is
           anything like the one that would have been created.

       user_name
           The name of an existing user that is mapped to foreign server.
           CURRENT_ROLE, CURRENT_USER, and USER match the name of the current
           user. When PUBLIC is specified, a so-called public mapping is
           created that is used when no user-specific mapping is applicable.

       server_name
           The name of an existing server for which the user mapping is to be
           created.

       OPTIONS ( option 'value' [, ... ] )
           This clause specifies the options of the user mapping. The options
           typically define the actual user name and password of the mapping.
           Option names must be unique. The allowed option names and values
           are specific to the server's foreign-data wrapper.


EXAMPLES

       Create a user mapping for user bob, server foo:

           CREATE USER MAPPING FOR bob SERVER foo OPTIONS (user 'bob', password 'secret');


COMPATIBILITY

       CREATE USER MAPPING conforms to ISO/IEC 9075-9 (SQL/MED).


SEE ALSO

       ALTER USER MAPPING (ALTER_USER_MAPPING(7)), DROP USER MAPPING
       (DROP_USER_MAPPING(7)), CREATE FOREIGN DATA WRAPPER
       (CREATE_FOREIGN_DATA_WRAPPER(7)), CREATE SERVER (CREATE_SERVER(7))

PostgreSQL 18.6                      2026               CREATE USER MAPPING(7)

postgresql 18.6_0 - Generated Thu Aug 27 10:44:51 CDT 2026
© manpagez.com 2000-2026
Individual documents may contain additional copyright information.