Top
Enterprise Postgres 17 Operation Guide

B.4.4 pgx_enable_confidential_policy

Description

Enables or disables masking policies

Format

pgx_enable_confidential_policy(
[schema_name	:= 'schemaName', ]
table_name 	:= 'tableName', 
policy_name	:= 'policyName',
enable		:= 'policyStatus'
)

Argument

Details are as follows.

Argument

Data type

Description

Default value

schema_name

varchar(63)

Schema name of table for which a masking policy is enabled or disabled

'public'

table_name

varchar(63)

Name of table for which a masking policy is enabled or disabled

Mandatory

policy_name

varchar(63)

Masking policy name

Mandatory

enable

boolean

Masking policy status

  • 't': Enabled

  • 'f': Disabled

Mandatory

Details about whether arguments can be omitted are as follows.

Argument

Mandatory or optional

schema_name

Y

table_name

N

policy_name

N

enable

N

Y: Can be omitted; N: Cannot be omitted

Return value

Return value

Description

TRUE

Ended normally

FALSE

Ended abnormally

Execution example

Enabling masking policy p1

postgres=# select pgx_enable_confidential_policy(table_name := 't1', policy_name := 'p1', enable := 't');
 pgx_enable_confidential_policy 
---------------------------------
 t
(1 row)

Description

The arguments for the pgx_enable_confidential_policy system management function can be specified in any order.

See

Refer to "String Constants" in the PostgreSQL Documentation for information on the strings to specify for arguments.