@broadcom/dbm-db2-for-zowe-cli
Version:
Broadcom Database Management Solutions for Db2 for z/OS plug-in for Zowe CLI
82 lines (81 loc) • 4.05 kB
TypeScript
/*!
* Copyright (c) 2024 Broadcom. All Rights Reserved. The term
* "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* This software and all information contained therein is
* confidential and proprietary and shall not be duplicated,
* used, disclosed, or disseminated in any way except as
* authorized by the applicable license agreement, without the
* express written permission of Broadcom. All authorized
* reproductions must be marked with this language.
*
* EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
* THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
* SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
* LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
* FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL BROADCOM
* BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
* DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
* INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
* EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
*/
export declare const PLUGIN_NAME = "DBM-Db2";
export declare const PLUGIN_NAME_LOW: string;
export declare const PROFILE_SPECIAL_PROCESSING_PROPERTIES: string[];
export declare const IMPACT_REPORT_VERSION = "1.8.0";
export declare class ApiConstants {
static readonly BASE_PATH: string;
static readonly STATUS_POLL_DELAY: number;
}
export declare enum ErrorMsg {
EXECUTION_FAILURE_TEMPLATE = "Execution failed.{{ERROR_FILE_SAVED}}{{RESTART_TOKEN}}",
ERROR_FILE_SAVED = "Failure details saved to {{errorFilename}}",
RESTART_TOKEN = "Restart token: {{restartToken}}",
PROFILE_NOT_EXISTS = "Profile \"{{name}}\" of type \"{{type}}\" does not exist.",
INVALID_EXCEPTION = "Unable to process an exception due to invalid type. Expected \"{{type}}\", received:\n\n{{objectDetails}}"
}
export declare enum SuccessMsg {
CHECK_DDL = "DDL checked successfully. No errors found.",
COMPARE_DDL_TEMPLATE = "{{NO_OBJECT_CHANGES}}{{COMPARE_SCRIPT_SAVED}}{{SUMMARY_FILE_SAVED}}{{IMPACT_FILE_SAVED}}",
NO_OBJECT_CHANGES = "No Db2 object changes identified. Script execution is not required.",
COMPARE_SCRIPT_SAVED = "Compare-script saved to {{scriptFilename}}",
SUMMARY_FILE_SAVED = "Summary report saved to {{summaryFilename}}",
IMPACT_FILE_SAVED = "Impact report saved to {{impactFilename}}",
DEPLOY_DDL = "DDL deployed successfully.",
EXECUTE_SCRIPT = "Script executed successfully.",
EXECUTE_CMP_SCRIPT_TEMPLATE = "{{EXECUTE_SCRIPT}}{{RECOVERY_SCRIPT_INFO}}",
RECOVERY_SCRIPT_SKIPPED = "Recovery script not saved: Empty response received during restart. Existing output preserved.",
RECOVERY_SCRIPT_SAVED = "Recovery script saved to {{recoveryScriptFilename}}",
DDL_FILE_SAVED = "DDL saved to {{ddlFilename}}",
PREPARE_MIGRATION_TEMPLATE = "{{MIGRATION_SCRIPT_SAVED}}{{DDL_FILE_SAVED}}",
MIGRATION_SCRIPT_SAVED = "Migration-script saved to {{scriptFilename}}"
}
export declare const WorkDatasetsLocationMsg = "Work data sets location: {{HLQ}}";
export declare const SamplesRepoReference = "For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm-db2-for-zowe-cli";
export declare enum DefaultFileNames {
ERROR_FILE = "error.log",
COMPARE_SCRIPT = "compare.txt",
SUMMARY_FILE = "summary.txt",
IMPACT_FILE = "impact.json",
DDL_FILE = "output.sql",
RECOVERY_SCRIPT = "recovery.txt",
MIGRATE_SCRIPT = "migration.txt"
}
export declare enum DefaultValues {
VERIFY = "no",
TYPE = "create"
}
export declare enum Endpoints {
CHECK = "devops/check",
COMPARE = "devops/compare",
DEPLOY = "devops/deploy",
EXECUTE = "devops/execute",
EXECUTE_COMPARE = "devops/execute/compare",
EXECUTE_MIGRATE = "devops/execute/migrate",
GENERATE = "devops/generate",
MIGRATE = "devops/migrate",
STATUS = "devops/status",
SUBSYSTEMS_ACTIVE = "gen/subsystems/active",
ABOUT = "about"
}