SqlDataReader Class

Definition

Namespace:

System.Data.SqlClient

Assembly:

System.Data.SqlClient.dll

Package:

System.Data.SqlClient v4.9.0

Source:

System.Data.SqlClient.notsupported.cs

Caution

Use the Microsoft.Data.SqlClient package instead.

Provides a way of reading a forward-only stream of rows from a SQL Server database. This class cannot be inherited.

public ref class SqlDataReader : System::Data::Common::DbDataReader, IDisposable, System::Data::Common::IDbColumnSchemaGenerator

[System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")]
public class SqlDataReader : System.Data.Common.DbDataReader, IDisposable, System.Data.Common.IDbColumnSchemaGenerator

[<System.Obsolete("Use the Microsoft.Data.SqlClient package instead.")>]
type SqlDataReader = class
    inherit DbDataReader
    interface IDbColumnSchemaGenerator
    interface IDisposable

Public Class SqlDataReader
Inherits DbDataReader
Implements IDbColumnSchemaGenerator, IDisposable

Inheritance

Object

DbDataReader

SqlDataReader

Attributes

ObsoleteAttribute

Implements

IDbColumnSchemaGenerator IDisposable

Examples

The following example creates a SqlConnection, a SqlCommand, and a SqlDataReader. The example reads through the data, writing it out to the console window. The code then closes the SqlDataReader. The SqlConnection is closed automatically at the end of the using code block.

private static void ReadOrderData(string connectionString)
{
    string queryString =
        "SELECT OrderID, CustomerID FROM dbo.Orders;";

    using (SqlConnection connection =
               new SqlConnection(connectionString))
    {
        SqlCommand command =
            new SqlCommand(queryString, connection);
        connection.Open();

        SqlDataReader reader = command.ExecuteReader();

        // Call Read before accessing data.
        while (reader.Read())
        {
            ReadSingleRow((IDataRecord)reader);
        }

        // Call Close when done reading.
        reader.Close();
    }
}

private static void ReadSingleRow(IDataRecord dataRecord)
{
    Console.WriteLine(String.Format("{0}, {1}", dataRecord[0], dataRecord[1]));
}

Private Sub ReadOrderData(ByVal connectionString As String)
    Dim queryString As String = _
        "SELECT OrderID, CustomerID FROM dbo.Orders;"

    Using connection As New SqlConnection(connectionString)
        Dim command As New SqlCommand(queryString, connection)
        connection.Open()

        Dim reader As SqlDataReader = command.ExecuteReader()

        ' Call Read before accessing data.
        While reader.Read()
            ReadSingleRow(CType(reader, IDataRecord))
        End While

        ' Call Close when done reading.
        reader.Close()
    End Using
End Sub

Private Sub ReadSingleRow(ByVal record As IDataRecord)
   Console.WriteLine(String.Format("{0}, {1}", record(0), record(1)))
End Sub

Remarks

To create a SqlDataReader, you must call the ExecuteReader method of the SqlCommand object, instead of directly using a constructor.

While the SqlDataReader is being used, the associated SqlConnection is busy serving the SqlDataReader, and no other operations can be performed on the SqlConnection other than closing it. This is the case until the Close method of the SqlDataReader is called. For example, you cannot retrieve output parameters until after you call Close.

Changes made to a result set by another process or thread while data is being read may be visible to the user of the SqlDataReader. However, the precise behavior is timing dependent.

IsClosed and RecordsAffected are the only properties that you can call after the SqlDataReader is closed. Although the RecordsAffected property may be accessed while the SqlDataReader exists, always call Close before returning the value of RecordsAffected to guarantee an accurate return value.

When using sequential access (CommandBehavior.SequentialAccess), an InvalidOperationException will be raised if the SqlDataReader position is advanced and another read operation is attempted on the previous column.

Note

For optimal performance, SqlDataReader avoids creating unnecessary objects or making unnecessary copies of data. Therefore, multiple calls to methods such as GetValue return a reference to the same object. Use caution if you are modifying the underlying value of the objects returned by methods such as GetValue.

Properties

Connection	Gets the SqlConnection associated with the SqlDataReader.
Depth	Gets a value that indicates the depth of nesting for the current row.
FieldCount	Gets the number of columns in the current row.
HasRows	Gets a value that indicates whether the SqlDataReader contains one or more rows.
IsClosed	Retrieves a Boolean value that indicates whether the specified SqlDataReader instance has been closed.
Item[Int32]	Gets the value of the specified column in its native format given the column ordinal.
Item[String]	Gets the value of the specified column in its native format given the column name.
RecordsAffected	Gets the number of rows changed, inserted, or deleted by execution of the Transact-SQL statement.
VisibleFieldCount	Gets the number of fields in the SqlDataReader that are not hidden.

Methods

Close()	Closes the DbDataReader object. (Inherited from DbDataReader)
CloseAsync()	Asynchronously closes the DbDataReader object. (Inherited from DbDataReader)
Dispose()	Releases all resources used by the current instance of the DbDataReader class. (Inherited from DbDataReader)
Dispose(Boolean)	Releases the unmanaged resources used by the DbDataReader and optionally releases the managed resources. (Inherited from DbDataReader)
DisposeAsync()	Asynchronously releases all resources used by the current instance of the DbDataReader class. (Inherited from DbDataReader)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBoolean(Int32)	Gets the value of the specified column as a Boolean.
GetByte(Int32)	Gets the value of the specified column as a byte.
GetBytes(Int32, Int64, Byte[], Int32, Int32)	Reads a stream of bytes from the specified column offset into the buffer an array starting at the given buffer offset.
GetChar(Int32)	Gets the value of the specified column as a single character.
GetChars(Int32, Int64, Char[], Int32, Int32)	Reads a stream of characters from the specified column offset into the buffer as an array starting at the given buffer offset.
GetColumnSchema()
GetColumnSchemaAsync(CancellationToken)	This is the asynchronous version of GetColumnSchema(DbDataReader). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetColumnSchema(DbDataReader) call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetColumnSchema(DbDataReader) will be communicated via the returned Task Exception property. (Inherited from DbDataReader)
GetData(Int32)	Returns a nested data reader for the requested column. (Inherited from DbDataReader)
GetDataTypeName(Int32)	Gets a string representing the data type of the specified column.
GetDateTime(Int32)	Gets the value of the specified column as a DateTime object.
GetDateTimeOffset(Int32)	Retrieves the value of the specified column as a DateTimeOffset object.
GetDbDataReader(Int32)	Returns a DbDataReader object for the requested column ordinal that can be overridden with a provider-specific implementation. (Inherited from DbDataReader)
GetDecimal(Int32)	Gets the value of the specified column as a Decimal object.
GetDouble(Int32)	Gets the value of the specified column as a double-precision floating point number.
GetEnumerator()	Returns an IEnumerator that iterates through the SqlDataReader.
GetFieldType(Int32)	Gets the Type that is the data type of the object.
GetFieldValue<T>(Int32)	Synchronously gets the value of the specified column as a type. GetFieldValueAsync<T>(Int32, CancellationToken) is the asynchronous version of this method.
GetFieldValueAsync<T>(Int32, CancellationToken)	Asynchronously gets the value of the specified column as a type. GetFieldValue<T>(Int32) is the synchronous version of this method.
GetFieldValueAsync<T>(Int32)	Asynchronously gets the value of the specified column as the requested type. (Inherited from DbDataReader)
GetFloat(Int32)	Gets the value of the specified column as a single-precision floating point number.
GetGuid(Int32)	Gets the value of the specified column as a globally unique identifier (GUID).
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetInt16(Int32)	Gets the value of the specified column as a 16-bit signed integer.
GetInt32(Int32)	Gets the value of the specified column as a 32-bit signed integer.
GetInt64(Int32)	Gets the value of the specified column as a 64-bit signed integer.
GetName(Int32)	Gets the name of the specified column.
GetOrdinal(String)	Gets the column ordinal, given the name of the column.
GetProviderSpecificFieldType(Int32)	Gets an Object that is a representation of the underlying provider-specific field type.
GetProviderSpecificValue(Int32)	Gets an Object that is a representation of the underlying provider specific value.
GetProviderSpecificValues(Object[])	Gets an array of objects that are a representation of the underlying provider specific values.
GetSchemaTable()	Returns a DataTable that describes the column metadata of the SqlDataReader.
GetSchemaTableAsync(CancellationToken)	This is the asynchronous version of GetSchemaTable(). Providers should override with an appropriate implementation. The cancellationToken can optionally be honored. The default implementation invokes the synchronous GetSchemaTable() call and returns a completed task. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by GetSchemaTable() will be communicated via the returned Task Exception property. (Inherited from DbDataReader)
GetSqlBinary(Int32)	Gets the value of the specified column as a SqlBinary.
GetSqlBoolean(Int32)	Gets the value of the specified column as a SqlBoolean.
GetSqlByte(Int32)	Gets the value of the specified column as a SqlByte.
GetSqlBytes(Int32)	Gets the value of the specified column as SqlBytes.
GetSqlChars(Int32)	Gets the value of the specified column as SqlChars.
GetSqlDateTime(Int32)	Gets the value of the specified column as a SqlDateTime.
GetSqlDecimal(Int32)	Gets the value of the specified column as a SqlDecimal.
GetSqlDouble(Int32)	Gets the value of the specified column as a SqlDouble.
GetSqlGuid(Int32)	Gets the value of the specified column as a SqlGuid.
GetSqlInt16(Int32)	Gets the value of the specified column as a SqlInt16.
GetSqlInt32(Int32)	Gets the value of the specified column as a SqlInt32.
GetSqlInt64(Int32)	Gets the value of the specified column as a SqlInt64.
GetSqlMoney(Int32)	Gets the value of the specified column as a SqlMoney.
GetSqlSingle(Int32)	Gets the value of the specified column as a SqlSingle.
GetSqlString(Int32)	Gets the value of the specified column as a SqlString.
GetSqlValue(Int32)	Returns the data value in the specified column as a SQL Server type.
GetSqlValues(Object[])	Fills an array of Object that contains the values for all the columns in the record, expressed as SQL Server types.
GetSqlXml(Int32)	Gets the value of the specified column as an XML value.
GetStream(Int32)	Retrieves binary, image, varbinary, UDT, and variant data types as a Stream.
GetString(Int32)	Gets the value of the specified column as a string.
GetTextReader(Int32)	Retrieves Char, NChar, NText, NVarChar, text, varChar, and Variant data types as a TextReader.
GetTimeSpan(Int32)	Retrieves the value of the specified column as a TimeSpan object.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(Int32)	Gets the value of the specified column in its native format.
GetValues(Object[])	Populates an array of objects with the column values of the current row.
GetXmlReader(Int32)	Retrieves data of type XML as an XmlReader.
IsCommandBehavior(CommandBehavior)	Determines whether the specified CommandBehavior matches that of the SqlDataReader .
IsDBNull(Int32)	Gets a value that indicates whether the column contains non-existent or missing values.
IsDBNullAsync(Int32, CancellationToken)	An asynchronous version of IsDBNull(Int32), which gets a value that indicates whether the column contains non-existent or missing values. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
IsDBNullAsync(Int32)	Asynchronously gets a value that indicates whether the column contains non-existent or missing values. (Inherited from DbDataReader)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
NextResult()	Advances the data reader to the next result, when reading the results of batch Transact-SQL statements.
NextResultAsync()	Asynchronously advances the reader to the next result when reading the results of a batch of statements. (Inherited from DbDataReader)
NextResultAsync(CancellationToken)	An asynchronous version of NextResult(), which advances the data reader to the next result, when reading the results of batch Transact-SQL statements. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
Read()	Advances the SqlDataReader to the next record.
ReadAsync()	Asynchronously advances the reader to the next record in a result set. (Inherited from DbDataReader)
ReadAsync(CancellationToken)	An asynchronous version of Read(), which advances the SqlDataReader to the next record. The cancellation token can be used to request that the operation be abandoned before the command timeout elapses. Exceptions will be reported via the returned Task object.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

See also

• DataAdapters and DataReaders
• SQL Server and ADO.NET
• ADO.NET Overview