DbConnection.GetSchema Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns schema information for the data source of this DbConnection.
GetSchema() |
Returns schema information for the data source of this DbConnection. |
GetSchema(String) |
Returns schema information for the data source of this DbConnection using the specified string for the schema name. |
GetSchema(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. |
If the connection is associated with a transaction, executing GetSchema
calls may cause some providers to throw an exception.
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
Returns schema information for the data source of this DbConnection.
public:
virtual System::Data::DataTable ^ GetSchema();
public virtual System.Data.DataTable GetSchema ();
abstract member GetSchema : unit -> System.Data.DataTable
override this.GetSchema : unit -> System.Data.DataTable
Public Overridable Function GetSchema () As DataTable
Returns
A DataTable that contains schema information.
Remarks
If the connection is associated with a transaction, executing GetSchema
calls may cause some providers to throw an exception.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
Returns schema information for the data source of this DbConnection using the specified string for the schema name.
public:
virtual System::Data::DataTable ^ GetSchema(System::String ^ collectionName);
public virtual System.Data.DataTable GetSchema (string collectionName);
abstract member GetSchema : string -> System.Data.DataTable
override this.GetSchema : string -> System.Data.DataTable
Public Overridable 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.
Exceptions
collectionName
is specified as null.
Remarks
If the connection is associated with a transaction, executing GetSchema
calls may cause some providers to throw an exception.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
- Source:
- DbConnection.cs
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.
public:
virtual System::Data::DataTable ^ GetSchema(System::String ^ collectionName, cli::array <System::String ^> ^ restrictionValues);
public virtual System.Data.DataTable GetSchema (string collectionName, string?[] restrictionValues);
public virtual System.Data.DataTable GetSchema (string collectionName, string[] restrictionValues);
abstract member GetSchema : string * string[] -> System.Data.DataTable
override this.GetSchema : string * string[] -> System.Data.DataTable
Public Overridable 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.
Exceptions
collectionName
is specified as null.
Remarks
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.
See also
Applies to
.NET 9 and other versions
Product | Versions |
---|---|
.NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: