Skip to main content
POST
Run a function over a sample of an Iceberg table

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

workspace
string
required

Workspace slug.

Maximum string length: 64
Pattern: ^[a-z0-9][a-z0-9-]{0,63}$
name
string
required

Function name — a Python identifier.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]{0,63}$

Body

application/json
table
string
required

catalog.schema.table to sample, read as you.

Pattern: ^[A-Za-z0-9_]+\.[A-Za-z0-9_]+\.[A-Za-z0-9_]+$
version
integer | null
spec
Spec · object | null
columns
Columns · object

Which table column feeds each column parameter (scalar/aggregate) or input column (table). Unmapped names are read from a column of the same name.

args
Args · object

The const arguments.

limit
integer
default:50
Required range: 1 <= x <= 1000

Response

Successful Response

workspace
string
required
name
string
required
table
string
required
rows
Rows · object[]

The sampled input rows.

result
any
result_type
string | null
error
string | null
truncated
boolean
default:false

A table function's output was cut at 500 rows.

spark_version
string | null