Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add support for 'CASCADE' in PostgreSQL 'DROP SCHEMA' queries #4713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2021
Merged

Add support for 'CASCADE' in PostgreSQL 'DROP SCHEMA' queries #4713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1bf885
Add support for 'CASCADE' in PostgreSQL 'DROP SCHEMA' queries
OlivierCavadenti Jan 16, 2020
ff45f69
rework tests
OlivierCavadenti Oct 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions lib/dialects/postgres/schema/pg-compiler.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,20 @@ class SchemaCompiler_PG extends SchemaCompiler {
);
}

dropSchema(schemaName) {
this.pushQuery(`drop schema ${this.formatter.wrap(schemaName)}`);
dropSchema(schemaName, cascade = false) {
this.pushQuery(
`drop schema ${this.formatter.wrap(schemaName)}${
cascade ? ' cascade' : ''
}`
);
}

dropSchemaIfExists(schemaName) {
this.pushQuery(`drop schema if exists ${this.formatter.wrap(schemaName)}`);
dropSchemaIfExists(schemaName, cascade = false) {
this.pushQuery(
`drop schema if exists ${this.formatter.wrap(schemaName)}${
cascade ? ' cascade' : ''
}`
);
}

dropExtension(extensionName) {
Expand Down
90 changes: 90 additions & 0 deletions test/integration2/schema/misc.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,96 @@ describe('Schema (misc)', () => {
});
});

describe('dropSchema', () => {
it('has a dropSchema/dropSchemaIfExists method', async function () {
if (!isPgBased(knex)) {
return this.skip();
}

this.timeout(process.env.KNEX_TEST_TIMEOUT || 30000);
const dbDropSchema = ['pg', 'cockroachdb'];

function checkSchemaNotExists(schemaName) {
knex
.raw(
'SELECT schema_name FROM information_schema.schemata WHERE schema_name = ?',
[schemaName]
)
.then((res) => {
expect(res[0]).to.not.equal(schemaName);
});
}

// Drop schema cascade = false tests.
await knex.schema.createSchema('schema').then(() => {
knex.schema
.dropSchema('schema')
.testSql((tester) => {
tester(dbDropSchema, ['drop schema "schema"']);
})
.then(() => {
checkSchemaNotExists('schema');
});
});

await knex.schema.createSchema('schema_2').then(() => {
knex.schema
.dropSchemaIfExists('schema_2')
.testSql((tester) => {
tester(dbDropSchema, ['drop schema if exists "schema_2"']);
})
.then(() => {
checkSchemaNotExists('schema_2');
});
});

// Drop schema cascade = true tests
await knex.schema.createSchema('schema_cascade_1').then(() => {
knex.schema
.withSchema('schema_cascade_1')
.createTable('table_cascade_1', () => {}) // created to check if cascade works.
.then(() => {
knex.schema
.dropSchema('schema_cascade_1', true)
.testSql((tester) => {
tester(dbDropSchema, [
'drop schema "schema_cascade_1" cascade',
]);
})
.then(() => {
checkSchemaNotExists('schema_cascade_1');
knex.schema
.withSchema('schema_cascade_1')
.hasTable('table_cascade_1')
.then((exists) => expect(exists).to.equal(false));
});
});
});

await knex.schema.createSchema('schema_cascade_2').then(() => {
knex.schema
.withSchema('schema_cascade_2')
.createTable('table_cascade_2', () => {}) // created to check if cascade works.
.then(() => {
knex.schema
.dropSchemaIfExists('schema_cascade_2', true)
.testSql((tester) => {
tester(dbDropSchema, [
'drop schema if exists "schema_cascade_2" cascade',
]);
})
.then(() => {
checkSchemaNotExists('schema_cascade_2');
knex.schema
.withSchema('schema_cascade_2')
.hasTable('table_cascade_2')
.then((exists) => expect(exists).to.equal(false));
});
});
});
});
});

describe('dropTable', () => {
it('has a dropTableIfExists method', function () {
this.timeout(process.env.KNEX_TEST_TIMEOUT || 30000);
Expand Down
4 changes: 2 additions & 2 deletions types/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1851,8 +1851,8 @@ export declare namespace Knex {
callback: (tableBuilder: AlterTableBuilder) => any
): Promise<void>;
dropTableIfExists(tableName: string): SchemaBuilder;
dropSchema(schemaName: string): SchemaBuilder;
dropSchemaIfExists(schemaName: string): SchemaBuilder;
dropSchema(schemaName: string, cascade?: boolean): SchemaBuilder;
dropSchemaIfExists(schemaName: string, cascade?: boolean): SchemaBuilder;
raw(statement: string): SchemaBuilder;
withSchema(schemaName: string): SchemaBuilder;
queryContext(context: any): SchemaBuilder;
Expand Down