AdomdConnection.GetSchemaDataSet AdomdConnection.GetSchemaDataSet AdomdConnection.GetSchemaDataSet Method

Definition

Returns schema information from a data source

Overloads

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally, throwing an exception when inline errors occur as well as setting properties for the underlying XMLA Discover command.

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally throwing an exception when inline errors occur.

GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, and by applying any specified restrictions to the information.

GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean)

Returns schema information from a data source by using a Guid object to identify the information, applying any specified restrictions on the information, and optionally throwing an exception when inline errors occur.

GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name to identify which schema to retrieve and by applying any specified restrictions to the information.

GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[])

Returns schema information from a data source by using a Guid object to specify which schema information to return and by applying any specified restrictions to the information.

GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name to identify the information, applying any specified restrictions to the information, and optionally throwing an exception when inline errors occur.

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean, AdomdPropertyCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally, throwing an exception when inline errors occur as well as setting properties for the underlying XMLA Discover command.

public:
 System::Data::DataSet ^ GetSchemaDataSet(System::String ^ schemaName, System::String ^ schemaNamespace, Microsoft::AnalysisServices::AdomdClient::AdomdRestrictionCollection ^ restrictions, bool throwOnInlineErrors, Microsoft::AnalysisServices::AdomdClient::AdomdPropertyCollection ^ requestProperties);
public System.Data.DataSet GetSchemaDataSet (string schemaName, string schemaNamespace, Microsoft.AnalysisServices.AdomdClient.AdomdRestrictionCollection restrictions, bool throwOnInlineErrors, Microsoft.AnalysisServices.AdomdClient.AdomdPropertyCollection requestProperties);
Public Function GetSchemaDataSet (schemaName As String, schemaNamespace As String, restrictions As AdomdRestrictionCollection, throwOnInlineErrors As Boolean, requestProperties As AdomdPropertyCollection) As DataSet
Parameters
schemaName
String String String

The name of the schema to be retrieved.

schemaNamespace
String String String

The name of the schema namespace to be retrieved.

restrictions
AdomdRestrictionCollection AdomdRestrictionCollection AdomdRestrictionCollection

A collection of AdomdRestriction objects that specifies the values for the restriction columns used by the schema table.

throwOnInlineErrors
Boolean Boolean Boolean

If true, inline errors cause an exception to be thrown; otherwise DataRow.GetColumnError is used to determine the error generated.

requestProperties
AdomdPropertyCollection AdomdPropertyCollection AdomdPropertyCollection

A collection of AdomdProperty objects that specifies the values for the underlying XMLA Discover command.

Returns

A DataSet that represents the contents of the specified OLE DB schema table.

GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name and namespace to identify the information, applying any specified restrictions to the information, and, optionally throwing an exception when inline errors occur.

public:
 System::Data::DataSet ^ GetSchemaDataSet(System::String ^ schemaName, System::String ^ schemaNamespace, Microsoft::AnalysisServices::AdomdClient::AdomdRestrictionCollection ^ restrictions, bool throwOnInlineErrors);
public System.Data.DataSet GetSchemaDataSet (string schemaName, string schemaNamespace, Microsoft.AnalysisServices.AdomdClient.AdomdRestrictionCollection restrictions, bool throwOnInlineErrors);
Public Function GetSchemaDataSet (schemaName As String, schemaNamespace As String, restrictions As AdomdRestrictionCollection, throwOnInlineErrors As Boolean) As DataSet
Parameters
schemaName
String String String

The name of the schema to be retrieved.

schemaNamespace
String String String

The name of the schema namespace to be retrieved.

restrictions
AdomdRestrictionCollection AdomdRestrictionCollection AdomdRestrictionCollection

A collection of AdomdRestriction objects that specifies the values for the restriction columns used by the schema table.

throwOnInlineErrors
Boolean Boolean Boolean

If true, inline errors cause an exception to be thrown; otherwise DataRow.GetColumnError is used to determine the error generated.

Returns

A DataSet that represents the contents of the specified OLE DB schema table.

Remarks

