DbDataAdapter.UpdateBatchSize Property
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 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, setPublic Overridable Property UpdateBatchSize As IntegerThe 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.
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.
| Product | Versions |
|---|---|
| .NET | Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 2.0, 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: