Class AdomdDataProvider

Multi-dimensional data provider that uses ADOMD for .NET to connect and retrieve data from the multi-dimensional data source.

Inheritance

System.Object

AdomdDataProvider

Implements

IDataProvider

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Olap.DataProvider

Assembly: Syncfusion.Olap.Base.dll

Syntax

public class AdomdDataProvider : IDataProvider, IDisposable

Constructors

AdomdDataProvider(String)

Initializes a new instance of the AdomdDataProvider class.

Declaration

public AdomdDataProvider(string connectionString)

Parameters

Type	Name	Description
System.String	connectionString	The connection string.

Properties

CatalogName

Gets the name of the database.

Declaration

public string CatalogName { get; }

Property Value

Type	Description
System.String	The name of the catalog.

ConnectionString

Gets or sets the connection string for the data adapter;

Declaration

public string ConnectionString { get; set; }

Property Value

Type
System.String

CurrentCellSet

Gets the current cell set.

Declaration

public CellSet CurrentCellSet { get; }

Property Value

Type	Description
CellSet	The current cell set.

GetAllCubes

Gets all the cubes in the specified data source.

Declaration

public CubeInfoCollection GetAllCubes { get; }

Property Value

Type	Description
CubeInfoCollection	All the available cubes.

GetCubes

Gets the collection of cubes in the specified data source.

Declaration

public CubeInfoCollection GetCubes { get; }

Property Value

Type	Description
CubeInfoCollection	The collection of cubes.

IsNonSSASData

Gets or sets a value indicating whether this instance is non SSAS data.

Declaration

[Obsolete("Please use ProviderName property.")]
public bool IsNonSSASData { get; set; }

Property Value

Type
System.Boolean

IsPropertyAppended

Gets or sets a value indicating whether this instance is property appended.

Declaration

