Skip to content

implemented drop column if exists for postgres #996

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

implemented drop column if exists for postgres #996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion src/backend/mysql/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,8 +190,11 @@ impl TableBuilder for MysqlQueryBuilder {
sql.write_str(" TO ").unwrap();
self.prepare_iden(to_name, sql);
}
TableAlterOption::DropColumn(column_name) => {
TableAlterOption::DropColumn(DropColumnOption { column_name, if_exists }) => {
sql.write_str("DROP COLUMN ").unwrap();
if *if_exists{
panic!("MySQL does not support drop column if exists");
}
self.prepare_iden(column_name, sql);
}
TableAlterOption::DropForeignKey(name) => {
Expand Down
8 changes: 7 additions & 1 deletion src/backend/postgres/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,8 +170,14 @@ impl TableBuilder for PostgresQueryBuilder {
sql.write_str(" TO ").unwrap();
self.prepare_iden(to_name, sql);
}
TableAlterOption::DropColumn(column_name) => {
TableAlterOption::DropColumn(DropColumnOption{
column_name,
if_exists
}) => {
sql.write_str("DROP COLUMN ").unwrap();
if *if_exists {
sql.write_str("IF EXISTS ").unwrap();
}
self.prepare_iden(column_name, sql);
}
TableAlterOption::DropForeignKey(name) => {
Expand Down
10 changes: 8 additions & 2 deletions src/backend/sqlite/table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,15 @@ impl TableBuilder for SqliteQueryBuilder {
sql.write_str(" TO ").unwrap();
self.prepare_iden(to_name, sql);
}
TableAlterOption::DropColumn(col_name) => {
TableAlterOption::DropColumn(DropColumnOption {
column_name,
if_exists,
}) => {
sql.write_str("DROP COLUMN ").unwrap();
self.prepare_iden(col_name, sql);
if *if_exists {
panic!("Sqlite does not support drop column if exists");
}
self.prepare_iden(column_name, sql);
}
TableAlterOption::DropForeignKey(_) => {
panic!(
Expand Down
42 changes: 40 additions & 2 deletions src/table/alter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ pub struct AddColumnOption {
pub(crate) if_not_exists: bool,
}

/// table alter drop column options
#[derive(Debug, Clone)]
pub struct DropColumnOption {
pub(crate) column_name: DynIden,
pub(crate) if_exists: bool,
}

/// All available table alter options
#[allow(clippy::large_enum_variant)]
#[derive(Debug, Clone)]
Expand All @@ -50,7 +57,7 @@ pub enum TableAlterOption {
AddColumn(AddColumnOption),
ModifyColumn(ColumnDef),
RenameColumn(DynIden, DynIden),
DropColumn(DynIden),
DropColumn(DropColumnOption),
AddForeignKey(TableForeignKey),
DropForeignKey(DynIden),
}
Expand Down Expand Up @@ -234,7 +241,38 @@ impl TableAlterStatement {
where
T: IntoIden,
{
self.add_alter_option(TableAlterOption::DropColumn(col_name.into_iden()))
self.add_alter_option(TableAlterOption::DropColumn(DropColumnOption {
column_name: col_name.into(),
if_exists: false,
}))
}

/// Drop a column from an existing table if it exists
///
/// # Examples
///
/// ```
/// use sea_query::{tests_cfg::*, *};
///
/// let table = Table::alter()
/// .table(Font::Table)
/// .drop_column_if_exists("new_column")
/// .to_owned();
///
/// assert_eq!(
/// table.to_string(PostgresQueryBuilder),
/// r#"ALTER TABLE "font" DROP COLUMN IF EXISTS "new_column""#
/// );
/// // MySQL and Sqlite do not support DROP COLUMN IF EXISTS
/// ```
pub fn drop_column_if_exists<T>(&mut self, col_name: T) -> &mut Self
Copy link
Member

@Huliiiiii Huliiiiii Oct 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we implement polyfills for other backends to avoid a panic?
@tyt2y3

where
T: IntoIden,
{
self.add_alter_option(TableAlterOption::DropColumn(DropColumnOption {
column_name: col_name.into(),
if_exists: true,
}))
}

/// Add a foreign key to existing table
Expand Down
Loading