Package org.springframework.r2dbc.core

Interface DatabaseClient.GenericExecuteSpec

Enclosing interface:
DatabaseClient
public static interface DatabaseClient.GenericExecuteSpec
Contract for specifying an SQL call along with options leading to the execution.

  • Method Details

    • bind

      DatabaseClient.GenericExecuteSpec bind(int index, Object value)
      Bind a non-null value to a parameter identified by its index.
      Parameters:
      index - zero based index to bind the parameter to
      value - either a scalar value or a Parameter

    • bindNull

      DatabaseClient.GenericExecuteSpec bindNull(int index, Class<?> type)
      Bind a null value to a parameter identified by its index.
      Parameters:
      index - zero based index to bind the parameter to
      type - the parameter type

    • bind

      DatabaseClient.GenericExecuteSpec bind(String name, Object value)
      Bind a non-null value to a parameter identified by its name.
      Parameters:
      name - the name of the parameter
      value - either a scalar value or a Parameter

    • bindNull

      DatabaseClient.GenericExecuteSpec bindNull(String name, Class<?> type)
      Bind a null value to a parameter identified by its name.
      Parameters:
      name - the name of the parameter
      type - the parameter type

    • bindValues

      DatabaseClient.GenericExecuteSpec bindValues(Map<String,?> source)
      Bind the parameter values from the given source map, registering each as a parameter with the map key as name.
      Parameters:
      source - the source map of parameters, with keys as names and each value either a scalar value or a Parameter
      Since:
      6.1
      See Also:

    • bindProperties

      DatabaseClient.GenericExecuteSpec bindProperties(Object source)
      Bind the bean properties or record components from the given source object, registering each as a named parameter.
      Parameters:
      source - the source object (a JavaBean or record)
      Since:
      6.1
      See Also:

    • filter

      default DatabaseClient.GenericExecuteSpec filter(Function<? super Statement,? extends Statement> filterFunction)
      Add the given filter to the end of the filter chain.

      Filter functions are typically used to invoke methods on the Statement before it is executed. For example: 

       DatabaseClient client = …;
 client.sql("SELECT book_id FROM book").filter(statement -> statement.fetchSize(100))
      Parameters:
      filterFunction - the filter to be added to the chain

    • filter

      DatabaseClient.GenericExecuteSpec filter(StatementFilterFunction filter)
      Add the given filter to the end of the filter chain.

      Filter functions are typically used to invoke methods on the Statement before it is executed. For example: 

       DatabaseClient client = …;
 client.sql("SELECT book_id FROM book").filter((statement, next) -> next.execute(statement.fetchSize(100)))
      Parameters:
      filter - the filter to be added to the chain

    • map

      <R> RowsFetchSpec<R> map(Function<? super Readable,R> mappingFunction)
      Configure a result mapping function and enter the execution stage.
      Type Parameters:
      R - the result type
      Parameters:
      mappingFunction - a function that maps from Readable to the result type
      Returns:
      a RowsFetchSpec for configuration what to fetch
      Since:
      6.0

    • map

      <R> RowsFetchSpec<R> map(BiFunction<Row,RowMetadata,R> mappingFunction)
      Configure a result mapping function and enter the execution stage.
      Type Parameters:
      R - the result type
      Parameters:
      mappingFunction - a function that maps from Row and RowMetadata to the result type
      Returns:
      a RowsFetchSpec for configuration what to fetch

    • mapValue

      <R> RowsFetchSpec<R> mapValue(Class<R> mappedClass)
      Configure a mapping for values in the first column and enter the execution stage.
      Type Parameters:
      R - the result type
      Parameters:
      mappedClass - the target class (a database-supported value class)
      Returns:
      a RowsFetchSpec for configuration what to fetch
      Since:
      6.1
      See Also:

    • mapProperties

      <R> RowsFetchSpec<R> mapProperties(Class<R> mappedClass)
      Configure a row mapper for the given mapped class and enter the execution stage.
      Type Parameters:
      R - the result type
      Parameters:
      mappedClass - the target class (a JavaBean or record) with properties to map to (bean properties or record components)
      Returns:
      a RowsFetchSpec for configuration what to fetch
      Since:
      6.1
      See Also:

    • flatMap

      <R> reactor.core.publisher.Flux<R> flatMap(Function<Result,Publisher<R>> mappingFunction)
      Perform the SQL call and apply function to the Result.
      Type Parameters:
      R - the result type
      Parameters:
      mappingFunction - a function that maps from Result into a result publisher
      Returns:
      a Flux that emits mapped elements
      Since:
      6.0
      See Also:

    • fetch

      FetchSpec<Map<String,Object>> fetch()
      Perform the SQL call and retrieve the result by entering the execution stage.

    • then

      reactor.core.publisher.Mono<Void> then()
      Perform the SQL call and return a Mono that completes without result on statement completion.
      Returns:
      a Mono ignoring its payload (actively dropping)