OleDbConnection.GetSchema Method

Definition

Namespace:

System.Data.OleDb

Assembly:

System.Data.OleDb.dll

Package:

System.Data.OleDb v9.0.0-rc.2.24473.5

Returns schema information for the data source of this OleDbConnection.

Overloads

GetSchema()	Returns schema information for the data source of this OleDbConnection.
GetSchema(String)	Returns schema information for the data source of this OleDbConnection using the specified string for the schema name.
GetSchema(String, String[])	Returns schema information for the data source of this OleDbConnection using the specified string for the schema name and the specified string array for the restriction values.

GetSchema()

Source:

DbConnectionHelper.cs

Returns schema information for the data source of this OleDbConnection.

public:
 override System::Data::DataTable ^ GetSchema();

public override System.Data.DataTable GetSchema ();

override this.GetSchema : unit -> System.Data.DataTable

Public Overrides Function GetSchema () As DataTable

Returns

DataTable

A DataTable that contains schema information.

See also

• Obtaining Schema Information from a Database

GetSchema(String)

Source:

DbConnectionHelper.cs

Returns schema information for the data source of this OleDbConnection using the specified string for the schema name.

public:
 override System::Data::DataTable ^ GetSchema(System::String ^ collectionName);

public override System.Data.DataTable GetSchema (string collectionName);

override this.GetSchema : string -> System.Data.DataTable

Public Overrides Function GetSchema (collectionName As String) As DataTable

Parameters

collectionName

String

Specifies the name of the schema to return.

Returns

DataTable

A DataTable that contains schema information.

Remarks

When collectionName is specified as null, the DataTable will contain information about all the metadata that is available, and its restrictions.

See also

• Obtaining Schema Information from a Database

GetSchema(String, String[])

Source:

DbConnectionHelper.cs

Returns schema information for the data source of this OleDbConnection using the specified string for the schema name and the specified string array for the restriction values.

public:
 override System::Data::DataTable ^ GetSchema(System::String ^ collectionName, cli::array <System::String ^> ^ restrictionValues);

public override System.Data.DataTable GetSchema (string collectionName, string?[]? restrictionValues);

override this.GetSchema : string * string[] -> System.Data.DataTable

Public Overrides Function GetSchema (collectionName As String, restrictionValues As String()) As DataTable

Parameters

collectionName

String

Specifies the name of the schema to return.

restrictionValues

String[]

Specifies a set of restriction values for the requested schema.

Returns

DataTable

A DataTable that contains schema information.

Remarks

When collectionName is specified as null, the DataTable will contain information about all the metadata that is available, and its restrictions.

The restrictionValues parameter can supply n depth of values which are specified by the restrictions collection for a specific collection. In order to set values on a given restriction, and not set the values of other restrictions, you need to set the preceding restrictions to null and then put the appropriate value in for the restriction that you would like to specify a value for.

An example of this is the "Tables" collection. If the "Tables" collection has three restrictions (database, owner, and table name), and you want to get back only the tables associated with the owner "Carl," you must pass in the following values (at a minimum): null, "Carl". If a restriction value is not passed in, the default values are used for that restriction. This is the same mapping as passing in null, which is different from passing in an empty string for the parameter value. In that case, the empty string ("") is considered to be the value for the specified parameter.

See also

• Obtaining Schema Information from a Database