QueryExecutionInfoFormatter (Reactive Relational Database Connectivity

java.lang.Object
- io.r2dbc.proxy.support.QueryExecutionInfoFormatter

All Implemented Interfaces:: Function<QueryExecutionInfo,String>

public class QueryExecutionInfoFormatter
extends Object
implements Function<QueryExecutionInfo,String>

Convert QueryExecutionInfo to String.

Sample usage:


   // convert all info
   QueryExecutionInfoFormatter formatter = QueryExecutionInfoFormatter.showAll();
   String str = formatter.format(queryExecutionInfo);

   // customize conversion
   QueryExecutionInfoFormatter formatter = new QueryExecutionInfoFormatter();
   formatter.addConsumer((execInfo, sb) -> {
     sb.append("MY-QUERY-EXECUTION="); // add prefix
   };
   formatter.newLine();  // new line
   formatter.showSuccess();
   formatter.addConsumer((execInfo, sb)  -> {
       // custom conversion
       sb.append("MY-ID=" + executionInfo.getConnectionInfo().getConnectionId());
   });
   formatter.showQuery();

   // convert it
   String str = formatter.format(queryExecutionInfo);

Author:: Tadaya Tsuyukubo

Field Summary

Fields
Modifier and Type	Field and Description
`BiConsumer<QueryExecutionInfo,StringBuilder>`	`onBindings` Default implementation for formatting bindings.
`BiConsumer<BoundValue,StringBuilder>`	`onBoundValue` Default implementation for formatting bound value.
`BiConsumer<io.r2dbc.spi.Parameter,StringBuilder>`	`onBoundValueParameter` Default implementation for formatting `Parameter` value.
`BiConsumer<Object,StringBuilder>`	`onBoundValueRaw` Default implementation for formatting actual value of bound value.
`BiConsumer<SortedSet<Binding>,StringBuilder>`	`onIndexBindings` Default implementation for formatting bindings by index.
`BiConsumer<SortedSet<Binding>,StringBuilder>`	`onNamedBindings` Default implementation for formatting bindings by name.

Constructor Summary

Constructors
Constructor and Description

QueryExecutionInfoFormatter()

Constructors
Constructor and Description
`QueryExecutionInfoFormatter()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryExecutionInfoFormatter`	`addConsumer(BiConsumer<QueryExecutionInfo,StringBuilder> consumer)` Register a `BiConsumer` that convert `QueryExecutionInfo` to `String`.
`String`	`apply(QueryExecutionInfo executionInfo)`
`QueryExecutionInfoFormatter`	`boundValue(BiConsumer<BoundValue,StringBuilder> onBoundValue)` Set a consumer for converting `BoundValue`.
`QueryExecutionInfoFormatter`	`delimiter(String delimiter)` Set a delimiter between each consumer
`String`	`format(QueryExecutionInfo executionInfo)` Convert the given `QueryExecutionInfo` to `String` using registered consumers.
`QueryExecutionInfoFormatter`	`indexBindings(BiConsumer<SortedSet<Binding>,StringBuilder> onIndexBindings)` Set a consumer for converting `SortedSet` of `Binding` constructed by bind-by-index.
`QueryExecutionInfoFormatter`	`namedBindings(BiConsumer<SortedSet<Binding>,StringBuilder> onNamedBindings)` Set a consumer for converting `SortedSet` of `Binding` constructed by bind-by-name.
`QueryExecutionInfoFormatter`	`newLine()` Change the line
`static QueryExecutionInfoFormatter`	`showAll()` Create a `QueryExecutionInfoFormatter` which writes out all attributes on `QueryExecutionInfo`.
`QueryExecutionInfoFormatter`	`showBatchSize()` Show batch size with default format.
`QueryExecutionInfoFormatter`	`showBindings()` Show bindings with default format.
`QueryExecutionInfoFormatter`	`showBindingsSize()` Show binding size with default format.
`QueryExecutionInfoFormatter`	`showConnection()` Show connection information with default format.
`QueryExecutionInfoFormatter`	`showQuery()` Show query with default format.
`QueryExecutionInfoFormatter`	`showSuccess()` Show query success with default format.
`QueryExecutionInfoFormatter`	`showThread()` Show thread information with default format.
`QueryExecutionInfoFormatter`	`showTime()` Show query execution duration with default format.
`QueryExecutionInfoFormatter`	`showTransaction()` Show transaction information with default format.
`QueryExecutionInfoFormatter`	`showType()` Show statement type(batch or statement) with default format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, compose, identity

- Field Detail
  - onBoundValue
```
public BiConsumer<BoundValue,StringBuilder> onBoundValue
```
    Default implementation for formatting bound value.
  - onBoundValueRaw
```
public BiConsumer<Object,StringBuilder> onBoundValueRaw
```
    Default implementation for formatting actual value of bound value.
    Example: "100", "Foo", "<clob>".
  - onBoundValueParameter
```
public BiConsumer<io.r2dbc.spi.Parameter,StringBuilder> onBoundValueParameter
```
    Default implementation for formatting Parameter value.
    Example: "null(in,INTEGER)", "Foo(out,String)".
  - onIndexBindings
```
public BiConsumer<SortedSet<Binding>,StringBuilder> onIndexBindings
```
    Default implementation for formatting bindings by index. generate comma separated values. "val1,val2,val3"
  - onNamedBindings
```
public BiConsumer<SortedSet<Binding>,StringBuilder> onNamedBindings
```
    Default implementation for formatting bindings by name. Generate comma separated key-values pair string. "key1=val1,key2=val2,key3=val3"
  - onBindings
```
public BiConsumer<QueryExecutionInfo,StringBuilder> onBindings
```
    Default implementation for formatting bindings.
- Constructor Detail
  - QueryExecutionInfoFormatter
```
public QueryExecutionInfoFormatter()
```
- Method Detail
  - showAll
```
public static QueryExecutionInfoFormatter showAll()
```
    Create a QueryExecutionInfoFormatter which writes out all attributes on QueryExecutionInfo.
    
    Returns:
    
    a formatter
  - addConsumer
```
public QueryExecutionInfoFormatter addConsumer(BiConsumer<QueryExecutionInfo,StringBuilder> consumer)
```
    Register a BiConsumer that convert QueryExecutionInfo to String.
    
    Parameters:
    
    consumer - a BiConsumer that takes a QueryExecutionInfo and write to the StringBuilder.
    
    Returns:
    
    this formatter
    
    Throws:
    
    IllegalArgumentException - if consumer is null
  - format
```
public String format(QueryExecutionInfo executionInfo)
```
    Convert the given QueryExecutionInfo to String using registered consumers.
    
    Parameters:
    
    executionInfo - input
    
    Returns:
    
    formatted sting
    
    Throws:
    
    IllegalArgumentException - if executionInfo is null
  - apply
```
public String apply(QueryExecutionInfo executionInfo)
```
    Specified by:
    
    apply in interface Function<QueryExecutionInfo,String>
  - delimiter
```
public QueryExecutionInfoFormatter delimiter(String delimiter)
```
    Set a delimiter between each consumer
    
    Parameters:
    
    delimiter - delimiter
    
    Returns:
    
    formatter
    
    Throws:
    
    IllegalArgumentException - if delimiter is null
  - showThread
```
public QueryExecutionInfoFormatter showThread()
```
    Show thread information with default format.
    
    Returns:
    
    formatter
  - showConnection
```
public QueryExecutionInfoFormatter showConnection()
```
    Show connection information with default format.
    
    Returns:
    
    formatter
  - showTransaction
```
public QueryExecutionInfoFormatter showTransaction()
```
    Show transaction information with default format.
    
    Returns:
    
    formatter
  - showSuccess
```
public QueryExecutionInfoFormatter showSuccess()
```
    Show query success with default format.
    
    Returns:
    
    formatter
  - showTime
```
public QueryExecutionInfoFormatter showTime()
```
    Show query execution duration with default format.
    
    Returns:
    
    formatter
  - showType
```
public QueryExecutionInfoFormatter showType()
```
    Show statement type(batch or statement) with default format.
    
    Returns:
    
    formatter
  - showBatchSize
```
public QueryExecutionInfoFormatter showBatchSize()
```
    Show batch size with default format. i.e. Number of the calls of Batch.add(String)}.
    
    Returns:
    
    formatter
  - showBindingsSize
```
public QueryExecutionInfoFormatter showBindingsSize()
```
    Show binding size with default format. i.e. Number of the calls of Statement.add()}.
    
    Returns:
    
    formatter
  - showQuery
