Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface GetTableObjectsRequest

Hierarchy

Properties

CatalogId? DatabaseName MaxResults? NextToken? PartitionPredicate? QueryAsOfTime? TableName TransactionId?

Properties

Optional CatalogId

CatalogId?: string

The catalog containing the governed table. Defaults to the caller’s account.

DatabaseName

DatabaseName: undefined | string

The database containing the governed table.

Optional MaxResults

MaxResults?: number

Specifies how many values to return in a page.

Optional NextToken

NextToken?: string

A continuation token if this is not the first call to retrieve these objects.

Optional PartitionPredicate

PartitionPredicate?: string

A predicate to filter the objects returned based on the partition keys defined in the governed table.

  • The comparison operators supported are: =, >, <, >=, <=

  • The logical operators supported are: AND

  • The data types supported are integer, long, date(yyyy-MM-dd), timestamp(yyyy-MM-dd HH:mm:ssXXX or yyyy-MM-dd HH:mm:ss"), string and decimal.

Optional QueryAsOfTime

QueryAsOfTime?: Date

The time as of when to read the governed table contents. If not set, the most recent transaction commit time is used. Cannot be specified along with TransactionId.

TableName

TableName: undefined | string

The governed table for which to retrieve objects.

Optional TransactionId

TransactionId?: string

The transaction ID at which to read the governed table contents. If this transaction has aborted, an error is returned. If not set, defaults to the most recent committed transaction. Cannot be specified along with QueryAsOfTime.

Settings

Member Visibility

Theme