📣
TiDB Cloud Premium is now in public preview. Unlimited growth, instant elasticity, advanced security for enterprise workloads. Try it out →

Table Functions



This page provides reference information for the table functions in TiDB Cloud Lake. Table functions return a set of rows (similar to a table) and can be used in the FROM clause of a query.

Data Schema & File Inspection

FunctionDescriptionExample
INFER_SCHEMADetects file metadata schema and retrieves column definitionsSELECT * FROM INFER_SCHEMA(LOCATION => '@mystage/data/')
INSPECT_PARQUETInspects the structure of Parquet filesSELECT * FROM INSPECT_PARQUET(LOCATION => '@mystage/data.parquet')

Stage & Query Management

FunctionDescriptionExample
LIST_STAGELists files in a stageSELECT * FROM LIST_STAGE(LOCATION => '@mystage/data/')
RESULT_SCANRetrieves the result set of a previous querySELECT * FROM RESULT_SCAN(LAST_QUERY_ID())

Data Generation

FunctionDescriptionExample
GENERATE_SERIESGenerates a sequence of valuesSELECT * FROM GENERATE_SERIES(1, 10, 2)

Data Transformation & Expansion

FunctionDescriptionExample
FLATTENTransforms nested JSON or array data into tabular formatSELECT * FROM FLATTEN(INPUT => parse_json('[1,2,3]'))

System Information & Management

FunctionDescriptionExample
SHOW_GRANTSShows granted privilegesSELECT * FROM SHOW_GRANTS()
SHOW_VARIABLESShows system variablesSELECT * FROM SHOW_VARIABLES()
STREAM_STATUSShows stream status informationSELECT * FROM STREAM_STATUS('mystream')
TASK_HISTROYShows task execution historySELECT * FROM TASK_HISTROY('mytask')
POLICY_REFERENCESReturns associations between security policies and tables/viewsSELECT * FROM POLICY_REFERENCES(POLICY_NAME => 'mypolicy')
TAG_REFERENCESReturns tags assigned to a database objectSELECT * FROM TAG_REFERENCES('mydb.mytable', 'TABLE')

Storage Engine Functions

FunctionDescriptionExample
FUSE_VACUUM_TEMPORARY_TABLECleans up temporary tablesSELECT * FROM FUSE_VACUUM_TEMPORARY_TABLE()
FUSE_AMENDManages data amendmentsSELECT * FROM FUSE_AMEND()

Iceberg Integration

FunctionDescriptionExample
ICEBERG_MANIFESTShows Iceberg table manifest informationSELECT * FROM ICEBERG_MANIFEST('mytable')
ICEBERG_SNAPSHOTShows Iceberg table snapshot informationSELECT * FROM ICEBERG_SNAPSHOT('mytable')

Anonymization

FunctionDescriptionExample
OBFUSCATEdataset anonymizationSELECT * FROM OBFUSCATE(users)

Was this page helpful?