```
public QueryExecutionInfoFormatter showQuery()
```
    Show query with default format.
    
    Returns:
    
    formatter
  - showBindings
```
public QueryExecutionInfoFormatter showBindings()
```
    Show bindings with default format.
    
    Returns:
    
    formatter
  - newLine
```
public QueryExecutionInfoFormatter newLine()
```
    Change the line
    
    Returns:
    
    formatter
  - boundValue
```
public QueryExecutionInfoFormatter boundValue(BiConsumer<BoundValue,StringBuilder> onBoundValue)
```
    Set a consumer for converting BoundValue.
    
    Parameters:
    
    onBoundValue - bi-consumer for binding value
    
    Returns:
    
    formatter
    
    Throws:
    
    IllegalArgumentException - if onBoundValue is null
  - indexBindings
```
public QueryExecutionInfoFormatter indexBindings(BiConsumer<SortedSet<Binding>,StringBuilder> onIndexBindings)
```
    Set a consumer for converting SortedSet of Binding constructed by bind-by-index.
    
    Parameters:
    
    onIndexBindings - bi-consumer for index-bindings
    
    Returns:
    
    formatter
    
    Throws:
    
    IllegalArgumentException - if onIndexBindings is null
  - namedBindings
```
public QueryExecutionInfoFormatter namedBindings(BiConsumer<SortedSet<Binding>,StringBuilder> onNamedBindings)
```
    Set a consumer for converting SortedSet of Binding constructed by bind-by-name.
    
    Parameters:
    
    onNamedBindings - bi-consumer for named-bindings
    
    Returns:
    
    formatter
    
    Throws:
    
    IllegalArgumentException - if onNamedBindings is null

Class QueryExecutionInfoFormatter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Field Detail

onBoundValue

onBoundValueRaw

onBoundValueParameter

onIndexBindings

onNamedBindings

onBindings

Constructor Detail

QueryExecutionInfoFormatter

Method Detail

showAll

addConsumer

format

apply

delimiter

showThread

showConnection

showTransaction

showSuccess

showTime

showType

showBatchSize

showBindingsSize

showQuery

showBindings

newLine

boundValue

indexBindings

namedBindings