DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY

Populates the design and creates the design and deployment scripts. DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY can also analyze statistics, deploy the design, and drop the workspace after the deployment.

Caution: DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY does not create a backup copy of the current design before deploying the new design. Before running this function, back up the existing schema design with EXPORT_CATALOG.

Behavior Type

Immutable

Syntax

DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY ( 
    'design‑name', 
    'output‑design‑file', 
    'output‑deployment‑file', 
    [ 'analyze‑statistics',  ] 
    [ 'deploy',  ] 
    [ 'drop‑design‑workspace',  ] 
    [ 'continue‑after‑error',  ]
    )

Parameters

design‑name

Name of the design to populate and deploy.

output‑design‑file

Specifies where to save the file with DDL statements to create design projections, where output‑design‑file is an absolute path to the node where the session is connected.

output‑deployment‑file

Specifies where to save the file that contains the deployment script, where output‑deployment‑file is an absolute path to the node where the session is connected.

analyze‑statistics

Specifies whether to collect or refresh statistics for the tables before populating the design. If set to true, Vertica Invokes ANALYZE_STATISTICS. Accurate statistics help Database Designer optimize compression and query performance. However, updating statistics requires time and resources.

Default: false

deploy

Specifies whether to deploy the Database Designer design using the deployment script created by this function.

Default: true

drop‑design‑workspace

Specifies whether to drop the design workspace after the design is deployed.

Default: true

continue‑after‑error

Specifies whether DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY continues to run after an error occurs. By default, an error causes this function to terminate.

Default: false

Privileges

Requirements

Before calling this function, you must:

Examples

The following example creates projections for and deploys the VMART_DESIGN design, and analyzes statistics about the design tables.

=> SELECT DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY (
   'VMART_DESIGN',
   '/tmp/examples/vmart_design_files/vmart_design_DDL',
   '/tmp/examples/vmart_design_files/vmart_design_deployment_scripts',
   'true',
   'false',
   'false',
   'false'
   );

See Also

Running Database Designer Programmatically