All Products
Search

This Product

    PolarDB:ST_UserData

    Document Center

    PolarDB:ST_UserData

    Last Updated:Mar 28, 2026

    Returns the user-defined string stored on an sfmesh object.

    Syntax

    cstring ST_UserData(sfmesh sfmeshObject);

    Parameters

    ParameterDescription
    sfmeshObjectThe sfmesh object to query.

    Description

    ST_UserData retrieves the user-defined string (cstring) attached to an sfmesh object. The function returns the value previously set on the object by ST_SetUserData.

    Call ST_SetUserData to attach data to an sfmesh object before calling ST_UserData.

    Examples

    The following example retrieves the label previously set on a mesh object.

    SELECT ST_UserData(ST_SetUserDat(the_mesh, 'mesh_name'))
FROM t_table;

-------------------
mesh_name

    See also