SqlConnection.GetSchema Method (String, String[])

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Data.SqlClient
Assembly:  System.Data (in System.Data.dll)

override GetSchema : 
        collectionName:string *
        restrictionValues:string[] -> DataTable

Parameters

collectionName
Type: System.String

Specifies the name of the schema to return.

restrictionValues
Type: System.String[]

A set of restriction values for the requested schema.

Return Value

Type: System.Data.DataTable

A DataTable that contains schema information.

Exception Condition
ArgumentException

collectionName is specified as null.

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 need to pass in 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.

For a code sample demonstrating GetSchema, see GetSchema.

.NET Framework
Available since 2.0
Return to top
Show: