Copy to clipboard

createSynonym

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

Creates a synonym.

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

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

--liquibase formatted sql

--changeset liquibase-docs:createSynonym-example
CREATE  SYNONYM  [A  String]  FOR  [A  String];

--liquibase formatted sql

--changeset liquibase-docs:createSynonym-example
CREATE  SYNONYM  [A  String]  FOR  [A  String];