All Products
Search
Document Center

PolarDB:ST_TileOption

Last Updated:Mar 28, 2026

Returns the tile configuration options of an sfmesh object as a JSON string.

Syntax

cstring ST_TileOption(sfmesh sfmesh);

Parameters

ParameterDescription
sfmeshThe sfmesh object to query.

Return value

A JSON string containing the following fields. Set these values in advance using ST_SetTileOption.

FieldDescription
with_geometryWhether geometry objects are included in the tile. true includes geometry objects; false excludes them.
with_submeshWhether child sfmesh objects are included in the tile. true includes child sfmesh objects; false excludes them.
{
  "with_geometry": true,
  "with_submesh": true
}

Examples

The following example queries the tile options of the the_mesh column (type sfmesh) from t_table.

SELECT ST_TileOption(the_mesh)
FROM t_table;

Output:

-------------------
{"with_geometry":true,"with_submesh":true}