OdbcConnection.GetSchema Method

Definition

Returns schema information for the data source of this OdbcConnection.

Overloads

GetSchema()

Returns schema information for the data source of this OdbcConnection.

GetSchema(String)

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

GetSchema(String, String[])

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

GetSchema()

Returns schema information for the data source of this OdbcConnection.

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

A DataTable that contains schema information.

See also

GetSchema(String)

Returns schema information for the data source of this OdbcConnection using the specified name 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

A DataTable that contains schema information.

Remarks

When collectionName is null, the DataTable contains information about all available metadata and any restrictions.

Note

All restrictions that apply to the SQLStatistics method also apply to the ODBCConnection.GetSchema("indexes") collection.

See also

GetSchema(String, String[])

Returns schema information for the data source of this OdbcConnection 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

A DataTable that contains schema information.

Remarks

When collectionName is specified as null, the DataTable contains 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 must 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," then you would need to pass in at least the following values: 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.

Note

All restrictions that apply to SQLStatistics method will apply to the ODBCConnection.GetSchema("indexes") collection.

See also

Applies to