SqlBulkCopy.EnableStreaming Property

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Enables or disables a SqlBulkCopy object to stream data from an IDataReader object

public:
 property bool EnableStreaming { bool get(); void set(bool value); };

public bool EnableStreaming { get; set; }

member this.EnableStreaming : bool with get, set

Public Property EnableStreaming As Boolean

Property Value

Boolean

true if a SqlBulkCopy object can stream data from an IDataReader object; otherwise, false. The default is false .

Remarks

When EnableStreaming is true, SqlBulkCopy reads from an IDataReader object using SequentialAccess, optimizing memory usage by using the IDataReader streaming capabilities. Streaming is only applicable to max data types (i.e. VARBINARY(MAX), VARCHAR(MAX), NVARCHAR(MAX), and XML). When EnableStreaming is set to false, the SqlBulkCopy class loads all the data returned by the IDataReader object into memory before sending it to the server.

Note

The main advantage of enabling streaming is reducing memory usage during bulk copy of max data types.