如何使PostgreSQL脚本具备幂等性？附相关Shell函数代码

核心思路 #

要让PostgreSQL相关操作具备幂等性，关键就是在创建资源（用户、数据库）前，先安全删除已存在的同名资源——借助DROP ... IF EXISTS语法，即使目标资源不存在，命令也不会抛出错误，脚本可以顺畅执行。

完整的Shell函数实现 #

1. 删除已存在的数据库和用户函数 #

你提供的这个删除函数逻辑已经很完善，我给它加上注释说明细节：

drop_linked_resources() {
    # 接收参数：数据库主机地址、超级用户名、超级用户密码、待删除的用户名、待删除的数据库名
    local readonly host="$1"
    local readonly master_username="$2"
    local readonly master_password="$3"
    local readonly username="$4"
    local readonly db="$5"

    # 使用轻量的PostgreSQL Alpine镜像执行删除命令，--rm确保容器执行完毕自动销毁
    docker run --rm \
        -e PGPASSWORD="$master_password" \  # 用环境变量传递密码，避免明文出现在命令行历史/进程列表
        postgres:9.6.3-alpine psql -h "$host" -d postgres -U "$master_username" <<-EOSQL
            # 安全删除数据库：仅当存在时执行删除
            DROP DATABASE IF EXISTS $db;
            # 安全删除用户：仅当存在时执行删除
            DROP USER IF EXISTS $username;
EOSQL
}

2. 补全创建用户和数据库的函数 #

你提供的create_user函数不完整，我帮你补全为具备幂等性的完整创建逻辑（创建时也加入IF NOT EXISTS进一步强化幂等性）：

create_user() {
    # 接收参数：数据库主机地址、超级用户名、超级用户密码、待创建的用户名、用户密码、待创建的数据库名
    local readonly host="$1"
    local readonly master_username="$2"
    local readonly master_password="$3"
    local readonly username="$4"
    local readonly password="$5"
    local readonly db="$6"

    docker run --rm \
        -e PGPASSWORD="$master_password" \
        postgres:9.6.3-alpine psql -h "$host" -d postgres -U "$master_username" <<-EOSQL
            # 幂等创建用户：仅当不存在时创建
            CREATE USER IF NOT EXISTS $username WITH PASSWORD '$password';
            # 幂等创建数据库：仅当不存在时创建，并指定所有者为新用户
            CREATE DATABASE IF NOT EXISTS $db OWNER $username;
            # 给新用户授予目标数据库的全部权限（可根据实际需求调整为更精细的权限）
            GRANT ALL PRIVILEGES ON DATABASE $db TO $username;
EOSQL
}

使用示例 #

按顺序调用两个函数，就能实现重复执行也不会报错的幂等资源创建：

# 配置你的PostgreSQL参数
DB_HOST="your-postgres-host"
MASTER_USER="postgres"
MASTER_PASS="your-master-password"
APP_USER="my_app_user"
APP_PASS="app-user-secure-password"
APP_DB="my_app_db"

# 第一步：清理已存在的同名资源
drop_linked_resources "$DB_HOST" "$MASTER_USER" "$MASTER_PASS" "$APP_USER" "$APP_DB"
# 第二步：创建新的用户和数据库
create_user "$DB_HOST" "$MASTER_USER" "$MASTER_PASS" "$APP_USER" "$APP_PASS" "$APP_DB"

关键注意事项 #

• 密码安全：通过PGPASSWORD环境变量传递密码，比直接在命令行使用-p参数更安全，避免密码泄露到进程列表或命令历史中。
• 镜像版本匹配：示例中使用postgres:9.6.3-alpine，如果你的PostgreSQL服务器版本不同，建议选用匹配的镜像版本，避免语法兼容性问题。
• 权限精细化：示例中使用GRANT ALL PRIVILEGES是最宽松的权限设置，生产环境可以根据实际需求调整为更精细的权限（比如仅授予SELECT、INSERT等必要权限）。
• 幂等语法依赖：IF EXISTS和IF NOT EXISTS是实现幂等性的核心，PostgreSQL 9.1及以上版本支持这些语法，确保你的服务器版本符合要求。

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