Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you use TNS names in your dbDef, then you should prepare either:

  • Prepare a TNS name with _eph postfix for the ephemeral copy because Liquibase cannot modify TNS files.

  • Or, if you use the oracleEphemeralCopyTnsName deploy packager property, you should prepare a TNS name for the value specified in the property.

    If this is what your dbDefs look like:

Code Block
<dbDefs xsi:type="dbproject:OracleDbDef" name="DEV" hostname="localhost" driver="oracle.jdbc.OracleDriver" tnsName="dev" />
<dbDefs xsi:type="dbproject:OracleDbDef" name="DEV_EPHEMERAL" driver="oracle.jdbc.OracleDriver" tnsName="admin_sysoper" />

Then you should add a dev_eph entry, or your chosen custom name if you used oracleEphemeralCopyTnsName, in your TNS configuration that points to a PDB. To determine the service name or SID for the PDB which that this TNS will point to, use one of the following methods depending on your situation:

  • If you provided a value for oracleEphemeralCopyName , then this value will be what you add to your TNS configuration.

...

  1. Create the project using the instructions from Creating a Liquibase Enterprise Using the Project Creation Script (project_creator.groovy) https://datical-cs.atlassian.net/wiki/spaces/DDOC/pages/896569181

  2. Include the ephemeral database on the ProjectNameOracle.dbdefs.tsv.txt.
    Use name: <dbDef_to_be_cloned>_EPHEMERAL

...

These are packaging properties available specifically for the ephemeral database packaging method. They are optional if you would like to override the default values.

Property Name

Description

oracleEphemeralSourceNameephemeralCleanUpBeforeStart

[Optional] Defines a source name for an Oracle source PDB in the event Liquibase has not been granted the necessary permissions to query for this name.

Necessary permissions are included below. If these grants are not present, oracleEphemeralSourceName will be required.

  • Multi-schema projects: GRANT SELECT ANY DICTIONARY TO DATICAL_ROLE;

  • Single schema projects Liquibase requires either:

    • GRANT SELECT ANY DICTIONARY TO DATICAL_SCHEMA_OWNER_ROLE;

    • OR permission to query v$pdbs and dba_data_files

  • See Roles and Permissions for Liquibase Enterprise on Oracle Database for further information on permissions.

Property Validation: Source name should up to 30 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number.

oracleEphemeralCopyName

[Optional] Defines a name for an Oracle copy PDB in the event the default name is not desired.

Default name for the ephemeral copy will be source PDB name with _eph postfix. For example, if source name is bucket_01, the copied bucket name will be bucket_01_eph.

Property Validation: Copy name should be up to 30 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number.

oracleEphemeralDatabaseLinkName

[Optional] Defines a name for a database link which is used with PackageMethod BackupRestoreOracleEphemeralExternalPdb.

Default link name will be liquibase_db_link.

Property Validation: Database link name should up to 128 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number. Allows Liquibase to drop any existing Ephemeral PDB if found during an Ephemeral Packaging Operation. Existing PDBs can occur from failures or cancelations from previous Ephemeral Packaging jobs.

Property Validation: true/false

Default value: false

Available in Liquibase 8.9 and later

oracleEphemeralSourceName

[Optional] Defines a source name for an Oracle source PDB in the event Liquibase has not been granted the necessary permissions to query for this name.

Necessary permissions are included below. If these grants are not present, oracleEphemeralSourceName will be required.

  • Multi-schema projects: GRANT SELECT ANY DICTIONARY TO DATICAL_ROLE;

  • Single schema projects Liquibase requires either:

    • GRANT SELECT ANY DICTIONARY TO DATICAL_SCHEMA_OWNER_ROLE;

    • OR permission to query v$pdbs and dba_data_files

  • See Roles and Permissions for Liquibase Enterprise on Oracle Database for further information on permissions.

Property Validation: Source name should up to 30 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number.

oracleEphemeralCopyName

[Optional] Defines a name for an Oracle copy PDB in the event the default name is not desired.

The ephemeral copy's default name will be the source PDB name with the _eph postfix. For example, if the source name is bucket_01, the copied bucket name will be bucket_01_eph.

Property Validation: Copy name should be up to 30 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number.

oracleEphemearalCopySid

[Optional] This impacts Oracle Ephemeral packaging only.

Overrides Oracle copy dbDef SID if the source dbDef uses SID as the connection type. If the property is not specified, the _eph postfix will be added to the source SID

Example: e.g., datical_siddatical_sid_eph

Available in Liquibase 8.9 and later

oracleEphemeralCopyServiceName

[Optional] This impacts Oracle Ephemeral packaging only.
Overrides the Oracle copy dbDef SERVICE_NAME if the source dbDef uses SERVICE_NAME as a connection type. If the property is not specified, _eph postfix will be added to source SERVICE_NAME before a first dot

Example: datical.dev.com -> datical_eph.dev.com

If SERVICE_NAME does not contain dots, they will be added at the end

Example: datical_service_name -> datical_service_name_eph Available in Liquibase 8.9 and later

oracleEphemeralCopyTnsName

[Optional] This impacts Oracle Ephemeral packaging only.

Overrides the Oracle copy dbDef TNS_NAME if the source dbDef uses TNS_NAME as connection type. If the property is not specified _eph postfix will be added to source TNS_NAME

datical_tns -> datical_tns_eph

Available in Liquibase 8.9 and later

oracleEphemeralCopyWithData

[Optional] By default Liquibase will copy databases without data. (*) If you would like to copy both the structure and data, use this boolean property.

(*) There is one exception in that the data from the DATABASECHANGELOG table is included in the database copythe DATABASECHANGELOG table is included in the database copy.

Property Validation: true/false

oracleEphemeralDatabaseLinkName

[Optional] Defines a name for a database link which is used with PackageMethod BackupRestoreOracleEphemeralExternalPdb.

Default link name will be liquibase_db_link.

Property Validation: true/false Database link name should up to 128 characters long, contain no spaces [ ], slashes [/] and semicolons [;] and cannot begin with a number.

oracleEphemeralSkipFinalDeploy

[Optional] The default value for this setting is false. Any changes being packaged are deployed to the first database in the pipeline during the Deploy Packager operation.

Setting this value to true allows changes to be packaged and changesets to be created and stored in the changelog.xml, but the deployment to the first database in the pipeline does not occur.

Property Validation: true/false

...