EntityDataReader Class

 

Reads a forward-only stream of rows from a data source.

Namespace:   System.Data.EntityClient
Assembly:  System.Data.Entity (in System.Data.Entity.dll)

System.Object
  System.MarshalByRefObject
    System.Data.Common.DbDataReader
      System.Data.EntityClient.EntityDataReader

public class EntityDataReader : DbDataReader, IExtendedDataRecord, 
	IDataRecord

NameDescription
System_CAPS_pubpropertyDataRecordInfo
System_CAPS_pubpropertyDepth

Gets a value indicating the depth of nesting for the current row.(Overrides DbDataReader.Depth.)

System_CAPS_pubpropertyFieldCount

Gets the number of columns in the current row.(Overrides DbDataReader.FieldCount.)

System_CAPS_pubpropertyHasRows

Gets a value that indicates whether this EntityDataReader contains one or more rows.(Overrides DbDataReader.HasRows.)

System_CAPS_pubpropertyIsClosed

Gets a value indicating whether the EntityDataReader is closed.(Overrides DbDataReader.IsClosed.)

System_CAPS_pubpropertyItem[Int32]

Gets the value of the specified column as an instance of Object.(Overrides DbDataReader.Item[Int32].)

System_CAPS_pubpropertyItem[String]

Gets the value of the specified column as an instance of Object.(Overrides DbDataReader.Item[String].)

System_CAPS_pubpropertyRecordsAffected

Gets the number of rows changed, inserted, or deleted by execution of the SQL statement.(Overrides DbDataReader.RecordsAffected.)

System_CAPS_pubpropertyVisibleFieldCount

Gets the number of fields in the EntityDataReader that are not hidden.(Overrides DbDataReader.VisibleFieldCount.)

NameDescription
System_CAPS_pubmethodClose()

