docs/sql-stmts/create-user-mapping.md

---
title: CREATE USER MAPPING
---

# CREATE USER MAPPING

Defines a new mapping of a user to a foreign server.

## Synopsis

```sql
CREATE USER MAPPING [ IF NOT EXISTS ] FOR { <user_name> | USER | 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 they have been granted `USAGE` privilege on the server.

## Parameters

**`IF NOT EXISTS`**

Do not throw an error if a mapping of the given user to the given foreign server already exists. Apache Cloudberry issues a notice 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 the foreign server. `CURRENT_USER` and `USER` match the name of the current user. When `PUBLIC` is specified, Apache Cloudberry creates a so-called public mapping that is used when no user-specific mapping is applicable.

**`server_name`**

The name of an existing server for which Apache Cloudberry is to create the user mapping.

**`OPTIONS ( option 'value' [, ... ] )`**

The options for the new user mapping. The options typically define the actual user name and password of the mapping. Option names must be unique. The option names and values are specific to the server's foreign-data wrapper.

## Examples

Create a user mapping for user `bob`, server `foo`:

```sql
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](/docs/sql-stmts/alter-user-mapping.md), [DROP USER MAPPING](/docs/sql-stmts/drop-user-mapping.md), [CREATE FOREIGN DATA WRAPPER](/docs/sql-stmts/create-foreign-data-wrapper.md), [CREATE SERVER](/docs/sql-stmts/create-server.md)