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.

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‑filename	The file to contain DDL statements that create design projections, where output‑design‑filename includes the full path on the node where the session is connected.
output‑deployment‑filename	The file to contain the deployment script, where output‑deployment‑filename includes the full path on 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

Superuser
Design creator with WRITE privileges on storage locations of design and deployment scripts; otherwise DESIGNER_RUN_POPULATE_DESIGN_AND_DEPLOY cannot save the design and deployment scripts.

Requirements

Before calling this function, you must:

Create a design, a logical schema with tables.
Associate tables with the design.
Load queries to the design.
Set design properties (K-safety level, mode, and policy).

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/design_projections.sql',
   '/tmp/examples/vmart_design_files/design_deploy.sql',
   'true',
   'true',
   'false',
   'false'
   );