PostgreSQL枚举创建语句在psycopg2执行失败，求兼容实现方案

问题背景 #

我需要实现PostgreSQL枚举类型的创建逻辑：存在则跳过，不存在则创建。原本使用以下DO块SQL在DBeaver（连接最新版PostgreSQL）中可正常执行：

DO $$ BEGIN
    CREATE TYPE operated_by_enum AS ENUM ('opA', 'opB');
EXCEPTION
    WHEN duplicate_object THEN null;
END $$;

错误现象 #

但通过Python的psycopg2库执行这段SQL时，抛出语法错误：

SyntaxError: syntax error at or near "IF"
LINE 11: IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'operat...

执行的Python代码如下：

connection = psycopg2.connect(**DB_PARAMETERS)
cursor = connection.cursor()
cursor.execute(s1)
cursor.commit()
cursor.close()

（注：s1为存储上述DO块SQL的字符串变量）

我也曾尝试通过查询pg_type表判断枚举是否存在的方式实现逻辑，同样执行失败，怀疑psycopg2对DO块语句的处理存在特殊限制，但未在官方文档中找到相关说明。

现有替代方案的局限 #

目前找到一个先删后建的替代方案：

DROP TYPE IF EXISTS operated_by_enum;
CREATE TYPE operated_by_enum AS ENUM ('opA', 'opB');

但该方案要求无关联此枚举的表列，仅适用于可删重建表的场景，无法满足批量数据库schema初始化的需求——我需要无需删除枚举即可实现“存在则跳过”的方案。

可行解决方案 #

方案1：修正SQL字符串的定义与转义 #

psycopg2处理包含$$的字符串时，可能因转义或字符串定义方式导致解析错误。可以通过以下两种方式规避：

• 使用Python三引号定义SQL字符串，避免转义问题：

  s1 = '''DO $$ BEGIN
      CREATE TYPE operated_by_enum AS ENUM ('opA', 'opB');
  EXCEPTION
      WHEN duplicate_object THEN null;
  END $$;'''
  

• 替换DO块的分隔符（比如用$enum$替代$$）：

  DO $enum$ BEGIN
      CREATE TYPE operated_by_enum AS ENUM ('opA', 'opB');
  EXCEPTION
      WHEN duplicate_object THEN null;
  END $enum$;
  

方案2：将判断逻辑移至Python层 #

直接通过查询pg_type表判断枚举是否存在，再决定是否执行创建语句，完全避免使用DO块：

connection = psycopg2.connect(**DB_PARAMETERS)
cursor = connection.cursor()

# 检查当前 schema 下的枚举是否存在
cursor.execute("""
    SELECT 1 FROM pg_type 
    WHERE typname = 'operated_by_enum' 
    AND typnamespace = (SELECT oid FROM pg_namespace WHERE nspname = current_schema());
""")
exists = cursor.fetchone()

if not exists:
    cursor.execute("CREATE TYPE operated_by_enum AS ENUM ('opA', 'opB');")

connection.commit()
cursor.close()
connection.close()

该方案将逻辑拆分到Python层面执行，既绕开了psycopg2对DO块的解析问题，也完美实现了“存在则跳过创建”的需求。

内容的提问来源于stack exchange，提问作者Nikhil VJ