如何通过Java从PostgreSQL现有数据库表生成DDL语句？

核心思路 #

利用JDBC的DatabaseMetaData接口获取目标表的元数据（列名、数据类型、约束等），再拼接成标准的CREATE TABLE语句，这是实现类似IDE生成DDL功能的通用方案，适配PostgreSQL。

步骤1：引入PostgreSQL JDBC驱动 #

如果用Maven管理依赖，在pom.xml中添加：

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.7.3</version> <!-- 使用最新稳定版 -->
</dependency>

步骤2：核心实现代码 #

以下代码针对mySchema.myTable生成符合要求的DDL：

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

public class PostgresDdlGenerator {

    public static String generateCreateTableDdl(String schemaName, String tableName, String dbUrl, String username, String password) throws SQLException {
        // 建立数据库连接
        try (Connection conn = DriverManager.getConnection(dbUrl, username, password)) {
            DatabaseMetaData metaData = conn.getMetaData();
            StringBuilder ddlBuilder = new StringBuilder();

            // 拼接CREATE TABLE开头
            ddlBuilder.append("create table ").append(tableName).append(" (\n");

            // 获取表的列信息
            List<String> columnDefinitions = new ArrayList<>();
            try (ResultSet columns = metaData.getColumns(null, schemaName, tableName, null)) {
                while (columns.next()) {
                    String columnName = columns.getString("COLUMN_NAME");
                    String typeName = columns.getString("TYPE_NAME");
                    int columnSize = columns.getInt("COLUMN_SIZE");
                    boolean isNullable = columns.getInt("NULLABLE") == DatabaseMetaData.columnNullable;
                    String defaultValue = columns.getString("COLUMN_DEF");

                    // 拼接列定义：列名 数据类型(长度) [NOT NULL] [DEFAULT 值]
                    StringBuilder colDef = new StringBuilder();
                    colDef.append("   ").append(columnName).append(" ").append(typeName);
                    // 对需要指定长度的类型添加长度（比如varchar）
                    if (typeName.equalsIgnoreCase("varchar") || typeName.equalsIgnoreCase("char")) {
                        colDef.append("(").append(columnSize).append(")");
                    }
                    if (!isNullable) {
                        colDef.append(" NOT NULL");
                    }
                    if (defaultValue != null && !defaultValue.isEmpty()) {
                        colDef.append(" DEFAULT ").append(defaultValue);
                    }
                    columnDefinitions.add(colDef.toString());
                }
            }

            // 获取主键信息（添加主键约束）
            try (ResultSet primaryKeys = metaData.getPrimaryKeys(null, schemaName, tableName)) {
                List<String> pkColumns = new ArrayList<>();
                while (primaryKeys.next()) {
                    pkColumns.add(primaryKeys.getString("COLUMN_NAME"));
                }
                if (!pkColumns.isEmpty()) {
                    columnDefinitions.add("   PRIMARY KEY (" + String.join(", ", pkColumns) + ")");
                }
            }

            // 拼接所有列定义和结尾
            ddlBuilder.append(String.join(",\n", columnDefinitions));
            ddlBuilder.append("\n)");

            return ddlBuilder.toString();
        }
    }

    // 测试示例
    public static void main(String[] args) {
        try {
            String dbUrl = "jdbc:postgresql://localhost:5432/your_db_name";
            String username = "your_username";
            String password = "your_password";
            String ddl = generateCreateTableDdl("mySchema", "myTable", dbUrl, username, password);
            System.out.println(ddl);
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

关键说明 #

• DatabaseMetaData.getColumns()：通过指定schema、表名获取列的详细信息，包括名称、数据类型、是否可为空、默认值等。
• 数据类型适配：PostgreSQL的部分类型（如varchar）需要指定长度，代码中做了针对性处理；对于不需要长度的类型（如int、timestamp）直接使用类型名即可。
• 主键约束：额外获取主键信息并添加到DDL中，还原表的完整约束。
• 资源管理：使用try-with-resources自动关闭JDBC资源，避免内存泄漏。

输出示例 #

运行代码后会生成类似以下的DDL：

create table myTable (
   columnA varchar(255) NOT NULL,
   columnB int DEFAULT 0,
   PRIMARY KEY (columnA)
)

内容的提问来源于stack exchange，提问作者Kerem Yücel