C1.PivotEngine.C1PivotEngine.GetMetadataCube

GetMetadataCube Method

GetMetadataCube(string, string, CancellationToken)

Lists fields with their metadata for a SQL Server Analysis Service (SSAS) cube.

Declaration

public static Task<Dictionary<string, object>> GetMetadataCube(string connection, string cubeName, CancellationToken cancelToken)

Parameters

Type	Name	Description
string	connection	SSAS connection string.
string	cubeName	Cube name.
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

Only one metadata part is supported (multiple parts are allowed here for consistency with GetMetadata methods for DataEngine tables and DataSource, and for future extensions):

"fields": IList collection containing field information, objects with following properties:

Name (string): field name by which it is known to the client.

UniqueName (string): name identifying the field in the cube.

DimensionType (enum): one of the following enum values defining the role of the field in the cube: Dimension = 0, Measure = 1, Kpi = 2, Attribute = 4, Folder = 5, Hierarchy = 6.

SubFields (IList): Collection of metadata objects for child fields.