{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"_parentId":{"value":"896569345"}},"macroMetadata":{"macroId":{"value":"f24914eb-b38a-44f2-bc62-cd24d97288f8"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"8a3b831d-84de-4dfe-b747-bdce4cef3c8e"}},{"type":"heading","attrs":{"level":1},"content":[{"type":"hardBreak"},{"text":"Overview: Using Runtime Credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"If you do not want to store the database credentials, configure the project to use runtime credentials. We recommend this option because it is more secure.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"GUI","type":"text"}]},{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Settings","type":"text","marks":[{"type":"strong"}]},{"text":" tab, ","type":"text"},{"text":"Credential Management","type":"text","marks":[{"type":"strong"}]},{"text":" section, check ","type":"text"},{"text":"Specify database credentials at operation runtime","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":412,"widthType":"pixel"},"content":[{"type":"media","attrs":{"__fileSize":7646,"__fileMimeType":"image/jpeg","width":350,"id":"b883d66f-48b2-4b4a-9a97-201ca14b5b93","collection":"contentId-896569345","type":"file","__fileName":"GUI_runtime_credentials.jpg","height":49}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CLI","type":"text"}]},{"type":"paragraph","content":[{"text":"Use the ","type":"text"},{"text":"runtimeCredentials","type":"text","marks":[{"type":"code"}]},{"text":" option. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"hammer set runtimeCredentials --force true","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Manual changes to the datical.project file","type":"text"}]},{"type":"paragraph","content":[{"text":"If you do not use the GUI or cannot run the CLI command above, you can switch to Runtime Credentials by manually updating your datical.project file. Make the following adjustments:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"runtimeCredentials","type":"text","marks":[{"type":"code"}]},{"text":" value to true.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove the ","type":"text"},{"text":"username","type":"text","marks":[{"type":"code"}]},{"text":" attributes and values from the datical.project file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Remove the ","type":"text"},{"text":"password","type":"text","marks":[{"type":"code"}]},{"text":" attribute and values from the datical.project file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update the dbDef type atttribute values to be prefaced with DelayedCredential. Values should be updated as below:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"xsi:type=\"dbproject:OracleDbDef\"","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"xsi:type=\"dbproject:DelayedCredentialOracleDbDef\"","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"xsi:type=\"dbproject:SqlServerDbDef\"","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"xsi:type=\"dbproject:DelayedCredentialSqlServerDbDef\"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"xsi:type=\"dbproject:PostgresqlDbDef\"","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"xsi:type=\"dbproject:DelayedCredentialPostgresqlDbDef\"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From ","type":"text"},{"text":"xsi:type=\"dbproject:Db2DbDef\"","type":"text","marks":[{"type":"code"}]},{"text":" to ","type":"text"},{"text":"xsi:type=\"dbproject:DelayedCredentialDb2DbDef\"","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Runtime Credential Precedence","type":"text"}]},{"type":"paragraph","content":[{"text":"When the runtime credentials option is set for a project, then during operations, Datical DB checks for where the credentials are specified. Credential locations are checked in the following order:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Explicit credentials for an operation:","type":"text"},{"type":"hardBreak"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CLI - You specify credentials in command options","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Environment variables (CLI only)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Prompting. If the credentials are not provided explicitly and the environment variable is not set, Datical DB displays a prompt for the user to enter the credentials. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GUI - Prompt dialog","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CLI - Prompt line","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Explicit Credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"If you provide credentials in command options at the CLI, those credentials are checked. ","type":"text"}]},{"type":"paragraph","content":[{"text":"If they fail, no further checking is done, and the command fails. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Single-Credential Commands","type":"text"}]},{"type":"paragraph","content":[{"text":"The credential options use a space to separate the option and the value. Do not use \"=\". ","type":"text"}]},{"type":"table","attrs":{"layout":"wide","width":963.0,"localId":"99748a35-9946-43e2-b04e-507a3f36ee9e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"Option","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"One of these forms:","type":"text"}]},{"type":"paragraph","content":[{"text":"-un ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-dbusername ","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"User name in one of the following forms:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":":::","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"One of these forms:","type":"text"}]},{"type":"paragraph","content":[{"text":"-pw ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-dbpassword ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"Password in one of the following forms:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" :::","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"One of these forms for DMCDB username ( version 8.3 and later):","type":"text"},{"type":"hardBreak"},{"text":"-dun ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-dmcusername ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"User name in this form:","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[604.0]},"content":[{"type":"paragraph","content":[{"text":"One of these forms for DMCDB password ( version 8.3 and later):","type":"text"},{"type":"hardBreak"},{"text":"-dpw ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-dmcpassword ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[359.0]},"content":[{"type":"paragraph","content":[{"text":"Password in this form:","type":"text"},{"type":"hardBreak"},{"text":"","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If you pass username and password (with -un and -pw options) in such format: -un -pw , they are going to be set as global credentials.","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example: Forecast Operation","type":"text"}]},{"type":"paragraph","content":[{"text":"If you want to specify both credentials for source database and DMC DB you should do so in the following format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"hammer forecast DEV -un DEV:::username -pw DEV:::password -dun dmcusername -dpw dmcpassword","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"DEV","type":"text","marks":[{"type":"code"}]},{"text":" is the equivalent to the source database name.","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Two-credential Commands","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"diff","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"diffChangeLog","type":"text","marks":[{"type":"code"}]},{"text":" commands require two database names as options. ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Reference database - Represents the desired state.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Target database - Represents a current state, which is to be measured against the desired state.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The credential options use a space to separate the option and the value. Do not use \"=\". ","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":848.0,"localId":"636fd0e3-e0e8-46e2-b5fd-a503c4522dae"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[338.0]},"content":[{"type":"paragraph","content":[{"text":"Option","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[510.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[338.0]},"content":[{"type":"paragraph","content":[{"text":"-ru ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-referenceUsername ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[510.0]},"content":[{"type":"paragraph","content":[{"text":"Reference database user name ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[338.0]},"content":[{"type":"paragraph","content":[{"text":"-rpw ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"-referencePassword ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[510.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the reference database user name","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[338.0]},"content":[{"type":"paragraph","content":[{"text":"-tu ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"--targetUsername ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[510.0]},"content":[{"type":"paragraph","content":[{"text":"Target database user name ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[338.0]},"content":[{"type":"paragraph","content":[{"text":"-tpw ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"--targetPassword ","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[510.0]},"content":[{"type":"paragraph","content":[{"text":"Password for the target database user name","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example: Performing a Diff","type":"text"}]},{"type":"paragraph","content":[{"text":"In this example, ","type":"text"},{"text":"TEST","type":"text","marks":[{"type":"strong"}]},{"text":" is the reference database (desired state) and ","type":"text"},{"text":"DEV","type":"text","marks":[{"type":"strong"}]},{"text":" is the target database (measured against the desired state).","type":"text"}]},{"type":"codeBlock","content":[{"text":"hammer diff TEST DEV -ru refDbUser -rpw refDbPass -tu targetUser -tpw targetPass","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Environment Variables","type":"text"}]},{"type":"paragraph","content":[{"text":"When the project is set to use runtime credentials and you run an operation from the CLI, environment variables are checked. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Set the following environment variables if you want to provide default credentials for CLI hammer commands:","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1011.0,"localId":"07c0b037-b2e8-4db5-9798-6a564c9e98f7"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"Environment variables","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"DDB_USER","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"DDB_PASS","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Database credentials. Used for commands that operate on a single database: forecast, deploy, rollback, and package (deployPackager.groovy) operations.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"DDB_USER_","type":"text","marks":[{"type":"strong"}]},{"type":"hardBreak"},{"text":"DDB_PASS_","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Database credentials for an individual step (DbDef). Used only for groovy commands, including ","type":"text"},{"text":"deployPackager.groovy","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text"}]},{"type":"paragraph","content":[{"text":"The per-DbDef environment variables are checked first. If they are not set, then DDB_USER and DDB_PASS are checked. ","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"DDB_REF_USER","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"DDB_REF_PASS","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Used with ","type":"text"},{"text":"REFERENCE ","type":"text","marks":[{"type":"strong"}]},{"text":"variables for commands that operate on two databases.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"diff","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"diffchangelog","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"DDB_TARGET_USER","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"DDB_TARGET_PASS","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Used with ","type":"text"},{"text":"TARGET","type":"text","marks":[{"type":"strong"}]},{"text":" variables for commands that operate on two databases.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"diff","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"diffchangelog","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[244.0]},"content":[{"type":"paragraph","content":[{"text":"DDB_DMCDB_USER","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"type":"hardBreak"},{"text":"DDB_DMCDB_PASS","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[767.0]},"content":[{"type":"paragraph","content":[{"text":"Used to access the DMCDB database. Operations cause entries to be entered in the DMCDB database:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"forecast","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"deploy","type":"text"}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Prompts for Credentials","type":"text"}]},{"type":"paragraph","content":[{"text":"When you perform an action in the GUI, you will be prompted to provide credentials if Runtime credentials are required. (Either the project option is set or no credentials have been entered for a step.) ","type":"text"}]},{"type":"paragraph","content":[{"text":"You are prompted with a dialog:","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"342","id":"77c8b580-2ff3-4e11-9cb1-a3d87c7e69b0","collection":"contentId-896569345","height":"338"}}}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Note","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once you enter the credentials for the deployment step, you are not prompted again for additional operations in the current session.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You must re-enter credentials when the project is closed and re-opened (new session).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You must re-enter credentials if a connection fails.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Video","type":"text"}]},{"type":"paragraph","content":[{"text":"See also video 9 about ","type":"text"},{"text":"Database Credentials","type":"text","marks":[{"type":"link","attrs":{"href":"https://datical-cs.atlassian.net/wiki/spaces/DDKB/pages/1084719137/How+Liquibase+Enterprise+Works#9.-Database-Credentials"}}]}]}],"version":1}

Browser not supported