CREATE SYNONYM v17
Name
CREATE SYNONYM — Define a new synonym.
Synopsis
CREATE [OR REPLACE] [PUBLIC] SYNONYM [<schema>.]<syn_name> FOR <object_schema>.<object_name>[@<dblink_name>];
Description
CREATE SYNONYM defines a synonym for certain types of database objects. EDB Postgres Advanced Server supports synonyms for:
- Tables
- Views
- Materialized views
- Sequences
- Packages
- Procedures
- Functions
- Types
- Objects that are accessible through a database link
- Other synonyms
Parameters
syn_name
The name of the synonym. A synonym name must be unique in a schema.
schema
The name of the schema where the synonym resides. If you don't specify a schema name, the synonym is created in the first existing schema in your search path.
object_name
The name of the object.
object_schema
The name of the schema where the referenced object resides.
dblink_name
The name of the database link through which you access an object.
Include the REPLACE clause to replace an existing synonym definition with a new synonym definition.
Include the PUBLIC clause to create the synonym in the public schema. The CREATE PUBLIC SYNONYM command, compatible with Oracle databases, creates a synonym that resides in the public schema:
CREATE [OR REPLACE] PUBLIC SYNONYM <syn_name> FOR <object_schema>.<object_name>;
This is a shorthand way to write:
CREATE [OR REPLACE] SYNONYM public.<syn_name> FOR <object_schema>.<object_name>;
Notes
Access to the object referenced by the synonym is determined by the permissions of the current user of the synonym. The synonym user must have the appropriate permissions on the underlying database object.
Examples
Create a synonym for the emp table in a schema named enterprisedb:
CREATE SYNONYM personnel FOR enterprisedb.emp;