更新时间:2026-10-21 GMT+08:00
分享

CREATE FOREIGN TABLE

功能描述

创建外表。

注意事项

  • 外表中暂不支持使用系统列(如:tableoid、ctid等),其中Private和Shared模式的外表,需要初始用户或者运维模式下(operation_mode)的运维管理员权限。
  • OPTIONS中的敏感字段(如:password、secret_access_key等)在使用多层引号时,语义和不带引号的场景是不同的,因此不会被识别为敏感字段进行脱敏。
  • 多租场景下,只有初始用户可在PDB内部执行CREATE FOREIGN TABLE命令。

语法格式

CREATE FOREIGN TABLE [ IF NOT EXISTS ] table_name ( [
    column_name type_name [ OPTIONS ( { option 'value' } [, ... ] ) ] [ COLLATE collation ] [ column_constraint [ ... ] ]
    [, ... ]
] )
  SERVER server_name
[ OPTIONS ( { option 'value' } [, ... ] ) ];

其中列约束column_constraint为:
[ CONSTRAINT constraint_name ]
{ NOT NULL |
  NULL |
  DEFAULT default_expr }

参数说明

  • IF NOT EXISTS

    用于判断是否存在同名的表。如果数据库中已经存在一个同名的表,不会直接报错,而是会产生一条提示,用于告知表关系已存在。

  • table_name

    外表的表名。

    取值范围:字符串,要符合标识符命名规范。

  • column_name

    外表中的字段名。

    取值范围:字符串,要符合标识符命名规范。

  • type_name

    字段的数据类型。

  • COLLATE collation

    指定列的排序规则(该列的数据类型必须为可排列的数据类型)。如果没有指定,则使用默认的排序规则。

    排序规则可以使用“SELECT * FROM pg_collation;”命令从系统表中查询。

  • SERVER server_name

    外表的server名称。

  • OPTIONS ( option 'value' [, ... ] )

    用于指定外表数据的各类参数。外部数据封装器file_fdw支持的options包括:

    • 指定OPTIONS时,允许指定的选项名和值是由每一个外部数据封装器file_fdw进行指定,并且通过外部数据封装器file_fdw的验证函数进行验证。file_fdw更多使用内容请参见《开发指南》中“特性使用指导 > Foreign Data Wrapper > file_fdw”章节。
    • 不允许重复指定相同的选项名(尽管表选项和表字段选项可以存在相同的名字)。
  • NOT NULL

    字段值不允许为NULL。

  • NULL

    字段值允许为NULL。

  • DEFAULT default_expr

    默认表达式,为字段指定默认值。default_expr可以是任何不含变量的表达式(不允许使用子查询和对本表中的其他字段的交叉引用),默认表达式的数据类型必须和字段类型匹配。

    默认表达式可用于未声明字段数值的插入操作,如果没有指定默认值,则默认为NULL。

示例

--创建server。
gaussdb=# CREATE SERVER my_server FOREIGN DATA WRAPPER log_fdw;

--创建外表。
gaussdb=# CREATE FOREIGN TABLE foreign_tbl (col1 text) SERVER my_server OPTIONS (logtype 'gs_log');

--删除外表。
gaussdb=# DROP FOREIGN TABLE foreign_tbl;

--删除server。
gaussdb=# DROP SERVER my_server;

相关文档