# CREATE SYNONYM
#### 功能描述
创建一个同义词对象。同义词是数据库对象的别名，用于记录与其他数据库对象名间的映射关系，用户可以使用同义词访问关联的数据库对象。使用同义词时，用户需要具有关联对象的相应权限，当前支持通过同义词访问的数据库对象包括表、视图、类型、PACKAGE、函数和存储过程、序列和其他同义词对象。
#### 注意事项
- 仅被授予了CREATE ANY SYNONYM权限的用户，可以在用户模式下创建同义词。
- 支持使用同义词的DML语句包括：SELECT、INSERT、UPDATE、DELETE、EXPLAIN以及CALL。
- 不支持通过同义词执行DDL语句（CREATE、DROP、ALTER）进行操作其关联的对象。
- 禁止在存储过程或函数内部进行创建同义词操作。同义词须在外部预先创建，存储过程内通过引用系统表pg_synonym中已存在的同义词对象进行使用。
- 为防止敏感信息泄露，禁止对包含密码等敏感信息的函数（如：加解密类函数gs_encrypt、gs_decrypt、gs_encrypt_bytea、gs_decrypt_bytea等）进行创建同义词操作以及禁止通过同义词调用此类函数。
- 不建议对临时表创建同义词。如需创建，须指定目标临时表的模式名，否则无法正常使用该同义词，并须在当前会话结束前执行DROP SYNONYM。
- 不支持对包含加密列的密态表以及基于密态表的视图、函数或存储过程进行创建同义词操作。
- 不支持通过\\d、\\df、\\sf等元命令方式访问同义词关联对象的信息。
- 同义词支持嵌套：使用同义词时，若遇同义词指向另一同义词，系统将逐层追踪，直至找到最终关联对象。
- 使用同义词时，同义词搜索解析规则说明如下：
  - 设置search_path后，且未指定同义词Schema时，解析顺序如下： 存储过程和函数：优先按照名称检索pg_proc表，若没有同名函数时，检索同义词，最后按照search_path进行检索。
    其他对象（表、视图等）：优先按search_path进行检索；同一Schema下，对象本身优先级高于同义词。
    
  
  - SQL语句给定Schema搜索对象schema1.object1： 首先搜索schema1.object1对象是否存在。当该对象不存在时，搜索同义词schema1.object1是否存在。若schema1.object1同义词存在，搜索同义词关联的对象schema2.object2。只有对象schema2.object2和同义词schema2.object2都不存在且schema2是用户名时，会额外搜索PUBLIC同义词object2。
    
  
  - SQL语句不给定Schema搜索对象object1： 首先遍历search_path，查找指定Schema下的对象schema.object1，当对象schema.object1不存在时，则搜索同义词schema.object1。只有当同义词schema.object1不存在且搜索的Schema为用户名时，会额外搜索PUBLIC同义词object1。
    
   
 
#### 语法格式
```
CREATE [ OR REPLACE ] [PUBLIC] SYNONYM synonym_name 
    FOR object_name;
```
![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/figure/zh-cn_image_0000002793708023.png "点击放大")
#### 参数说明
- **OR REPLACE**
  可选。如果同义词已存在，则重新定义。
  

- **PUBLIC**
  可选参数。创建PUBLIC同义词。
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
  - 同一数据库下，PUBLIC同义词不能重名。
  
  - 当数据库从不支持PUBLIC同义词的版本升级到支持PUBLIC同义词的版本时，升级提交前不支持创建、删除PUBLIC同义词。
  
  - 所有用户都可以访问PUBLIC同义词。除初始用户、系统管理员的用户外，创建和删除PUBLIC同义词需要具有对应CREATE PUBLIC SYNONYM和DROP PUBLIC SYNONYM的权限。
  
  - PUBLIC同义词在系统表pg_synonym中的synnamespace和synowner对应为0，在系统视图ADM_SYNONYMS和DB_SYNONYMS的owner为PUBLIC，schema_name为NULL。
  
  - 未指定同义词Schema情况下，首先检索同名对象，判断同名对象是否存在；然后检索同义词，按照search_path检索；最后检索PUBLIC同义词。指定同义词Schema情况下，不检索PUBLIC同义词。
    
- **synonym_name**
  创建的同义词名称，可以使用模式进行具体指定。
  取值范围：字符串，要符合[标识符命名规范](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/gaussdb-08-0003.html#ZH-CN_TOPIC_0000002793787739__section14873217506)。
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
  若指定模式，则在指定模式中创建同义词，否则在当前模式下创建同义词。当同义词的模式为用户所在模式时，该同义词的所有者为模式的所有者；其他场景下，同义词的所有者默认为同义词的创建者。
  
- **object_name**
  关联的对象名称，可以使用模式进行具体指定。
  取值范围：字符串，要符合[标识符命名规范](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/gaussdb-08-0003.html#ZH-CN_TOPIC_0000002793787739__section14873217506)。
  ![](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/public_sys-resources/note_3.0-zh-cn.png)
  - object_name可以是不存在的对象名称。
  
  - object_name可以是PACKAGE对象，但不可关联PACKAGE内函数。可通过PACKAGE同义词访问PACKAGE内函数和变量。
  
  - object_name可以是使用DATABASE LINK方式访问远程对象。DATABASE LINK的具体使用方式请参见《开发指南》中"特性使用指导 \> DATABASE LINK"章节。
  
  - 删除原对象后，与之关联的同义词不会被级联删除，继续访问该同义词将会报错：若原对象为表，提示已失效；若原对象为函数、存储过程或PACKAGE等，提示对象不存在。
    
 
#### 示例
```
--创建模式ot。
gaussdb=# CREATE SCHEMA ot;
--创建表ot.test_tbl1。
gaussdb=# CREATE TABLE ot.test_tbl1(c1 INT, c2 INT);
gaussdb=# INSERT INTO ot.test_tbl1 values(1,1);
--查看当前search_path。
gaussdb=# SHOW search_path;
  search_path   
----------------
 "$user",public
(1 row)
--因为当前search_path中不包含ot，并且当前用户不是ot，所以直接查看表名会报错。
gaussdb=# SELECT * FROM test_tbl1;
ERROR:  relation "test_tbl1" does not exist
LINE 1: SELECT * FROM test_tbl1;
                      ^
--创建同义词。
gaussdb=# CREATE OR REPLACE SYNONYM test_tbl1 FOR ot.test_tbl1;
--使用同义词。
gaussdb=# SELECT * FROM test_tbl1;
 c1 | c2 
----+----
  1 |  1
(1 row)
gaussdb=# INSERT INTO test_tbl1 VALUES (2,2);
--查询已经创建的同义词。
gaussdb=# SELECT synname,synobjschema,synobjname FROM pg_synonym WHERE synname = 'test_tbl1';
  synname  | synobjschema | synobjname 
-----------+--------------+------------
 test_tbl1 | ot           | test_tbl1
(1 row)
--删除。
gaussdb=# DROP SYNONYM test_tbl1;
gaussdb=# DROP TABLE ot.test_tbl1;
gaussdb=# DROP SCHEMA ot CASCADE;
```
#### 相关链接
[ALTER SYNONYM](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/gaussdb-08-0209.html)，[DROP SYNONYM](https://support.huaweicloud.com/distributed-ref-v10-gaussdb/gaussdb-08-0321.html)