CatalogOperationsExtensions.PreviewTableAsync Method

Definition

Namespace:

Microsoft.Azure.Management.DataLake.Analytics

Assembly:

Microsoft.Azure.Management.DataLake.Analytics.dll

Package:

Microsoft.Azure.Management.DataLake.Analytics v3.5.3-preview

Retrieves a preview set of rows in given table.

public static System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Analytics.Models.USqlTablePreview> PreviewTableAsync (this Microsoft.Azure.Management.DataLake.Analytics.ICatalogOperations operations, string accountName, string databaseName, string schemaName, string tableName, long? maxRows = default, long? maxColumns = default, System.Threading.CancellationToken cancellationToken = default);

static member PreviewTableAsync : Microsoft.Azure.Management.DataLake.Analytics.ICatalogOperations * string * string * string * string * Nullable<int64> * Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Management.DataLake.Analytics.Models.USqlTablePreview>

<Extension()>
Public Function PreviewTableAsync (operations As ICatalogOperations, 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 cancellationToken As CancellationToken = Nothing) As Task(Of USqlTablePreview)

Parameters

operations

ICatalogOperations

The operations group for this extension method.

accountName

String

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

databaseName

String

The name of the database containing the table.

schemaName

String

The name of the schema containing the table.

tableName

String

The name of the table.

maxRows

Nullable<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

Nullable<Int64>

The maximum number of columns to be retrieved.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<USqlTablePreview>