dropFunction
Note: This is a Liquibase Pro Change Type, so you need a Liquibase Pro License Key to use it.
Drops an existing function.
Run dropFunction
To run this Change Type, follow these steps:
- Add the Change Type to your changeset, as shown in the examples on this page.
- Specify any required attributes. Use the table on this page to see which ones your database requires.
- Deploy your changeset by running the
update
command:
liquibase update
Available attributes
Name | Description | Required for | Supports | Since |
---|---|---|---|---|
catalogName
|
Name of the catalog |
asany, db2, db2z, derby, firebird, h2, hsqldb, informix, ingres, mariadb, mysql, oracle, postgresql, sqlite, sybase | ||
functionName
|
Name of the function |
all | all | |
schemaName
|
Name of the schema |
all |
Rollback with dropFunction
When performing rollbacks, Liquibase allows you to drop functions with or without quotes in the function name.
Name Examples:
"FUNCTION1"()
FUNCTION1()
If you use double quotes like "FUNCTION1"(), the corresponding drop syntax should be DROP FUNCTION "FUNCTION1"() as well.
Examples
--liquibase formatted sql
--changeset liquibase-docs:dropFunction-example
DROP FUNCTION cat.`A String`;
databaseChangeLog:
- changeSet:
id: dropFunction-example
author: liquibase-docs
changes:
- dropFunction:
catalogName: cat
functionName: A String
schemaName: public
{
"databaseChangeLog": [
{
"changeSet": {
"id": "dropFunction-example",
"author": "liquibase-docs",
"changes": [
{
"dropFunction": {
"catalogName": "cat",
"functionName": "A String",
"schemaName": "public"
}
}
]
}
}
]
}
<databaseChangeLog
xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:ext="http://www.liquibase.org/xml/ns/dbchangelog-ext"
xmlns:pro="http://www.liquibase.org/xml/ns/pro"
xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-latest.xsd
http://www.liquibase.org/xml/ns/dbchangelog-ext
http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd
http://www.liquibase.org/xml/ns/pro
http://www.liquibase.org/xml/ns/pro/liquibase-pro-latest.xsd">
<changeSet author="liquibase-docs" id="dropFunction-example">
<pro:dropFunction catalogName="cat"
functionName="A String"
schemaName="public"/>
</changeSet>
</databaseChangeLog>
Database support
Database | Notes | Auto Rollback |
---|---|---|
DB2/LUW | Supported | No |
DB2/z | Supported | No |
Derby | Supported | No |
Firebird | Supported | No |
Google BigQuery | Supported | No |
H2 | Supported | No |
HyperSQL | Supported | No |
INGRES | Supported | No |
Informix | Supported | No |
MariaDB | Supported | No |
MySQL | Supported | No |
Oracle | Supported | No |
PostgreSQL | Supported | No |
Snowflake | Supported | No |
SQL Server | Supported | No |
SQLite | Not Supported | No |
Sybase | Supported | No |
Sybase Anywhere | Supported | No |