Module org.jooq

Package org.jooq

Interface Batch

All Superinterfaces:

Flow.Publisher<Integer>, Publisher<Integer>, org.reactivestreams.Publisher<Integer>, Serializable

All Known Subinterfaces:

BatchBindStep

public interface Batch
extends Serializable, Publisher<Integer>

A wrapper for a JDBC batch operation. It has two modes:

1. Execute several queries without bind values

   
    create.batch(query1,
                 query2,
                 query3)
          .execute();
    

2. Execute one query several times with bind values

   
    create.batch(query)
          .bind(valueA1, valueA2)
          .bind(valueB1, valueB2)
          .execute();
    

Author:

Lukas Eder

See Also:

• Statement.executeBatch()

Method Summary

Modifier and Type	Method	Description
int @NotNull []	execute()	Execute the batch operation.
@NotNull CompletionStage<int[]>	executeAsync()	Execute the batch operation in a new CompletionStage.
@NotNull CompletionStage<int[]>	executeAsync(Executor executor)	Execute the query in a new CompletionStage that is asynchronously completed by a task running in the given executor.
long @NotNull []	executeLarge()	Execute the batch operation.
@NotNull CompletionStage<long[]>	executeLargeAsync()	Execute the batch operation in a new CompletionStage.
@NotNull CompletionStage<long[]>	executeLargeAsync(Executor executor)	Execute the query in a new CompletionStage that is asynchronously completed by a task running in the given executor.
@NotNull Publisher<Long>	largePublisher()	Turn this publisher into a Long returning publisher to support large update counts.
int	size()	Get the number of executed queries in this batch operation

Methods inherited from interface org.jooq.Publisher

subscribe

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Details

execute

@Blocking
int @NotNull [] execute()
                 throws DataAccessException

Execute the batch operation.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• Statement.executeBatch()

executeLarge

@Blocking
long @NotNull [] executeLarge()
                       throws DataAccessException

Execute the batch operation.

This is equivalent to execute(), except that it can fetch a larger update count if the underlying JDBC driver implements Statement.executeLargeBatch().

Throws:

DataAccessException - if something went wrong executing the query

See Also:

• Statement.executeLargeBatch()

executeAsync

@NotNull
@NotNull CompletionStage<int[]> executeAsync()

Execute the batch operation in a new CompletionStage.

The result is asynchronously completed by a task running in an Executor provided by the underlying Configuration.executorProvider().

See Also:

• Statement.executeBatch()

executeAsync

@NotNull
@NotNull CompletionStage<int[]> executeAsync(Executor executor)

Execute the query in a new CompletionStage that is asynchronously completed by a task running in the given executor.

executeLargeAsync

@NotNull
@NotNull CompletionStage<long[]> executeLargeAsync()

Execute the batch operation in a new CompletionStage.

This is equivalent to executeAsync(), except that it can fetch a larger update count if the underlying JDBC driver implements Statement.executeLargeBatch().

The result is asynchronously completed by a task running in an Executor provided by the underlying Configuration.executorProvider().

See Also:

• Statement.executeBatch()

executeLargeAsync

@NotNull
@NotNull CompletionStage<long[]> executeLargeAsync(Executor executor)

Execute the query in a new CompletionStage that is asynchronously completed by a task running in the given executor.

This is equivalent to executeAsync(Executor), except that it can fetch a larger update count if the underlying JDBC driver implements Statement.executeLargeBatch().

largePublisher

@NotNull
@NotNull Publisher<Long> largePublisher()

Turn this publisher into a Long returning publisher to support large update counts.

size

int size()

Get the number of executed queries in this batch operation