如何在Java中执行包含PostgreSQL特定特性的SQL脚本

核心问题说明 #

PostgreSQL的\i是psql客户端专属元命令，并非PostgreSQL服务器支持的SQL语法，所以JDBC（包括PgConnection扩展）无法直接识别执行，这是你遇到语法错误的根本原因。以下是两种可行的解决思路：

方案一：纯JDBC解析执行脚本（推荐） #

自己实现脚本解析逻辑，识别\i指令并递归加载执行依赖的SQL文件，完全在JDBC连接内完成操作，无需调用外部程序。

基础实现示例 #

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;

public class PostgresScriptRunner {
    private final Connection conn;

    public PostgresScriptRunner(Connection connection) {
        this.conn = connection;
    }

    public void executeScript(String scriptPath) throws Exception {
        String scriptContent = readFile(scriptPath);
        List<String> sqlCommands = parseScript(scriptContent, scriptPath);

        try (Statement stmt = conn.createStatement()) {
            for (String cmd : sqlCommands) {
                String trimmedCmd = cmd.trim();
                if (!trimmedCmd.isEmpty() && !trimmedCmd.startsWith("--")) {
                    stmt.execute(trimmedCmd);
                }
            }
        }
    }

    private String readFile(String filePath) throws Exception {
        StringBuilder content = new StringBuilder();
        try (BufferedReader reader = new BufferedReader(new FileReader(filePath))) {
            String line;
            while ((line = reader.readLine()) != null) {
                content.append(line).append("\n");
            }
        }
        return content.toString();
    }

    private List<String> parseScript(String content, String parentScriptPath) throws Exception {
        List<String> commands = new ArrayList<>();
        StringBuilder currentCmd = new StringBuilder();
        String[] lines = content.split("\n");
        File parentDir = new File(parentScriptPath).getParentFile();

        for (String line : lines) {
            String trimmedLine = line.trim();
            if (trimmedLine.startsWith("\\i")) {
                // 先提交当前未完成的SQL语句
                if (currentCmd.length() > 0) {
                    commands.add(currentCmd.toString());
                    currentCmd.setLength(0);
                }
                // 处理相对路径，加载依赖脚本
                String includedPath = trimmedLine.substring(3).trim();
                File includedFile = new File(includedPath);
                if (!includedFile.isAbsolute()) {
                    includedFile = new File(parentDir, includedPath);
                }
                // 递归解析执行依赖脚本
                commands.addAll(parseScript(readFile(includedFile.getAbsolutePath()), includedFile.getAbsolutePath()));
            } else if (trimmedLine.endsWith(";")) {
                // 处理普通SQL语句
                currentCmd.append(line);
                commands.add(currentCmd.toString());
                currentCmd.setLength(0);
            } else {
                // 拼接多行SQL语句
                currentCmd.append(line).append("\n");
            }
        }
        // 处理最后一条未结束的SQL语句
        if (currentCmd.length() > 0) {
            commands.add(currentCmd.toString());
        }
        return commands;
    }

    public static void main(String[] args) throws Exception {
        String connStr = "jdbc:postgresql://localhost:5432/your_db";
        String user = "your_username";
        String pwd = "your_password";

        try (Connection conn = DriverManager.getConnection(connStr, user, pwd)) {
            PostgresScriptRunner runner = new PostgresScriptRunner(conn);
            runner.executeScript("./db_init/startup.sql");
        }
    }
}

进阶优化 #

如果需要处理更复杂的SQL场景（比如字符串中的分号、多行注释等），可以直接使用成熟的开源工具：

• Spring框架的ScriptUtils类，支持脚本包含和复杂SQL解析
• MyBatis的ScriptRunner工具，专门用于执行SQL脚本

方案二：修复psql命令行调用的挂起问题 #

如果坚持使用psql客户端，只需解决密码输入导致的挂起问题，有两种可靠方式：

方式1：通过环境变量传递密码 #

import java.io.IOException;

public class PsqlClientRunner {
    public static void main(String[] args) throws IOException, InterruptedException {
        String scriptPath = "./db_init/startup.sql";
        String dbHost = "localhost";
        String dbPort = "5432";
        String dbName = "your_db";
        String user = "your_username";
        String pwd = "your_password";

        ProcessBuilder pb = new ProcessBuilder(
                "psql", "-h", dbHost, "-p", dbPort, "-d", dbName,
                "-U", user, "-f", scriptPath, "-w"
        );
        // 设置PGPASSWORD环境变量，避免密码提示
        pb.environment().put("PGPASSWORD", pwd);
        // 重定向输出到当前终端，方便查看执行日志
        pb.inheritIO();

        Process process = pb.start();
        int exitCode = process.waitFor();
        if (exitCode == 0) {
            System.out.println("脚本执行成功");
        } else {
            System.err.println("脚本执行失败，退出码：" + exitCode);
        }
    }
}

参数说明：-w表示禁止psql提示输入密码，直接读取PGPASSWORD环境变量的值。

方式2：使用pgpass文件存储密码 #

在用户主目录下创建.pgpass文件，格式为：hostname:port:database:username:password，并设置文件权限为0600，之后psql会自动读取该文件的密码，无需手动输入。

为什么PgConnection无法解决问题 #

PgConnection是pgJDBC提供的扩展连接类，仅用于访问PostgreSQL的特定特性（比如COPY协议、通知等），但它依然遵循JDBC规范，只能执行服务器端支持的SQL语法，无法处理psql客户端专属的元命令（如\i、\d等）。

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