Class MongoDbStatementDml

java.lang.Object

io.helidon.dbclient.DbStatementBase<DbStatementDml>

io.helidon.dbclient.mongodb.MongoDbStatementDml

All Implemented Interfaces:

DbStatement<DbStatementDml>, DbStatementDml

public class MongoDbStatementDml
extends DbStatementBase<DbStatementDml>
implements DbStatementDml

MongoDB DbStatementDml implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	JSON_COLLECTION	Collection JSON parameter name.
protected static final String	JSON_OPERATION	Operation JSON parameter name.
protected static final String	JSON_PROJECTION	Projection JSON parameter name: Defines projection to restrict returned fields.
protected static final String	JSON_QUERY	Query JSON parameter name.
protected static final String	JSON_VALUE	Value JSON parameter name.

Method Summary

Modifier and Type	Method	Description
long	execute()	Execute this statement using the parameters configured with params and addParams methods.
DbResultDml	insert()	Execute INSERT statement using the parameters configured with params and addParams methods and return compound result with generated keys.
DbStatementDml	returnColumns(List<String> columnNames)	Set column names to be returned from the inserted row or rows from the statement execution using DbStatementDml.insert().
DbStatementDml	returnGeneratedKeys()	Set auto-generated keys to be returned from the statement execution using DbStatementDml.insert().
DbStatementType	statementType()	Get the statement type.

Methods inherited from class DbStatementBase

addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, autoClose, context, context, doExecute, identity, indexedParam, namedParam, parameters, params, params

Modifier and Type	Method	Description
DbStatementDml	addParam(boolean parameter)	Add next boolean parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(byte parameter)	Add next byte parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(byte[] parameter)	Add next byte[] parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(double parameter)	Add next double parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(float parameter)	Add next float parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(int parameter)	Add next integer parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(long parameter)	Add next long parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(short parameter)	Add next short parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(Object parameter)	Add next parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(String parameter)	Add next String parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(String name, boolean parameter)	Add next boolean parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, byte parameter)	Add next byte parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, byte[] parameter)	Add next byte[] parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, double parameter)	Add next double parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, float parameter)	Add next float parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, int parameter)	Add next int parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, long parameter)	Add next long parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, short parameter)	Add next short parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, Object parameter)	Add next parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, String parameter)	Add next String parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, BigDecimal parameter)	Add next BigDecimal parameter to the map of named parameters (e.g.
DbStatementDml	addParam(String name, BigInteger parameter)	Add next BigInteger parameter to the map of named parameters (e.g.
DbStatementDml	addParam(BigDecimal parameter)	Add next BigDecimal parameter to the list of ordered parameters (e.g.
DbStatementDml	addParam(BigInteger parameter)	Add next BigInteger parameter to the list of ordered parameters (e.g.
protected static <T> Stream<T>	autoClose(Stream<T> stream)	Decorate the given stream to invoke BaseStream.close() on terminal operations.
DbExecuteContext	context()	Get the execution context.
protected <C extends DbExecuteContext> C	context(Class<C> cls)	Returns execution context cast to it's extending class.
protected <T> T	doExecute(BiFunction<CompletableFuture<Long>, DbClientServiceContext, T> function)	Execute the statement with interception.
protected DbStatementDml	identity()	Get this instance as the correct type.
DbStatementDml	indexedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
DbStatementDml	namedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
DbStatementParameters	parameters()	Get the statement parameters.
DbStatementDml	params(List<?> parameters)	Configure parameters from a List by order.
DbStatementDml	params(Map<String,?> parameters)	Configure named parameters.

Methods inherited from class Object

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

Methods inherited from interface DbStatement

params

Modifier and Type	Method	Description
default DbStatementDml	params(Object... parameters)	Configure parameters from an array by order.

Field Details

JSON_OPERATION

protected static final String JSON_OPERATION

Operation JSON parameter name.

See Also:

• Constant Field Values

JSON_COLLECTION

protected static final String JSON_COLLECTION

Collection JSON parameter name.

See Also:

• Constant Field Values

JSON_QUERY

protected static final String JSON_QUERY

Query JSON parameter name.

See Also:

• Constant Field Values

JSON_VALUE

protected static final String JSON_VALUE

Value JSON parameter name.

See Also:

• Constant Field Values

JSON_PROJECTION

protected static final String JSON_PROJECTION

Projection JSON parameter name: Defines projection to restrict returned fields.

See Also:

• Constant Field Values

Method Details

statementType

public DbStatementType statementType()

Description copied from class: DbStatementBase

Get the statement type.

Specified by:

statementType in class DbStatementBase<DbStatementDml>

Returns:

statement type

execute

public long execute()

Description copied from interface: DbStatementDml

Execute this statement using the parameters configured with params and addParams methods.

Specified by:

execute in interface DbStatementDml

Returns:

the result of this statement

insert

public DbResultDml insert()

Description copied from interface: DbStatementDml

Execute INSERT statement using the parameters configured with params and addParams methods and return compound result with generated keys.

Specified by:

insert in interface DbStatementDml

Returns:

the result of this statement with generated keys

returnGeneratedKeys

public DbStatementDml returnGeneratedKeys()

Description copied from interface: DbStatementDml

Set auto-generated keys to be returned from the statement execution using DbStatementDml.insert(). Only one method from DbStatementDml.returnGeneratedKeys() and DbStatementDml.returnColumns(List) may be used. This feature is database provider specific and some databases require specific columns to be set.

Specified by:

returnGeneratedKeys in interface DbStatementDml

Returns:

updated db statement

returnColumns

public DbStatementDml returnColumns(List<String> columnNames)

Description copied from interface: DbStatementDml

Set column names to be returned from the inserted row or rows from the statement execution using DbStatementDml.insert(). Only one method from DbStatementDml.returnGeneratedKeys() and DbStatementDml.returnColumns(List) may be used. This feature is database provider specific.

Specified by:

returnColumns in interface DbStatementDml

Parameters:

columnNames - an array of column names indicating the columns that should be returned from the inserted row or rows

Returns:

updated db statement