DbDataAdapter.UpdateBatchSize DbDataAdapter.UpdateBatchSize DbDataAdapter.UpdateBatchSize DbDataAdapter.UpdateBatchSize Property

Definition

Gets or sets a value that enables or disables batch processing support, and specifies the number of commands that can be executed in a batch.

public:
 virtual property int UpdateBatchSize { int get(); void set(int value); };
public virtual int UpdateBatchSize { get; set; }
member this.UpdateBatchSize : int with get, set
Public Overridable Property UpdateBatchSize As Integer

Property Value

The number of rows to process per batch.

Value is Effect
0 There is no limit on the batch size.
1 Disables batch updating.
> 1 Changes are sent using batches of UpdateBatchSize operations at a time.

When setting this to a value other than 1, all the commands associated with the DbDataAdapter must have their UpdatedRowSource property set to None or OutputParameters. An exception will be thrown otherwise.

Remarks

Use the UpdateBatchSize property to update a data source with changes from a DataSet. If the data provider supports batch processing, this can increase application performance by reducing the number of round-trips to the server. In ADO.NET 2.0, this property is supported for the .NET data providers for SQL Server (SqlClient) and Oracle (OracleClient).

Executing an extremely large batch could decrease performance. Therefore, you should test for the optimum batch size setting before implementing your application.

An ArgumentOutOfRangeException will be thrown if the value is set to a number less than zero.

Applies to

See also