PostgreSQLSchema.java
/*-
* ========================LICENSE_START=================================
* flyway-database-postgresql
* ========================================================================
* Copyright (C) 2010 - 2026 Red Gate Software Ltd
* ========================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* =========================LICENSE_END==================================
*/
package org.flywaydb.database.postgresql;
import java.util.Objects;
import org.flywaydb.core.extensibility.LicenseGuard;
import org.flywaydb.core.internal.database.base.Schema;
import org.flywaydb.core.internal.database.base.Table;
import org.flywaydb.core.internal.database.base.Type;
import org.flywaydb.core.internal.jdbc.JdbcTemplate;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import java.util.Map;
/**
* PostgreSQL implementation of Schema.
*/
public class PostgreSQLSchema extends Schema<PostgreSQLDatabase, PostgreSQLTable> {
/**
* Creates a new PostgreSQL schema.
*
* @param jdbcTemplate The Jdbc Template for communicating with the DB.
* @param database The database-specific support.
* @param name The name of the schema.
*/
protected PostgreSQLSchema(final JdbcTemplate jdbcTemplate, final PostgreSQLDatabase database, final String name) {
super(jdbcTemplate, database, name);
}
@Override
protected boolean doExists() throws SQLException {
return jdbcTemplate.queryForInt("SELECT COUNT(*) FROM pg_namespace WHERE nspname=?", name) > 0;
}
@Override
protected boolean doEmpty() throws SQLException {
return !jdbcTemplate.queryForBoolean("SELECT EXISTS (\n"
+ " SELECT c.oid FROM pg_catalog.pg_class c\n"
+ " JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n"
+ " LEFT JOIN pg_catalog.pg_depend d ON d.objid = c.oid AND d.deptype = 'e'\n"
+ " WHERE n.nspname = ? AND d.objid IS NULL AND c.relkind IN ('r', 'v', 'S', 't')\n"
+ " UNION ALL\n"
+ " SELECT t.oid FROM pg_catalog.pg_type t\n"
+ " JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n"
+ " LEFT JOIN pg_catalog.pg_depend d ON d.objid = t.oid AND d.deptype = 'e'\n"
+ " WHERE n.nspname = ? AND d.objid IS NULL AND t.typcategory NOT IN ('A', 'C')\n"
+ " UNION ALL\n"
+ " SELECT p.oid FROM pg_catalog.pg_proc p\n"
+ " JOIN pg_catalog.pg_namespace n ON n.oid = p.pronamespace\n"
+ " LEFT JOIN pg_catalog.pg_depend d ON d.objid = p.oid AND d.deptype = 'e'\n"
+ " WHERE n.nspname = ? AND d.objid IS NULL\n"
+ ")", name, name, name);
}
@Override
protected void doCreate() throws SQLException {
jdbcTemplate.execute("CREATE SCHEMA " + database.quote(name));
}
@Override
protected void doDrop() throws SQLException {
jdbcTemplate.execute("DROP SCHEMA " + database.quote(name) + " CASCADE");
}
@Override
protected void doClean() throws SQLException {
if (database.getVersion().isAtLeast("9.3")) {
for (final String statement : generateDropStatementsForMaterializedViews()) {
jdbcTemplate.execute(statement);
}
}
for (final String statement : generateDropStatementsForViews()) {
jdbcTemplate.execute(statement);
}
for (final Table table : allTables()) {
table.drop();
}
for (final String statement : generateDropStatementsForBaseTypes(true)) {
jdbcTemplate.execute(statement);
}
for (final String statement : generateDropStatementsForRoutines()) {
jdbcTemplate.execute(statement);
}
for (final String statement : generateDropStatementsForEnums()) {
jdbcTemplate.execute(statement);
}
for (final String statement : generateDropStatementsForDomains()) {
jdbcTemplate.execute(statement);
}
for (final String statement : generateDropStatementsForSequences()) {
jdbcTemplate.execute(statement);
}
for (final String statement : generateDropStatementsForBaseTypes(false)) {
jdbcTemplate.execute(statement);
}
if (Objects.equals(LicenseGuard.getTierAsString(database.getConfiguration()), "OSS")) {
for (final String statement : generateDropStatementsForCollations()) {
jdbcTemplate.execute(statement);
}
}
for (final String statement : generateDropStatementsForExtensions()) {
jdbcTemplate.execute(statement);
}
}
/**
* Generates the statements for dropping the extensions in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForExtensions() throws SQLException {
final List<String> statements = new ArrayList<>();
if (extensionsTableExists()) {
final List<String> extensionNames = jdbcTemplate.queryForStringList("SELECT e.extname "
+ "FROM pg_extension e "
+ "LEFT JOIN pg_namespace n ON n.oid = e.extnamespace "
+ "LEFT JOIN pg_roles r ON r.oid = e.extowner "
+ "WHERE n.nspname=? AND r.rolname=?", name, database.doGetCurrentUser());
for (final String extensionName : extensionNames) {
statements.add("DROP EXTENSION IF EXISTS " + database.quote(extensionName) + " CASCADE");
}
}
return statements;
}
private boolean extensionsTableExists() throws SQLException {
return jdbcTemplate.queryForBoolean("SELECT EXISTS ( \n"
+ "SELECT 1 \n"
+ "FROM pg_tables \n"
+ "WHERE tablename = 'pg_extension');");
}
/**
* Generates the statements for dropping the sequences in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForSequences() throws SQLException {
final List<String> sequenceNames = jdbcTemplate.queryForStringList(
"SELECT sequence_name FROM information_schema.sequences WHERE sequence_schema=?",
name);
final List<String> statements = new ArrayList<>();
for (final String sequenceName : sequenceNames) {
statements.add("DROP SEQUENCE IF EXISTS " + database.quote(name, sequenceName));
}
return statements;
}
/**
* Generates the statements for dropping the types in this schema.
*
* @param recreate Flag indicating whether the types should be recreated. Necessary for type-function chicken and
* egg problem.
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForBaseTypes(final boolean recreate) throws SQLException {
final List<Map<String, String>> rows = jdbcTemplate.queryForList(
"select typname, typcategory from pg_catalog.pg_type t "
+ "left join pg_depend dep on dep.objid = t.oid and dep.deptype = 'e' "
+ "where (t.typrelid = 0 OR (SELECT c.relkind = 'c' FROM pg_catalog.pg_class c WHERE c.oid = t.typrelid)) "
+ "and NOT EXISTS(SELECT 1 FROM pg_catalog.pg_type el WHERE el.oid = t.typelem AND el.typarray = t.oid) "
+ "and t.typnamespace in (select oid from pg_catalog.pg_namespace where nspname = ?) "
+ "and dep.objid is null "
+ "and t.typtype != 'd'",
name);
final List<String> statements = new ArrayList<>();
for (final Map<String, String> row : rows) {
statements.add("DROP TYPE IF EXISTS " + database.quote(name, row.get("typname")) + " CASCADE");
}
if (recreate) {
for (final Map<String, String> row : rows) {
// Only recreate Pseudo-types (P) and User-defined types (U)
if (Arrays.asList("P", "U").contains(row.get("typcategory"))) {
statements.add("CREATE TYPE " + database.quote(name, row.get("typname")));
}
}
}
return statements;
}
/**
* Generates the statements for dropping the routines in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForRoutines() throws SQLException {
// #2193: PostgreSQL 11 removed the 'proisagg' column and replaced it with 'prokind'.
final String isAggregate = database.getVersion().isAtLeast("11") ? "pg_proc.prokind = 'a'" : "pg_proc.proisagg";
// PROCEDURE is only available from PostgreSQL 11
final String isProcedure = database.getVersion().isAtLeast("11") ? "pg_proc.prokind = 'p'" : "FALSE";
final List<Map<String, String>> rows = jdbcTemplate.queryForList(
// Search for all functions
"SELECT proname, oidvectortypes(proargtypes) AS args, "
+ isAggregate
+ " as agg, "
+ isProcedure
+ " as proc "
+ "FROM pg_proc INNER JOIN pg_namespace ns ON (pg_proc.pronamespace = ns.oid) "
// that don't depend on an extension
+ "LEFT JOIN pg_depend dep ON dep.objid = pg_proc.oid AND dep.deptype = 'e' "
+ "WHERE ns.nspname = ? AND dep.objid IS NULL", name);
final List<String> statements = new ArrayList<>();
for (final Map<String, String> row : rows) {
String type = "FUNCTION";
if (isTrue(row.get("agg"))) {
type = "AGGREGATE";
} else if (isTrue(row.get("proc"))) {
type = "PROCEDURE";
}
statements.add("DROP " + type + " IF EXISTS " + database.quote(name, row.get("proname")) + "(" + row.get(
"args") + ") CASCADE");
}
return statements;
}
private boolean isTrue(final String agg) {
return agg != null && agg.toLowerCase(Locale.ENGLISH).startsWith("t");
}
/**
* Generates the statements for dropping the enums in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForEnums() throws SQLException {
final List<String> enumNames = jdbcTemplate.queryForStringList(
"SELECT t.typname FROM pg_catalog.pg_type t INNER JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace WHERE n.nspname = ? and t.typtype = 'e'",
name);
final List<String> statements = new ArrayList<>();
for (final String enumName : enumNames) {
statements.add("DROP TYPE " + database.quote(name, enumName));
}
return statements;
}
/**
* Generates the statements for dropping the domains in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForDomains() throws SQLException {
final List<String> domainNames = jdbcTemplate.queryForStringList("SELECT t.typname as domain_name\n"
+ "FROM pg_catalog.pg_type t\n"
+ " LEFT JOIN pg_catalog.pg_namespace n ON n.oid = t.typnamespace\n"
+ " LEFT JOIN pg_depend dep ON dep.objid = t.oid AND dep.deptype = 'e'\n"
+ "WHERE t.typtype = 'd'\n"
+ " AND n.nspname = ?\n"
+ " AND dep.objid IS NULL", name);
final List<String> statements = new ArrayList<>();
for (final String domainName : domainNames) {
statements.add("DROP DOMAIN IF EXISTS " + database.quote(name, domainName) + " CASCADE");
}
return statements;
}
/**
* Generates the statements for dropping the materialized views in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForMaterializedViews() throws SQLException {
final List<String> viewNames = jdbcTemplate.queryForStringList(
"SELECT relname FROM pg_catalog.pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace"
+ " WHERE c.relkind = 'm' AND n.nspname = ?",
name);
final List<String> statements = new ArrayList<>();
for (final String domainName : viewNames) {
statements.add("DROP MATERIALIZED VIEW IF EXISTS " + database.quote(name, domainName) + " CASCADE");
}
return statements;
}
/**
* Generates the statements for dropping the views in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForViews() throws SQLException {
final List<String> viewNames = jdbcTemplate.queryForStringList(
// Search for all views
"SELECT relname FROM pg_catalog.pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace"
+
// that don't depend on an extension
" LEFT JOIN pg_depend dep ON dep.objid = c.oid AND dep.deptype = 'e'"
+ " WHERE c.relkind = 'v' AND n.nspname = ? AND dep.objid IS NULL", name);
final List<String> statements = new ArrayList<>();
for (final String domainName : viewNames) {
statements.add("DROP VIEW IF EXISTS " + database.quote(name, domainName) + " CASCADE");
}
return statements;
}
/**
* Generates the statements for dropping the collations in this schema.
*
* @return The drop statements.
* @throws SQLException when the clean statements could not be generated.
*/
private List<String> generateDropStatementsForCollations() throws SQLException {
final List<String> collationNames = jdbcTemplate.queryForStringList(
// Search for all collations in current schema
"SELECT c.collname FROM pg_catalog.pg_collation c "
+
// that don't depend on an extension
"JOIN pg_namespace n ON c.collnamespace = n.oid "
+ "LEFT JOIN pg_depend dep ON dep.objid = c.oid AND dep.deptype = 'e' "
+ "WHERE n.nspname = ? AND dep.objid IS NULL", name);
final List<String> statements = new ArrayList<>();
for (final String collationName : collationNames) {
statements.add("DROP COLLATION IF EXISTS " + database.quote(name, collationName) + " CASCADE");
}
return statements;
}
@Override
protected PostgreSQLTable[] doAllTables() throws SQLException {
final List<String> tableNames = jdbcTemplate.queryForStringList(
//Search for all the table names
"SELECT t.table_name FROM information_schema.tables t"
+
// that don't depend on an extension
" LEFT JOIN pg_depend dep ON dep.objid = (quote_ident(t.table_schema)||'.'||quote_ident(t.table_name))::regclass::oid AND dep.deptype = 'e'"
+
// in this schema
" WHERE table_schema=?"
+
//that are real tables (as opposed to views)
" AND table_type='BASE TABLE'"
+
// with no extension depending on them
" AND dep.objid IS NULL"
+
// and are not child tables (= do not inherit from another table).
" AND NOT (SELECT EXISTS (SELECT inhrelid FROM pg_catalog.pg_inherits"
+ " WHERE inhrelid = (quote_ident(t.table_schema)||'.'||quote_ident(t.table_name))::regclass::oid))",
name);
//Views and child tables are excluded as they are dropped with the parent table when using cascade.
final PostgreSQLTable[] tables = new PostgreSQLTable[tableNames.size()];
for (int i = 0; i < tableNames.size(); i++) {
tables[i] = new PostgreSQLTable(jdbcTemplate, database, this, tableNames.get(i));
}
return tables;
}
@Override
public Table getTable(final String tableName) {
return new PostgreSQLTable(jdbcTemplate, database, this, tableName);
}
@Override
protected Type getType(final String typeName) {
return new PostgreSQLType(jdbcTemplate, database, this, typeName);
}
}