Export (0) Print
Expand All

DbConnection.GetSchema Method (String, String[])

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

Namespace: System.Data.Common
Assembly: System.Data (in system.data.dll)

public:
virtual DataTable^ GetSchema (
	String^ collectionName, 
	array<String^>^ restrictionValues
)
public DataTable GetSchema (
	String collectionName, 
	String[] restrictionValues
)
public function GetSchema (
	collectionName : String, 
	restrictionValues : String[]
) : DataTable
Not applicable.

Parameters

collectionName

Specifies the name of the schema to return.

restrictionValues

Specifies a set of restriction values for the requested schema.

Return Value

A DataTable that contains schema information.

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 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 least: 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.

If the connection is associated with a transaction, executing GetSchema calls may cause some providers to throw an exception.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

.NET Compact Framework

Supported in: 2.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft