[]
DEMOS DOCS API SAMPLES DOWNLOAD
(Showing Draft Content)

C1.PivotEngine.C1PivotEngine.GetMetadata

GetMetadata Method

GetMetadata(string, string, CancellationToken)

Lists fields with their types and provides other metadata for a DataEngine table.

Declaration
public static Task<Dictionary<string, object>> GetMetadata(string workspace, string table, CancellationToken cancelToken)
Public Shared Function GetMetadata(workspace As String, table As String, cancelToken As CancellationToken) As Task(Of Dictionary(Of String, Object))
Parameters
Type Name Description
string workspace

Path in the server's file system where DataEngine data is saved in files.
string table

The name of a DataEngine table.
CancellationToken cancelToken

Enables task cancellation.
Returns
Type Description
Task<Dictionary<string, object>>

Dictionary containing key/value pairs for metadata parts, where key is the name of the part.
Remarks

Currently supported metadata parts are:

"fields": IList collection containing field information, objects with properties Name (string) and Type (System.Type)

"rowCount": Number of rows in the DataEngine table

GetMetadata(IEnumerable, CancellationToken)

Lists fields with their types and provides other metadata for a data source.

Declaration
public static Task<Dictionary<string, object>> GetMetadata(IEnumerable dataSource, CancellationToken cancelToken)
Public Shared Function GetMetadata(dataSource As IEnumerable, cancelToken As CancellationToken) As Task(Of Dictionary(Of String, Object))
Parameters
Type Name Description
IEnumerable dataSource

Data source collection.
CancellationToken cancelToken

Enables task cancellation.
Returns
Type Description
Task<Dictionary<string, object>>

Dictionary containing key/value pairs for metadata parts, where key is the name of the part.
Remarks

Currently supported metadata parts are:

"fields": IList collection containing field information, objects with properties Name (string) and Type (System.Type)

"rowCount": Number of rows in the data source