public bool IsPropertyAppended { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is property appended; otherwise, false.

ProviderName

Gets or sets the name of the provider.

Declaration

public Providers ProviderName { get; set; }

Property Value

Type	Description
Providers	The name of the provider.

Methods

CloseConnection()

Closes the connection.

Declaration

public void CloseConnection()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Execute(String, OlapReport)

Executes the specified command text.

Declaration

public virtual object Execute(string commandText, OlapReport olapReport)

Parameters

Type	Name	Description
System.String	commandText	The MDX query.
OlapReport	olapReport	The OLAP report.

Returns

Type	Description
System.Object	An object.

Execute(String, Boolean)

Executes the specified command text.

Declaration

public virtual object Execute(string commandText, bool returnResult)

Parameters

Type	Name	Description
System.String	commandText	The MDX query.
System.Boolean	returnResult	Indicates whether to return the result.

Returns

Type	Description
System.Object	An object.

ExecuteCellSet(String, Boolean, Boolean, OlapReport)

Executes the specified command text and returns a cell set.

Declaration

public virtual CellSet ExecuteCellSet(string mdxQuery, bool IsGrandTotalOn, bool isQuery, OlapReport currentReport)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.
System.Boolean	IsGrandTotalOn	Indicates whether the grand total is included.
System.Boolean	isQuery	Indicates whether it is MDX query.
OlapReport	currentReport	The current report.

Returns

Type	Description
CellSet	The cell set.

ExecuteCount(String)

Executes the count for specified MDX query.

Declaration

public virtual int[] ExecuteCount(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Int32[]	An array of integers.

ExecuteDrillThroughQuery(String)

Executes the drill-through query.

Declaration

public DataTable ExecuteDrillThroughQuery(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Data.DataTable	The data table that matches the query.

ExecuteMemberCount(String)

Executes the count for specified MDX query.

Declaration

public virtual int ExecuteMemberCount(string mdxQuery)

Parameters

Type	Name	Description
System.String	mdxQuery	The MDX query.

Returns

Type	Description
System.Int32	An array of integers.

GetAdomdCellSet()

Gets adomd cellset.

Declaration

public virtual CellSet GetAdomdCellSet()

Returns

Type	Description
Microsoft.AnalysisServices.AdomdClient.CellSet	The adomd cellset.

GetAllMemberUniqueName(String, String)

Gets the unique name of all member based on the hierarchy.

Declaration

public string GetAllMemberUniqueName(string cubeName, string hierarchyUniqueName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.
System.String	hierarchyUniqueName	The unique name of the hierarchy.

Returns

Type	Description
System.String	The unique name of all member.

GetCell(CellSet, Int32[])

Gets the cell.

Declaration

public virtual Cell GetCell(CellSet cellSet, params int[] indexes)

Parameters

Type	Name	Description
CellSet	cellSet	The cell set.
System.Int32[]	indexes	The array of indexes.

Returns

Type	Description
Cell	A cell object.

GetChildMembers(Member, Boolean)

Gets the collection of child members.

Declaration

public MemberCollection GetChildMembers(Member member, bool IsGrandTotalOn)

Parameters

Type	Name	Description
Member	member	The member.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.

Returns

Type	Description
MemberCollection	The collection of child members.

GetChildMembers(String, String, Boolean)

Gets the collection of members.

Declaration

public MemberCollection GetChildMembers(string memberUniqueName, string cubeName, bool IsGrandTotalOn)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member.
System.String	cubeName	The name of the cube.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.

Returns

Type	Description
MemberCollection	The collection of child members.

GetChildrenByMDX(String)

Gets the collection of child members.

Declaration

public MemberCollection GetChildrenByMDX(string commandText)

Parameters

Type	Name	Description
System.String	commandText	The MDX query.

Returns

Type	Description
MemberCollection	The collection of child members.

GetCubeSchema(String)

Gets the cube schema.

Declaration

public CubeSchema GetCubeSchema(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.

Returns

Type	Description
CubeSchema	An object of cube schema.

GetLevelMembers(Level)

Gets the collection of level members.

Declaration

public MemberCollection GetLevelMembers(Level level)

Parameters

Type	Name	Description
Level	level	The level.

Returns

Type	Description
MemberCollection	The collection of level members.

GetLevelMembers(String, String)

Gets the collection of level members.

Declaration

public MemberCollection GetLevelMembers(string levelUniqueName, string cubeName)

Parameters

Type	Name	Description
System.String	levelUniqueName	The unique name of the level.
System.String	cubeName	The name of the cube

Returns

Type	Description
MemberCollection	The collection of level members.

GetLevelMembersUsingMDX(String, Int32, Boolean, String)

Gets the collection of members using MDX query.

Declaration

public MemberCollection GetLevelMembersUsingMDX(string memberUniqueName, int memberAxisPosition, bool IsGrandTotalOn, string pageParams)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member.
System.Int32	memberAxisPosition	The axis position of the member.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.
System.String	pageParams	Holds paging infomation.

Returns

Type	Description
MemberCollection	The collection of members.

GetLevelMembersUsingMDX(String, Int32, Boolean, String, String)

Gets the collection of members using MDX query.

Declaration

public MemberCollection GetLevelMembersUsingMDX(string memberUniqueName, int memberAxisPosition, bool IsGrandTotalOn, string cubeName, string pageParams)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member.
System.Int32	memberAxisPosition	The axis position of the member.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.
System.String	cubeName	The name of the cube.
System.String	pageParams	Holds paging infomation.

Returns

Type	Description
MemberCollection	The collection of members.

GetMeasureGroupDimensions(String, String)

Gets the dimensions in the specified measure group.

Declaration

public List<string> GetMeasureGroupDimensions(string cubeName, string measureGroupName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.
System.String	measureGroupName	The name of the measure group.

Returns

Type	Description
System.Collections.Generic.List<System.String>	The list of dimensions.

GetMeasureGroups(String)

Gets the measure groups.

Declaration

public List<object> GetMeasureGroups(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.

Returns

Type	Description
System.Collections.Generic.List<System.Object>	The list of measure groups.

GetMeasuresDimensionUniqueName(String)

Gets the unique name of the measures dimension.

Declaration

public string GetMeasuresDimensionUniqueName(string cubeName)

Parameters

Type	Name	Description
System.String	cubeName	The name of the cube.

Returns

Type	Description
System.String	The unique name of the measures dimension.

GetMembersUsingMDX(String, Int32, Int32, Boolean, NodeTypes)

Gets the collection of members using MDX query.

Declaration

public MemberCollection GetMembersUsingMDX(string memberUniqueName, int memberAxisPosition, int memberHierarhcyPosition, bool IsGrandTotalOn, NodeTypes memberType)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member.
System.Int32	memberAxisPosition	The axis position of the member.
System.Int32	memberHierarhcyPosition	The position of the member hierarchy.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.
NodeTypes	memberType	Type of the member.

Returns

Type	Description
MemberCollection	The collection of members.

GetMembersUsingMDX(String, Int32, Int32, Boolean, NodeTypes, String)

Gets the collection of members using MDX query.

Declaration

public MemberCollection GetMembersUsingMDX(string memberUniqueName, int memberAxisPosition, int memberHierarhcyPosition, bool IsGrandTotalOn, NodeTypes memberType, string cubeName)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member.
System.Int32	memberAxisPosition	The axis position of the member.
System.Int32	memberHierarhcyPosition	The position of the member hierarchy.
System.Boolean	IsGrandTotalOn	Indicates whether to include the grand total.
NodeTypes	memberType	Type of the member.
System.String	cubeName	The name of the cube.

Returns

Type	Description
MemberCollection	The collection of members.

GetParentMember(Member)

Gets the parent member.

Declaration

public Member GetParentMember(Member member)

Parameters

Type	Name	Description
Member	member	The child member.

Returns

Type	Description
Member	The member object.

GetParentMemberUsingMDX(String, String)

Gets the parent member via Mdx query.

Declaration

public Member GetParentMemberUsingMDX(string memberUniqueName, string currentCube)

Parameters

Type	Name	Description
System.String	memberUniqueName	The unique name of the member whose parent is ton be retrieved.
System.String	currentCube	The current cube name.

Returns

Type	Description
Member	The parent member.

HasValidCells()

Determines whether the ADOMD cell set has valid cells.

Declaration

public bool HasValidCells()

Returns

Type
System.Boolean

ValidateConnectionString()

Validates the connection string.

Declaration

public bool ValidateConnectionString()

Returns

Type	Description
System.Boolean	true if the connection string has proper syntax

Events

OnMDXQueryExceptionHandler

Occurs when the exception is thrown while executing the MDX query.

Declaration

public event OnMDXQueryExceptionEventHandler OnMDXQueryExceptionHandler

Event Type

Type
OnMDXQueryExceptionEventHandler

Implements

IDataProvider

System.IDisposable