Versions Compared

Old Version 8

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Kevin Chappell

Saved on

Key

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

Table of Contents

...

This guide is applicable when

...

  • When you have multiple pipelines in your Datical project
  • You have deployed on one pipeline (for example Oct release pipeline) and ready to backfill your deployments in the other pipeline (for example Nov release pipeline)
  • You bypassed your deployments to rush something to production and now you need to deploy your changes to lower environments to keep them in sync


Overview

A backfill is really two operations in one:

...

Info

You will need to have Datical DB's composite repo installed with necessary drivers for your database. For installing drivers for automation (e.g., for use with Jenkins), use "hammer installDrivers" command to install drivers that are necessary to complete these steps.

Step-by-step guide (Using automation via "hammer" CLI)

Using Datical DB's command line tool "hammer", follow these steps to implement backfill operation, i.e., deploy October changes into "Pipeline 2":

  1. CLI - Add Labels: You will first add November label "nov_release" to all October changes
    1. use "hammer addLabels" command to add labels to October changes

      1. Here is the help for "hammer addLabels" command

        Code Block
        languagebash
        firstline1
        titleaddLabels help
        linenumberstrue
        collapsetrue
        USAGE:
  addLabels --lookupChangesets=<label expression> --labels=<comma separated list of labels to add> --scriptChecksum=<SQL script checksum value>
            --matchAll=<true/false>Options:
  lookupChangesets    - Expression used to match the change sets (required)
  labels              - Comma-separated list of labels (required)
  scriptChecksum      - SQL script checksum value
  matchAll            - SQL Script checksums must match for change set lookup. Default value is true


    2. For our example, use this command to add "nov_release" label to October changes:
      1. hammer addLabels --lookupChangesets="oct_release" --labels="nov_release"
      2. Successful completion of this command generates the following output:


      3. Code Block
        languagebash
        firstline1
        titleaddLabels
        linenumberstrue
        collapsetrue
        C:\Users\Datical\datical\DDBProject>hammer addLabels --lookupChangesets="oct_release" --labels="nov_release"
Updating labels for change set j6fm-1 (createTable tableName=AAA_TESTA1)
Updating labels for change set jvrp-1 (createTable tableName=AAA_TESTA2)
Updating labels for change set 20170714131141429_Insert_dml_AAA_TESTA1
Updating labels for change set 20170714131141461_Insert_dml_AAA_TESTA2
Updating labels for change set AutoPermissions_PPADM_Tables


C:\Users\Datical\datical\DDBProject>


    3. You have now successfully added "nov_release" label to all October changes.

  2. CLI - Deploy: Now deploy October changes into Pipeline 2 using "hammer" command
    1. You can now Forecast on REF2. 
      1. Use "hammer forecast" command. Here is the help for "hammer forecast" command


        1. Code Block
          languagebash
          firstline1
          titleforecast help
          linenumberstrue
          collapsetrue
          C:\Users\Datical\datical\DDBProject>hammer help forecast
forecast - Simulates all change sets that have not been applied to the indicated database reference.

USAGE:
  forecast <dbref> [--log=/path/to/log] [--report=/path/to/report] [--context=context1,context2]  [--labels=<label expression>]

EXAMPLE:
  forecast myAppDevDb --log=/home/user/logs/ --report=/home/user/reports --context=dev,qa --labels="JUN AND (poolApp or beachApp)"
OPTIONAL PARAMETERS:
  --log - Location to write the daticaldb.log file. Log is written to 'Logs' directory of project by default.
  --report - Location to write the forecast report. Report is written to the 'Reports' directory by default.
  --context - Only change sets marked with the contexts specified will be executed.  To run all contexts, specify $all. 
  --labels - When set, only change sets marked with the label expression will be executed.  To run all labels, specify $all.

C:\Users\Datical\datical\DDBProject> 


      2. For our example, use this command to forecast "nov_release" label to October changes:

        1. hammer forecast REF2 --labels="nov_release"
        2. Successful completion of this command generates the following output:


          1. Code Block
            languagebash
            firstline1
            titleforecast
            linenumberstrue
            collapsetrue
            C:\Users\Datical\datical\DDBProject>hammer forecast REF2 --labels="nov_release"
There were no rules files found.
Defaulting contexts to REF2 from REF2
Defaulting to database definition contexts of 'REF2'
There are 5 change sets forecast to be deployed using labels 'nov_release' and contexts 'ref2'

Report ready at C:\Users\Datical\datical\DDBProject\Reports\2017\07-Jul\REF2\forecast_REF2_20170724_152507\forecastReport.html

C:\Users\Datical\datical\DDBProject>


        3. Review the forecast report. 
    2. Since backfill using CLI is typically performed by an automation tool, it is a good practice to perform "statusDetails" both before and after the deploy operation in order to track pre-deploy and post-deploy status of your database.
      1. Use "hammer statusDetails REF2" command to obtain status of the REF2 database prior to the deploy operation
      2. Here is a sample output of "hammer statusDetails" command:


    3. Use "hammer deploy" command. Here is the help for "hammer forecast" command


      1. Code Block
        languagebash
        firstline1
        titledeploy help
        linenumberstrue
        collapsetrue
        C:\Users\Datical\datical\DDBProject>hammer help deploy
The deploy command deploys all change sets that have not been applied to the indicated database reference in the project.
USAGE:
  deploy <dbref> [--pipeline=<pipeline name>] [--log=/path/to/log] [--report=/path/to/report] [--context=context1,context2] [--labels=<label expression>]

EXAMPLE:
  deploy myAppDevDb --pipeline=DEV --log=/home/user/daticallogs/ --report=/home/user/daticalreports --context=dev,integration --labels="JUN AND (poolApp or beachApp)"
OPTIONAL PARAMETERS:
  --log - When set, the daticaldb.log file will be written to the directory specified.  Log is written to 'Logs' directory of project by default.
  --pipeline - When set, this is the pipeline which will be associated with the deployment for auditing purposes.
               If not set, and the dbDef is a member of one and only one pipeline, then that pipeline will be used.
               If not set, and the dbDef is a member of multiple pipelines, then an error will be displayed.
  --report - When set, deploy report will be written to the directory specified.  Report is written to the 'Reports' directory by default.
  --context - When set, only change sets marked with the contexts specified will be executed.  To run all contexts, specify $all.
  --labels - When set, only change sets marked with the label expression will be executed.  To run all labels, specify $all.

C:\Users\Datical\datical\DDBProject> 


      2. For our example, use this command to forecast "nov_release" label to October changes:

        1. hammer deploy REF2 --labels="nov_release"

      3. Review the deploy report for any errors during deployment
    4. Perform "hammer statusDetails" again after successful deployment:
      1. Use "hammer statusDetails REF2" command to obtain status of the REF2 database after the deploy operation
    5. You have now successfully backfilled October changes into REF2 database. 
    6. Repeat steps 2a-2d to backfill DEV2 and QA2 databases.

Step-by-step guide (Using Datical DB GUI)

Using Datical GUI follow these steps to implement backfill operation, i.e., deploy October changes into "Pipeline 2":

...

Repeat steps 2a-2b to backfill DEV2 and QA2 databases.