v9

latestSwagger 2.0raw.githubusercontent.com2019-09-114553151.8 KB
Catalog

Retrieves a preview set of rows in given table.

get/catalog/usql/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/previewrows

Path parameters

databaseNamestring required

The name of the database containing the table.

schemaNamestring required

The name of the schema containing the table.

tableNamestring required

The name of the table.

Query parameters

maxRowsinteger

The maximum number of preview rows to be retrieved. Rows returned may be less than or equal to this number depending on row sizes and number of rows in the table.

maxColumnsinteger

The maximum number of columns to be retrieved.

api-versionstring required

Client Api Version.

Response

Successfully retrieved preview rows for the specified table.

totalRowCountinteger

the total number of rows in the table or partition.

totalColumnCountinteger

the total number of columns in the table or partition.

truncatedboolean

true if the amount of data in the response is less than expected due to the preview operation's size limitations. This can occur if the requested rows or row counts are too large.