ALTER TEMPLATE

Changes the definition of an existing template. Use this command to rename a template, change the owner of a template, add or remove parameters from the template definition, or set parameter values.

Required privileges

To alter a template, you must have one of the following:

• Superuser privileges

• ALTER TEMPLATE privilege and USAGE privilege on the schema containing the template

Syntax

ALTER TEMPLATE [database_name.][schema_name.]template_name
{
RENAME TO new_name
| OWNER TO new_owner
| ADD  parameter [AS] [value]
| DROP parameter
| SET parameter TO value1 [, parameter2 TO value2 , ...]
};

Parameters

database_name

(Optional) The name of the database in which the template is created. If not specified, the current database is used.

schema_name

(Optional) The name of the schema in which the template is created. If not specified, the template is searched for in the current search path.

template_name

The name of the template to be altered.

RENAME TO

A clause that renames the template.

new_name

The new name of the template. For more information about valid names, see Names and identifiers.

OWNER TO

A clause that changes the owner of the template.

new_owner

The new owner of the template.

ADD parameter [AS] [value]

Adds a new parameter to the template.

• For keyword-only parameters (such as CSV or GZIP), specify just the parameter name.

• For parameters that require values, specify the parameter name followed by the value. You can optionally include AS between the parameter and value.

DROP parameter

Removes the specified parameter from the template. Cannot drop multiple parameters with a single DROP command.

SET parameter TO value1 [, parameter2 TO value2 , ...]

Updates the values of existing template parameters. Only use for parameters that already have values. Multiple parameters can be updated in a single command.

Examples

The following example renames the test_template template to demo_template.

ALTER TEMPLATE test_template
RENAME TO demo_template;

The following example gives ownership of the demo_template schema to the user bob.

ALTER TEMPLATE demo_template
OWNER TO bob;

The following example adds parameter CSV to template demo_template

ALTER TEMPLATE demo_template
ADD CSV;

The following example adds parameter TIMEFORMAT 'auto' to template demo_template

ALTER TEMPLATE demo_template
ADD TIMEFORMAT 'auto';

The following example drops parameter ENCRYPTED from template demo_template

ALTER TEMPLATE demo_template
DROP ENCRYPTED;

The following example sets the DELIMITER parameter to '|' and the TIMEFORMAT parameter to 'epochsecs':

ALTER TEMPLATE demo_template
SET DELIMITER TO '|', TIMEFORMAT TO 'epochsecs';