SqlDataAdapter.UpdateBatchSize Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the number of rows that are processed in each round-trip to the server.
public:
virtual property int UpdateBatchSize { int get(); void set(int value); };
public override int UpdateBatchSize { get; set; }
member this.UpdateBatchSize : int with get, set
Public Overrides 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 SqlDataAdapter have to have their UpdatedRowSource property set to None
or OutputParameters
. An exception is thrown otherwise.
Remarks
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.
Use the UpdateBatchSize property to update a data source with changes from a DataSet. This can increase application performance by reducing the number of round-trips to the server.
Executing an extremely large batch could decrease performance. Therefore, you should test for the optimum batch size setting before implementing your application.
An ArgumentOutOfRangeException is thrown if the value is set to a number less than zero.