All Products
Search
Document Center

PolarDB:ST_SetUpdatePyramidRules

Last Updated:Mar 28, 2026

Configures the update rules applied when ST_UpdatePyramid runs on a vector table.

Syntax

boolean ST_SetUpdatePyramidRules(cstring table, cstring geom_field, cstring rules);

Parameters

ParameterDescription
tableThe name of the vector table.
geom_fieldThe name of the column with the Geometry attribute in the vector table.
rulesThe update rules in JSON format. The updateBoxScale and updateExtentSRS keys control how the update operation runs. For details, see ST_UpdatePyramid.

Return value

Returns true if the rules are set successfully.

Examples

SELECT ST_SetupdatePyramidRules('test_update_line', 'geom', '{"updateBoxScale":100000}');
st_setupdatepyramidrules
--------------------------
t
(1 row)