Module io.helidon.dbclient.mongodb

Package io.helidon.dbclient.mongodb

Class MongoDbStatementGet

java.lang.Object

io.helidon.dbclient.DbStatementBase<DbStatementGet>

io.helidon.dbclient.mongodb.MongoDbStatementGet

All Implemented Interfaces:

DbStatement<DbStatementGet>, DbStatementGet

public class MongoDbStatementGet
extends DbStatementBase<DbStatementGet>
implements DbStatementGet

MongoDB DbStatementGet 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
MongoDbStatementGet	addParam(Object parameter)	Add next parameter to the list of ordered parameters (e.g.
MongoDbStatementGet	addParam(String name, Object parameter)	Add next parameter to the map of named parameters (e.g.
Optional<DbRow>	execute()	Execute this statement using the parameters configured with params and addParams methods.
MongoDbStatementGet	indexedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
MongoDbStatementGet	namedParam(Object parameters)	Configure parameters using Object instance with registered mapper.
MongoDbStatementGet	params(List<?> parameters)	Configure parameters from a List by order.
MongoDbStatementGet	params(Map<String,?> parameters)	Configure named parameters.
DbStatementType	statementType()	Get the statement type.

Methods inherited from class io.helidon.dbclient.DbStatementBase

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, parameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.dbclient.DbStatement

addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, addParam, params

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<DbStatementGet>

Returns:

statement type

params

public MongoDbStatementGet params(List<?> parameters)

Description copied from interface: DbStatement

Configure parameters from a List by order. The statement must use indexed parameters and configure them by order in the provided array.

Specified by:

params in interface DbStatement<DbStatementGet>

Overrides:

params in class DbStatementBase<DbStatementGet>

Parameters:

parameters - ordered parameters to set on this statement, never null

Returns:

updated db statement

params

public MongoDbStatementGet params(Map<String,?> parameters)

Description copied from interface: DbStatement

Configure named parameters. The statement must use named parameters and configure them from the provided map.

Specified by:

params in interface DbStatement<DbStatementGet>

Overrides:

params in class DbStatementBase<DbStatementGet>

Parameters:

parameters - named parameters to set on this statement

Returns:

updated db statement

namedParam

public MongoDbStatementGet namedParam(Object parameters)

Description copied from interface: DbStatement

Configure parameters using Object instance with registered mapper. The statement must use named parameters and configure them from the map provided by mapper.

Specified by:

namedParam in interface DbStatement<DbStatementGet>

Overrides:

namedParam in class DbStatementBase<DbStatementGet>

Parameters:

parameters - Object instance containing parameters

Returns:

updated db statement

indexedParam

public MongoDbStatementGet indexedParam(Object parameters)

Description copied from interface: DbStatement

Configure parameters using Object instance with registered mapper. The statement must use indexed parameters and configure them by order in the array provided by mapper.

Specified by:

indexedParam in interface DbStatement<DbStatementGet>

Overrides:

indexedParam in class DbStatementBase<DbStatementGet>

Parameters:

parameters - Object instance containing parameters

Returns:

updated db statement

addParam

public MongoDbStatementGet addParam(Object parameter)

Description copied from interface: DbStatement

Add next parameter to the list of ordered parameters (e.g. the ones that use ? in SQL).

Specified by:

addParam in interface DbStatement<DbStatementGet>

Overrides:

addParam in class DbStatementBase<DbStatementGet>

Parameters:

parameter - next parameter to set on this statement

Returns:

updated db statement

addParam

public MongoDbStatementGet addParam(String name,
 Object parameter)

Description copied from interface: DbStatement

Add next parameter to the map of named parameters (e.g. the ones that use :name in Helidon JDBC SQL integration).

Specified by:

addParam in interface DbStatement<DbStatementGet>

Overrides:

addParam in class DbStatementBase<DbStatementGet>

Parameters:

name - name of parameter

parameter - value of parameter

Returns:

updated db statement

execute

public Optional<DbRow> execute()

Description copied from interface: DbStatementGet

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

Specified by:

execute in interface DbStatementGet

Returns:

The result of this statement.