createSynonym

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

Creates a synonym.

Run createSynonym

To run this Change Type, follow these steps:

  1. Add the Change Type to your changeset, as shown in the examples on this page.
  2. Specify any required attributes. Use the table on this page to see which ones your database requires.
  3. Deploy your changeset by running the update command:
    4. liquibase update

Available attributes

Name Description Required for Supports Since
objectCatalogName Name of the catalog of the object the synonym represents all
objectName

Name of the object the synonym represents

 all all
objectSchemaName Name of the schema of the object the synonym represents all
objectType

Data type of the object the synonym represents

 db2 all
private

Boolean. If true, the synonym can only be accessed by the creator. If false, the synonym can be accessed by PUBLIC.

 db2z all
replaceIfExists

Boolean. If the synonym defined by synonymName already exits, alter it instead of creating it. Default: false.

 all
synonymCatalogName Name of the catalog of the synonym all
synonymName

Name of the synonym

 all all
synonymSchemaName Name of the schema of the synonym all

Examples

--liquibase formatted sql

--changeset liquibase-docs:createSynonym-example
CREATE  SYNONYM  [A  String]  FOR  [A  String];
databaseChangeLog:
-  changeSet:  
    id:  createSynonym-example  
    author:  liquibase-docs  
    changes:  
    -  createSynonym:  
        objectName:  A String  
        objectType:  A String  
        private:  true  
        replaceIfExists:  false  
        synonymName:  A String
{
    "databaseChangeLog": [
        {
            "changeSet": {
                "id": "createSynonym-example",
                "author": "liquibase-docs",
                "changes": [
                    {
                        "createSynonym": {
                            "objectName": "A String",
                            "objectType": "A String",
                            "private": true,
                            "replaceIfExists": false,
                            "synonymName": "A String"
                        }
                    }
                ]
            }
        }
    ]
}
<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="createSynonym-example">
        <pro:createSynonym  objectName="A String"
            objectType="A String"
            private="true"
            replaceIfExists="false"
            synonymName="A String"/>
    </changeSet>

</databaseChangeLog>

Database support

Database Notes Auto Rollback
DB2/LUW Supported Yes
DB2/z Supported Yes
Derby Not Supported No
Firebird Not Supported No
Google BigQuery Supported Yes
H2 Not Supported No
HyperSQL Not Supported No
INGRES Not Supported No
Informix Not Supported No
MariaDB Not Supported No
MySQL Not Supported No
Oracle Supported Yes
PostgreSQL Not Supported No
Snowflake Not Supported No
SQL Server Supported Yes
SQLite Not Supported No
Sybase Not Supported No
Sybase Anywhere Not Supported No