If throwOnInlineErrors is true, this method behaves identically to GetSchemaDataSet. If throwOnInlineErrors is false, and errors occur while retrieving schema information, the resulting DataSet may contain null cells that would not normally be null. To determine the details of the errors that occur, you can use the DataRow.GetColumnsInError, DataRow.GetColumnError, DataRow.HasErrors, DataSet.HasErrors, and DataTable.HasErrors methods and properties.

GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection) GetSchemaDataSet(String, String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name and namespace to identify the information, and by applying any specified restrictions to the information.

public:
 System::Data::DataSet ^ GetSchemaDataSet(System::String ^ schemaName, System::String ^ schemaNamespace, Microsoft::AnalysisServices::AdomdClient::AdomdRestrictionCollection ^ restrictions);
public System.Data.DataSet GetSchemaDataSet (string schemaName, string schemaNamespace, Microsoft.AnalysisServices.AdomdClient.AdomdRestrictionCollection restrictions);
Public Function GetSchemaDataSet (schemaName As String, schemaNamespace As String, restrictions As AdomdRestrictionCollection) As DataSet
Parameters
schemaName
String String String

The name of the schema to be retrieved.

schemaNamespace
String String String
restrictions
AdomdRestrictionCollection AdomdRestrictionCollection AdomdRestrictionCollection

A collection of AdomdRestriction objects that specifies the values for the restriction columns that the schema table uses.

Returns

A DataSet that represents the contents of the specified OLE DB schema table.

Remarks

The schema table is returned as a DataSet that has the same format as the OLE DB schema rowset specified by the schemaName parameter. Use the restrictions parameter to filter the rows to be returned in the DataSet. (For example, you can specify restrictions for table name, type, owner, or schema.)

Note

If the schema contains nested rowsets, more tables may be returned in the DataSet.

GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean) GetSchemaDataSet(Guid, Object[], Boolean)

Returns schema information from a data source by using a Guid object to identify the information, applying any specified restrictions on the information, and optionally throwing an exception when inline errors occur.

public:
 System::Data::DataSet ^ GetSchemaDataSet(Guid schema, cli::array <System::Object ^> ^ restrictions, bool throwOnInlineErrors);
public System.Data.DataSet GetSchemaDataSet (Guid schema, object[] restrictions, bool throwOnInlineErrors);
Public Function GetSchemaDataSet (schema As Guid, restrictions As Object(), throwOnInlineErrors As Boolean) As DataSet
Parameters
schema
Guid Guid Guid

A Guid object that specifies the schema table to be returned.

restrictions
Object[]

An array of Object objects that specifies the values for the restriction columns that are used by the schema table. These values are applied in the order of the restriction columns. That is, the first restriction value applies to the first restriction column, the second restriction value applies to the second restriction column, and so on.

throwOnInlineErrors
Boolean Boolean Boolean

If true, inline errors cause an exception to be thrown; otherwise DataRow.GetColumnError is used to determine the error generated.

Returns

A DataSet that represents the contents of the specified OLE DB schema rowset.

Remarks

If throwOnInlineErrors is true, this method behaves identically to [GetSchemaDataSet Method (Guid, Object<xref:Microsoft.AnalysisServices.AdomdClient.AdomdConnection.GetSchemaDataSet%2A>.If throwOnInlineErrors is false, and there are errors that occur while retrieving schema information, the resulting DataSet may contain null cells that would not normally be null. To determine the details of the errors that occur, you can use the DataRow.GetColumnsInError, DataRow.GetColumnError, DataRow.HasErrors, DataSet.HasErrors, and DataTable.HasErrors methods and properties.

GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection) GetSchemaDataSet(String, AdomdRestrictionCollection)

Returns schema information from a data source by using a schema name to identify which schema to retrieve and by applying any specified restrictions to the information.

public:
 System::Data::DataSet ^ GetSchemaDataSet(System::String ^ schemaName, Microsoft::AnalysisServices::AdomdClient::AdomdRestrictionCollection ^ restrictions);
public System.Data.DataSet GetSchemaDataSet (string schemaName, Microsoft.AnalysisServices.AdomdClient.AdomdRestrictionCollection restrictions);
Public Function GetSchemaDataSet (schemaName As String, restrictions As AdomdRestrictionCollection) As DataSet
Parameters
schemaName
String String String

The name of the schema to be retrieved.

restrictions
AdomdRestrictionCollection AdomdRestrictionCollection AdomdRestrictionCollection

A collection of AdomdRestriction objects that specifies the values for the restriction columns used by the schema table.

Returns

A DataSet that represents the contents of the specified OLE DB schema table.

Remarks

The schema table is returned as a DataSet that has the same format as the OLE DB schema rowset specified by the schemaName parameter. Use the restrictions parameter to filter the rows to be returned in the DataSet. (For example, you can specify cube name and dimension name restrictions for the dimensions schema.)

Note

If the schema contains nested rowsets, more tables may be returned in the DataSet.

GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[]) GetSchemaDataSet(Guid, Object[])

