DbDataAdapter.FillSchema Method (DataSet, SchemaType)
Assembly: System.Data (in System.Data.dll)
Public Overrides Function FillSchema ( dataSet As DataSet, schemaType As SchemaType ) As DataTable()
Return ValueType: System.Data.DataTable()
This method retrieves the schema information from the data source using the SelectCommand.
A FillSchema operation adds a DataTable to the destination DataSet. It then adds columns to the DataColumnCollection of the DataTable, and configures the following DataColumn properties if they exist at the data source:
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 UniqueConstraint is added to the 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 ConstraintCollection according to the preceding rules, but other constraint types are not added.
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 Query Hint (Transact-SQL).
If the IDataAdapter encounters duplicate columns while populating a 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 DataSet according to the pattern "Column1", "Column2", and so on. When multiple result sets are added to the 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.
The IDbConnection object associated with the select command must be valid, but it does not need to open. If the IDbConnection is closed before FillSchema is called, it is opened to retrieve data, then closed. If the connection is open before FillSchema is called, it is left open.
When handling batch SQL statements that return multiple results, the implementation of FillSchema 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 Fill with the MissingSchemaAction set to AddWithKey.
When using FillSchema, 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.
Private Function GetCustomerData(ByVal dataSetName As String, _ ByVal connectionString As String) As DataSet Dim dataSet As DataSet = New DataSet(dataSetName) Using connection As SqlConnection = New SqlConnection(connectionString) Dim adapter As SqlDataAdapter = New SqlDataAdapter( _ "SELECT CustomerID, CompanyName, ContactName FROM dbo.Customers", _ connection) Dim mapping As DataTableMapping = adapter.TableMappings.Add( _ "Table", "Customers") mapping.ColumnMappings.Add("CompanyName", "Name") mapping.ColumnMappings.Add("ContactName", "Contact") connection.Open() adapter.FillSchema(dataSet, SchemaType.Mapped) adapter.Fill(dataSet) Return dataSet End Using End Function
Available since 1.1