Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.catalog.table_shape_stats(tenant_connector_tap_id=None, limit=None, offset=None)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
query := &namespaces.CatalogTableShapeStatsQueryParams{}
result, err := sdk.CatalogNamespace.TableShapeStats(ctx, query){
"data": {
"stats": [
{
"capturedAt": "2023-11-07T05:31:56Z",
"columnCount": 0,
"columns": [
{
"arrowType": "<string>",
"columnName": "<string>",
"nonNullCount": 0,
"nullPct": 123,
"validationFailureCount": 0,
"validationFailurePct": 123,
"avg": 123,
"distinctCount": 0,
"maxValue": "<string>",
"minValue": "<string>",
"parableScalar": "<string>",
"q25": 123,
"q50": 123,
"q75": 123,
"std": 123
}
],
"distinctCountsExact": true,
"rowCount": 0,
"runDate": "2023-12-25",
"runId": "<string>",
"snapshotId": "<string>",
"storageUri": "<string>",
"loadType": "<string>",
"sampledRowCount": 0,
"tapContractId": "<string>",
"totalByteSize": 0
}
],
"statsVersion": "<string>",
"tenantId": "<string>",
"nextOffset": 123
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Read table shapes
Returns the most recent snapshot of the columns of each table in this Workspace’s catalog, with their distributions, a page at a time. tenantConnectorTapId keeps only the tables of that Tap. A page holds at most limit snapshots: 20 by default, 100 at most. It stops before 40,000 characters of snapshots, but it always holds one. To read the next page, send nextOffset as offset. The last page has no nextOffset.
GET
/
api
/
catalog
/
table-shape-stats
Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.catalog.table_shape_stats(tenant_connector_tap_id=None, limit=None, offset=None)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
query := &namespaces.CatalogTableShapeStatsQueryParams{}
result, err := sdk.CatalogNamespace.TableShapeStats(ctx, query){
"data": {
"stats": [
{
"capturedAt": "2023-11-07T05:31:56Z",
"columnCount": 0,
"columns": [
{
"arrowType": "<string>",
"columnName": "<string>",
"nonNullCount": 0,
"nullPct": 123,
"validationFailureCount": 0,
"validationFailurePct": 123,
"avg": 123,
"distinctCount": 0,
"maxValue": "<string>",
"minValue": "<string>",
"parableScalar": "<string>",
"q25": 123,
"q50": 123,
"q75": 123,
"std": 123
}
],
"distinctCountsExact": true,
"rowCount": 0,
"runDate": "2023-12-25",
"runId": "<string>",
"snapshotId": "<string>",
"storageUri": "<string>",
"loadType": "<string>",
"sampledRowCount": 0,
"tapContractId": "<string>",
"totalByteSize": 0
}
],
"statsVersion": "<string>",
"tenantId": "<string>",
"nextOffset": 123
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Access
An MCP token or a Parable token can call this operation. See Authentication for the kinds of token. Your roles must granttenant.data.catalog.
Errors
WA-TN-001: No Workspace context was supplied. Call from a Workspace context.HTTP 400: limit is not from 1 to 100, or offset is less than 0. Send a limit from 1 to 100 and an offset of 0 or more, such as the nextOffset of the page before.