createFunction

Note: This is a Liquibase Pro Change Type, so you need a Liquibase Pro License Key to use it.

Creates a stored function.

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
`dbms`	Specifies which database type(s) a changeset is to be used for. See valid database type names on Liquibase Database Tutorials. Separate multiple databases with commas. Specify that a changeset is not applicable to a particular database type by prefixing with `!`. The keywords `all` and `none` are also available.		all	3.1
`encoding`	Encoding used in the file defined in the `path` attribute		all
`functionBody`	The SQL creating the function. You need to define either this attribute or the `path` attribute. The `functionBody` attribute is not supported in the XML format; however, you can specify the function SQL in a nested format. See the XML example.	all	all
`functionName`	Name of the function	all	all
`path`	File containing the procedure text. Either this attribute or a nested procedure text is required.	all	all
`procedureText`	The SQL creating the procedure. You need to define either this attribute or the `path` attribute. The `procedureText` attribute is not supported in the XML format; however, you can specify the procedure SQL in a nested format. See the XML example.	all	all
`relativeTo Changelog File`	Specifies whether the file path is relative to the changelog file rather than looked up in the search path. Default: `false`.		all
`replaceIfExists`	Boolean. If the stored procedure defined by `procedureName` already exists, alter it instead of creating it. Default: `false`.		all
`schemaName`	Name of the schema		all

XML example

...
<changeSet  author="liquibase-docs"  id="createFunction-example">
    <pro:createFunction  catalogName="cat"
            dbms="h2, !oracle, mysql"
            encoding="UTF-8"
            functionName="A String"
            path="com/example/my-logic.sql"
            relativeToChangelogFile="true"
            replaceIfExists="false"
            schemaName="public">A String</pro:createFunction>
</changeSet>
...

YAML example

...
-  changeSet:
    id:  createFunction-example
    author:  liquibase-docs
    changes:
    -  createFunction:
        catalogName:  cat
        dbms:  h2, !oracle, mysql
        encoding:  UTF-8
        functionBody:  A String
        functionName:  A String
        path:  com/example/my-logic.sql
        relativeToChangelogFile:  true
        replaceIfExists:  false
        schemaName:  public
...

JSON example

...
{
  "changeSet":  {
    "id":  "createFunction-example",
    "author":  "liquibase-docs",
    "changes":  [{
      "createFunction":  {
        "catalogName":  "cat",
        "dbms":  "h2, !oracle, mysql",
        "encoding":  "UTF-8",
        "functionBody":  "A String",
        "functionName":  "A String",
        "path":  "com/example/my-logic.sql",
        "relativeToChangelogFile":  true,
        "replaceIfExists":  false,
        "schemaName":  "public"
      }
    }]
  }
}
...

Database support

Database	Notes	Auto Rollback
DB2/LUW	Supported	No
DB2/z	Supported	No
Derby	Supported	No
Firebird	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