Returns schema information from a data source by using a Guid object to specify which schema information to return and by applying any specified restrictions to the information.

public:
 System::Data::DataSet ^ GetSchemaDataSet(Guid schema, cli::array <System::Object ^> ^ restrictions);
public System.Data.DataSet GetSchemaDataSet (Guid schema, object[] restrictions);
Public Function GetSchemaDataSet (schema As Guid, restrictions As Object()) As DataSet
Parameters
schema
Guid Guid Guid

A Guid object that specifies the schema table to be returned.

restrictions
Object[]

An array of Object objects that specifies the values for the restriction columns that the schema table uses. These values are applied in the order of the restriction columns. That is, the first restriction value applies to the first restriction column, the second restriction value applies to the second restriction column, and so on.

Returns

A DataSet that represents the contents of the specified OLE DB schema rowset.

Remarks

The schema rowset is returned as a DataSet that has the same format as the OLE DB schema rowset specified by the schema parameter. Use the restrictions parameter to filter the rows to be returned in the DataSet. (For example, you can specify restrictions for table name, type, owner, or schema). When you pass values in the array, include empty strings or nulls for array elements that do not contain values. If you pass an empty array to restrictions, all rows are returned in default order. Values in the array correspond to the order of the columns in the OLE DB or OLE DB for OLAP specifications.

If a Guid is provided that is not associated with a schema rowset, or if the schema rowset associated with the provided Guid is not supported by the server, the InvalidOperationException exception is thrown. Similarly, an exception is thrown if an error occurs while retrieving the schema rowset from the provider.

The AdomdSchemaGuid contains a collection of Guid objects that represents the most commonly supported OLE DB and XML for Analysis schema rowsets.

Note

If the schema contains nested rowsets, more tables may be returned in the DataSet.

GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean) GetSchemaDataSet(String, AdomdRestrictionCollection, Boolean)

Returns schema information from a data source by using a schema name to identify the information, applying any specified restrictions to the information, and optionally throwing an exception when inline errors occur.

public:
 System::Data::DataSet ^ GetSchemaDataSet(System::String ^ schemaName, Microsoft::AnalysisServices::AdomdClient::AdomdRestrictionCollection ^ restrictions, bool throwOnInlineErrors);
public System.Data.DataSet GetSchemaDataSet (string schemaName, Microsoft.AnalysisServices.AdomdClient.AdomdRestrictionCollection restrictions, bool throwOnInlineErrors);
Public Function GetSchemaDataSet (schemaName As String, restrictions As AdomdRestrictionCollection, throwOnInlineErrors As Boolean) As DataSet
Parameters
schemaName
String String String

The name of the schema to be retrieved.

restrictions
AdomdRestrictionCollection AdomdRestrictionCollection AdomdRestrictionCollection

A collection of AdomdRestriction objects that specifies the values for the restriction columns that the schema table uses.

throwOnInlineErrors
Boolean Boolean Boolean

If true, inline errors cause an exception to be thrown; otherwise, DataRow.GetColumnError is used to determine the error generated.

Returns

A DataSet that represents the contents of the specified OLE DB schema table.

Remarks

If throwOnInlineErrors is true, this method behaves identically to GetSchemaDataSet. If throwOnInlineErrors is false, and there are errors that occur while retrieving schema information, the resulting DataSet may contain null cells that would not normally be null. To determine the details of the errors that occur, you can use the DataRow.GetColumnsInError, DataRow.GetColumnError, DataRow.HasErrors, DataSet.HasErrors, and DataTable.HasErrors methods and properties.

Applies to