Closes the EntityDataReader object.(Overrides DbDataReader.Close().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the current instance of the DbDataReader class.(Inherited from DbDataReader.)

System_CAPS_protmethodDispose(Boolean)

Releases the resources consumed by this EntityDataReader and calls Close.(Overrides DbDataReader.Dispose(Boolean).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetBoolean(Int32)

Gets the value of the specified column as a Boolean.(Overrides DbDataReader.GetBoolean(Int32).)

System_CAPS_pubmethodGetByte(Int32)

Gets the value of the specified column as a byte.(Overrides DbDataReader.GetByte(Int32).)

System_CAPS_pubmethodGetBytes(Int32, Int64, Byte[], Int32, Int32)

Reads a stream of bytes from the specified column, starting at location indicated by dataIndex, into the buffer, starting at the location indicated by bufferIndex.(Overrides DbDataReader.GetBytes(Int32, Int64, Byte[], Int32, Int32).)

System_CAPS_pubmethodGetChar(Int32)

Gets the value of the specified column as a single character.(Overrides DbDataReader.GetChar(Int32).)

System_CAPS_pubmethodGetChars(Int32, Int64, Char[], Int32, Int32)

Reads a stream of characters from the specified column, starting at location indicated by dataIndex, into the buffer, starting at the location indicated by bufferIndex.(Overrides DbDataReader.GetChars(Int32, Int64, Char[], Int32, Int32).)

System_CAPS_pubmethodGetData(Int32)

Returns a DbDataReader object for the requested column ordinal.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetDataReader(Int32)

Returns nested readers as DbDataReader objects.

System_CAPS_pubmethodGetDataRecord(Int32)

Returns a nested DbDataRecord.

System_CAPS_pubmethodGetDataTypeName(Int32)

Gets the name of the data type of the specified column.(Overrides DbDataReader.GetDataTypeName(Int32).)

System_CAPS_pubmethodGetDateTime(Int32)

Gets the value of the specified column as a DateTime object.(Overrides DbDataReader.GetDateTime(Int32).)

System_CAPS_protmethodGetDbDataReader(Int32)

Returns a DbDataReader object for the requested column ordinal that can be overridden with a provider-specific implementation.(Overrides DbDataReader.GetDbDataReader(Int32).)

System_CAPS_pubmethodGetDecimal(Int32)

Gets the value of the specified column as a Decimal object.(Overrides DbDataReader.GetDecimal(Int32).)

System_CAPS_pubmethodGetDouble(Int32)

Gets the value of the specified column as a double-precision floating point number.(Overrides DbDataReader.GetDouble(Int32).)

System_CAPS_pubmethodGetEnumerator()

Returns an IEnumerator that can be used to iterate through the rows in the data reader.(Overrides DbDataReader.GetEnumerator().)

System_CAPS_pubmethodGetFieldType(Int32)

Gets the data type of the specified column.(Overrides DbDataReader.GetFieldType(Int32).)

System_CAPS_pubmethodGetFieldValue<T>(Int32)

Synchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFieldValueAsync<T>(Int32)

Asynchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFieldValueAsync<T>(Int32, CancellationToken)

Asynchronously gets the value of the specified column as a type.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetFloat(Int32)

Gets the value of the specified column as a single-precision floating point number.(Overrides DbDataReader.GetFloat(Int32).)

System_CAPS_pubmethodGetGuid(Int32)

Gets the value of the specified column as a globally-unique identifier (GUID).(Overrides DbDataReader.GetGuid(Int32).)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetInt16(Int32)

Gets the value of the specified column as a 16-bit signed integer.(Overrides DbDataReader.GetInt16(Int32).)

System_CAPS_pubmethodGetInt32(Int32)

Gets the value of the specified column as a 32-bit signed integer.(Overrides DbDataReader.GetInt32(Int32).)

System_CAPS_pubmethodGetInt64(Int32)

Gets the value of the specified column as a 64-bit signed integer.(Overrides DbDataReader.GetInt64(Int32).)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetName(Int32)

Gets the name of the column, given the zero-based column ordinal.(Overrides DbDataReader.GetName(Int32).)

System_CAPS_pubmethodGetOrdinal(String)

Gets the column ordinal given the name of the column.(Overrides DbDataReader.GetOrdinal(String).)

System_CAPS_pubmethodGetProviderSpecificFieldType(Int32)

Returns the provider-specific field type of the specified column.(Overrides DbDataReader.GetProviderSpecificFieldType(Int32).)

System_CAPS_pubmethodGetProviderSpecificValue(Int32)

Gets the value of the specified column as an instance of Object.(Overrides DbDataReader.GetProviderSpecificValue(Int32).)

System_CAPS_pubmethodGetProviderSpecificValues(Object[])

Gets all provider-specific attribute columns in the collection for the current row.(Overrides DbDataReader.GetProviderSpecificValues(Object[]).)

System_CAPS_pubmethodGetSchemaTable()

Returns a DataTable that describes the column metadata of the DbDataReader.(Overrides DbDataReader.GetSchemaTable().)

System_CAPS_pubmethodGetStream(Int32)

Retrieves data as a Stream.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetString(Int32)

Gets the value of the specified column as an instance of String.(Overrides DbDataReader.GetString(Int32).)

System_CAPS_pubmethodGetTextReader(Int32)

Retrieves data as a TextReader.(Inherited from DbDataReader.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(Int32)

Gets the value of the specified column as an instance of Object.(Overrides DbDataReader.GetValue(Int32).)

System_CAPS_pubmethodGetValues(Object[])

Populates an array of objects with the column values of the current row.(Overrides DbDataReader.GetValues(Object[]).)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodIsDBNull(Int32)

Gets a value that indicates whether the column contains nonexistent or missing values.(Overrides DbDataReader.IsDBNull(Int32).)

System_CAPS_pubmethodIsDBNullAsync(Int32)

An asynchronous version of IsDBNull, which gets a value that indicates whether the column contains non-existent or missing values.(Inherited from DbDataReader.)

System_CAPS_pubmethodIsDBNullAsync(Int32, CancellationToken)

An asynchronous version of IsDBNull, which gets a value that indicates whether the column contains non-existent or missing values. Optionally, sends a notification that operations should be cancelled.(Inherited from DbDataReader.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodNextResult()

Advances the reader to the next result when reading the results of a batch of statements.(Overrides DbDataReader.NextResult().)

System_CAPS_pubmethodNextResultAsync()

An asynchronous version of NextResult, which advances the reader to the next result when reading the results of a batch of statements.

Invokes NextResultAsync with CancellationToken.None.(Inherited from DbDataReader.)

System_CAPS_pubmethodNextResultAsync(CancellationToken)

This is the asynchronous version of NextResult. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

The default implementation invokes the synchronous NextResult method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by NextResult will be communicated via the returned Task Exception property.

Other methods and properties of the DbDataReader object should not be invoked while the returned Task is not yet completed.(Inherited from DbDataReader.)

System_CAPS_pubmethodRead()

Advances the reader to the next record in a result set.(Overrides DbDataReader.Read().)

System_CAPS_pubmethodReadAsync()

An asynchronous version of Read, which advances the reader to the next record in a result set. This method invokes ReadAsync with CancellationToken.None.(Inherited from DbDataReader.)

System_CAPS_pubmethodReadAsync(CancellationToken)

This is the asynchronous version of Read. Providers should override with an appropriate implementation. The cancellationToken may optionally be ignored.

The default implementation invokes the synchronous Read method and returns a completed task, blocking the calling thread. The default implementation will return a cancelled task if passed an already cancelled cancellationToken. Exceptions thrown by Read will be communicated via the returned Task Exception property.

Do not invoke other methods and properties of the DbDataReader object until the returned Task is complete.(Inherited from DbDataReader.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIDataRecord.GetData(Int32)

For a description of this member, see IDataRecord.GetData.(Inherited from DbDataReader.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

Combines the functionality of the DbDataReader class and the IExtendedDataRecord interface.

An EntityDataReader has no public constructor. It can only be obtained through one of the EntityCommand.ExecuteReader method overloads.

SQL Server puts output parameters from stored procedures at the end of the result stream, after all the result sets. Therefore, to get output parameter values, an application must consume all the records in all the result sets. If the application closes the EntityDataReader (which would also close the DbDataReader), output parameters might not be populated.

EntityDataReader does not implicitly consume result sets to make output parameters available. Therefore, note the following:

For code examples, see Working with EntityClient.

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: