Configures the schema of the specified System.Data.DataTable based on the specified System.Data.SchemaType.
Syntax
Parameters
- dataTable
- schemaType
Returns
A System.Data.DataTable that contains schema information returned from the data source.
Remarks
The DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) method retrieves the schema from the data source using the System.Data.IDbDataAdapter.SelectCommand. The connection object associated with the System.Data.IDbDataAdapter.SelectCommand must be valid, but it does not need to be open. If the connection is closed before DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) is called, it is opened to retrieve data, then closed. If the connection is open before DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) is called, it remains open.
A DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) operation returns a System.Data.DataTable. It then adds columns to the System.Data.DataColumnCollection of the System.Data.DataTable, and configures the following System.Data.DataColumn properties if they exist at the data source:
System.Data.DataColumn.AutoIncrement. You must set System.Data.DataColumn.AutoIncrementStep and System.Data.DataColumn.AutoIncrementSeed separately.
DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) also configures the System.Data.DataTable.PrimaryKey and System.Data.DataTable.Constraints properties according to the following rules:
If a System.Data.DataTable.PrimaryKey has already been defined for the DataTable, or the DataTable contains data, the PrimaryKey property will not be set.
If one or more primary key columns are returned by the System.Data.IDbDataAdapter.SelectCommand, they are used as the primary key columns for the DataTable.
If no primary key columns are returned but unique columns are, the unique columns are used as the primary key if, and only if, all the unique columns are nonnullable. If any of the columns are nullable, a System.Data.UniqueConstraint is added to the System.Data.ConstraintCollection, but the PrimaryKey property is not set.
If both primary key columns and unique columns are returned, the primary key columns are used as the primary key columns for the DataTable.
Note that primary keys and unique constraints are added to the System.Data.ConstraintCollection according to the preceding rules, but other constraint types are not added. This process may require several round-trips to the server.
If a unique clustered index is defined on a column or columns in a SQL Server table and the primary key constraint is defined on a separate set of columns, then the names of the columns in the clustered index will be returned. To return the name or names of the primary key columns, use a query hint with the SELECT statement that specifies the name of the primary key index. For more information about specifying query hints, see tp://msdn.microsoft.com/library/ms181714.aspx.
If the System.Data.Common.DbDataAdapter encounters duplicate columns while populating a System.Data.DataTable, it generates names for the subsequent columns, using the pattern "columnname1", "columnname2", "columnname3", and so on. If the incoming data contains unnamed columns, they are placed in the System.Data.DataSet according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the System.Data.DataSet each result set is placed in a separate table. Additional result sets are named by appending integral values to the specified table name (for example, "Table", "Table1", "Table2", and so on.). Applications using column and table names should ensure that conflicts with these naming patterns does not occur.
DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) does not return any rows. Use the DbDataAdapter.Fill(System.Data.DataSet) method to add rows to a System.Data.DataTable.
When handling batch SQL statements that return multiple results, the implementation of DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType) for the .NET Framework Data Provider for OLE DB retrieves schema information for only the first result. To retrieve schema information for multiple results, use DbDataAdapter.Fill(System.Data.DataSet) with the System.Data.MissingSchemaAction set to AddWithKey.
When using DbDataAdapter.FillSchema(System.Data.DataTable, System.Data.SchemaType), the .NET Framework Data Provider for SQL Server appends a FOR BROWSE clause to the statement being executed. The user should be aware of potential side effects, such as interference with the use of SET FMTONLY ON statements. See SQL Server Books Online for more information.
Requirements
Assembly: System.Data (in System.Data.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0