Share via


ICatalogOperations.PreviewTableWithHttpMessagesAsync Method

Definition

Retrieves a preview set of rows in given table.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Analytics.Models.USqlTablePreview>> PreviewTableWithHttpMessagesAsync(string accountName, string databaseName, string schemaName, string tableName, long? maxRows = default, long? maxColumns = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PreviewTableWithHttpMessagesAsync : string * string * string * string * Nullable<int64> * Nullable<int64> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DataLake.Analytics.Models.USqlTablePreview>>
Public Function PreviewTableWithHttpMessagesAsync (accountName As String, databaseName As String, schemaName As String, tableName As String, Optional maxRows As Nullable(Of Long) = Nothing, Optional maxColumns As Nullable(Of Long) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of USqlTablePreview))

Parameters

accountName
System.String

The Azure Data Lake Analytics account upon which to execute catalog operations.

databaseName
System.String

The name of the database containing the table.

schemaName
System.String

The name of the schema containing the table.

tableName
System.String

The name of the table.

maxRows
System.Nullable<System.Int64>

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.

maxColumns
System.Nullable<System.Int64>

The maximum number of columns to be retrieved.

customHeaders
System.Collections.Generic.Dictionary<System.String,System.Collections.Generic.List<System.String>>

The headers that will be added to request.

cancellationToken
System.Threading.CancellationToken

The cancellation token.

Returns

System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<USqlTablePreview>>

Exceptions

Microsoft.Rest.Azure.CloudException

Thrown when the operation returned an invalid status code

Microsoft.Rest.SerializationException

Thrown when unable to deserialize the response

Microsoft.Rest.ValidationException

Thrown when a required parameter is null

Applies to