Module io.helidon.dbclient

Package io.helidon.dbclient

Class DbClientServiceContextImpl

java.lang.Object

io.helidon.dbclient.DbClientServiceContextImpl

All Implemented Interfaces:

DbClientServiceContext

public class DbClientServiceContextImpl
extends Object
implements DbClientServiceContext

Interceptor context to get (and possibly manipulate) database operations.

This is a mutable object - acts as a builder during the invocation of DbClientService. The interceptors are executed sequentially, so there is no need for synchronization.

Method Summary

Modifier and Type	Method	Description
Context	context()	Context with parameters passed from the caller, such as SpanContext for tracing.
DbClientServiceContextImpl	context(Context context)	Set a new context to be used by other interceptors and when executing the statement.
String	dbType()	Type of this database (usually the same string used by the DbClientProvider.name()).
DbClientServiceContextImpl	parameters(List<Object> parameters)	Set new indexed parameters to be used.
DbClientServiceContextImpl	parameters(Map<String,Object> parameters)	Set new named parameters to be used.
CompletionStage<Long>	resultFuture()	A stage that is completed once the results were fully read.
String	statement()	Text of the statement to be executed.
DbClientServiceContextImpl	statement(String name)	Set a new statement to be used.
DbClientServiceContextImpl	statement(String stmt, List<Object> parameters)	Set a new statement with indexed parameters to be used.
DbClientServiceContextImpl	statement(String stmt, Map<String,Object> parameters)	Set a new statement with named parameters to be used.
CompletionStage<Void>	statementFuture()	A stage that is completed once the statement finishes execution.
String	statementName()	Name of a statement to be executed.
DbClientServiceContextImpl	statementName(String name)	Set a new statement name to be used.
DbStatementParameters	statementParameters()	Get the statement parameters.
DbStatementType	statementType()	Type of the statement being executed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

context

public Context context()

Description copied from interface: DbClientServiceContext

Context with parameters passed from the caller, such as SpanContext for tracing.

Specified by:

context in interface DbClientServiceContext

Returns:

context associated with this request

statement

public String statement()

Description copied from interface: DbClientServiceContext

Text of the statement to be executed.

Specified by:

statement in interface DbClientServiceContext

Returns:

statement text

statementName

public String statementName()

Description copied from interface: DbClientServiceContext

Name of a statement to be executed. Ad hoc statements have names generated.

Specified by:

statementName in interface DbClientServiceContext

Returns:

name of the statement

statementType

public DbStatementType statementType()

Description copied from interface: DbClientServiceContext

Type of the statement being executed.

Specified by:

statementType in interface DbClientServiceContext

Returns:

statement type

statementParameters

public DbStatementParameters statementParameters()

Description copied from interface: DbClientServiceContext

Get the statement parameters.

Specified by:

statementParameters in interface DbClientServiceContext

Returns:

statement parameters

dbType

public String dbType()

Description copied from interface: DbClientServiceContext

Type of this database (usually the same string used by the DbClientProvider.name()).

Specified by:

dbType in interface DbClientServiceContext

Returns:

type of database

statementFuture

public CompletionStage<Void> statementFuture()

Description copied from interface: DbClientServiceContext

A stage that is completed once the statement finishes execution.

Specified by:

statementFuture in interface DbClientServiceContext

Returns:

statement future

resultFuture

public CompletionStage<Long> resultFuture()

Description copied from interface: DbClientServiceContext

A stage that is completed once the results were fully read. The number returns either the number of modified records or the number of records actually read.

Specified by:

resultFuture in interface DbClientServiceContext

Returns:

stage that completes once all query results were processed.

statement

public DbClientServiceContextImpl statement(String stmt,
 List<Object> parameters)

Description copied from interface: DbClientServiceContext

Set a new statement with indexed parameters to be used.

Specified by:

statement in interface DbClientServiceContext

Parameters:

stmt - statement text

parameters - indexed parameters

Returns:

updated interceptor context

statement

public DbClientServiceContextImpl statement(String stmt,
 Map<String,Object> parameters)

Description copied from interface: DbClientServiceContext

Set a new statement with named parameters to be used.

Specified by:

statement in interface DbClientServiceContext

Parameters:

stmt - statement text

parameters - named parameters

Returns:

updated interceptor context

parameters

public DbClientServiceContextImpl parameters(List<Object> parameters)

Description copied from interface: DbClientServiceContext

Set new indexed parameters to be used.

Specified by:

parameters in interface DbClientServiceContext

Parameters:

parameters - parameters

Returns:

updated interceptor context

parameters

public DbClientServiceContextImpl parameters(Map<String,Object> parameters)

Description copied from interface: DbClientServiceContext

Set new named parameters to be used.

Specified by:

parameters in interface DbClientServiceContext

Parameters:

parameters - parameters

Returns:

updated interceptor context

context

public DbClientServiceContextImpl context(Context context)

Description copied from interface: DbClientServiceContext

Set a new context to be used by other interceptors and when executing the statement.

Specified by:

context in interface DbClientServiceContext

Parameters:

context - context to use

Returns:

updated interceptor context

statement

public DbClientServiceContextImpl statement(String name)

Description copied from interface: DbClientServiceContext

Set a new statement to be used.

Specified by:

statement in interface DbClientServiceContext

Parameters:

name - statement text to use

Returns:

updated interceptor context

statementName

public DbClientServiceContextImpl statementName(String name)

Description copied from interface: DbClientServiceContext

Set a new statement name to be used.

Specified by:

statementName in interface DbClientServiceContext

Parameters:

name - statement name to use

Returns:

updated interceptor context