us.abstracta.jmeter.javadsl.jdbc

Class DslJdbcSampler

java.lang.Object

us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer<BaseSampler.SamplerChild>

us.abstracta.jmeter.javadsl.core.samplers.BaseSampler<DslJdbcSampler>

us.abstracta.jmeter.javadsl.jdbc.DslJdbcSampler

All Implemented Interfaces:

DslTestElement, DslSampler, BaseThreadGroup.ThreadGroupChild

public class DslJdbcSampler
extends BaseSampler<DslJdbcSampler>

Allows interacting with databases through configured JDBC connections.

This sampler currently does not require to specify the type of query to send to the database (as JMeter element does), and calculates the proper type from query string and defined parameters.

Since:

0.38

See Also:

DslJdbcConnectionPool

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DslJdbcSampler.JdbcParamMode Specifies the mode to apply to a given query parameter.
static class	DslJdbcSampler.QueryType Specifies the type of query to use the JDBC driver with.

Nested classes/interfaces inherited from class us.abstracta.jmeter.javadsl.core.samplers.BaseSampler

BaseSampler.SamplerChild

Field Summary

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer

children

Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

guiClass, name

Constructor Summary

Constructors

Constructor and Description
DslJdbcSampler(String name, String poolName, String query)

Method Summary

Modifier and Type	Method and Description
DslJdbcSampler	autoCommit(boolean enabled) Allows enabling or disabling auto-commits on the connection pool.
protected org.apache.jmeter.testelement.TestElement	buildTestElement()
DslJdbcSampler	commit() Allows committing changes applied by previous queries when auto-commit is disabled on the connection pool.
DslJdbcSampler	param(Object value, int jdbcParamType) Allows specifying a parameter value to pass to the query and used in provided query placeholders ("?" symbol).
DslJdbcSampler	param(Object value, int jdbcParamType, DslJdbcSampler.JdbcParamMode mode) Same as param(Object, int) but allowing also to specify parameter mode.
DslJdbcSampler	queryType(DslJdbcSampler.QueryType queryType) Allows to explicitly specify the query type when auto-detection is not enough.
DslJdbcSampler	resultsVar(String resultsVar) Allows specifying the name of a variable where to store a list of query retrieved row maps.
DslJdbcSampler	rollback() Allows undoing changes done by previous queries when auto-commit is disabled on the connection pool.
DslJdbcSampler	timeout(Duration timeout) Allows specifying a maximum amount of time a query can take before it fails.
DslJdbcSampler	vars(String... vars) Allows specifying the name prefixes of variables where to store query retrieved row columns.

Methods inherited from class us.abstracta.jmeter.javadsl.core.samplers.BaseSampler

children

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.TestElementContainer

addChildren, buildTreeUnder

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement

buildConfiguredTestElement, buildTestElementGui, configureTestElement, durationToSeconds, getGuiClass, getName, loadBeanProperties, showAndWaitFrameWith, showFrameWith, showInGui, showTestElementGui

Methods inherited from class java.lang.Object

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

Methods inherited from interface us.abstracta.jmeter.javadsl.core.DslTestElement

buildTreeUnder, showInGui

Constructor Detail

DslJdbcSampler

public DslJdbcSampler(String name,
                      String poolName,
                      String query)

Method Detail

param

public DslJdbcSampler param(Object value,
                            int jdbcParamType)

Allows specifying a parameter value to pass to the query and used in provided query placeholders ("?" symbol).

In general, prefer using this instead of using JMeter variable references or expressions inside query, since is more performance and safer.

In the end, this just specifies parameters to pass to a prepared statement generated from the given query string.

There is no need to replace nulls with special values or have any special consideration for strings containing commas and quotes since the DSL abstracts such details.

Parameters:

value - specifies the actual value to set on the parameter.

jdbcParamType - sets the type of the parameter, being the value one of Types defined ones, or a specific one for the database that is not included in Types class.

Returns:

the DslJdbcSampler for further configuration or usage.

See Also:

Types

param

public DslJdbcSampler param(Object value,
                            int jdbcParamType,
                            DslJdbcSampler.JdbcParamMode mode)

Same as param(Object, int) but allowing also to specify parameter mode.

When mode is not specified, then DslJdbcSampler.JdbcParamMode.IN is used.

Remember specifying a parameter for each of query placeholders ('?'), even if is an OUT parameter.

Parameters:

value - specifies the actual value to set on the parameter.

jdbcParamType - sets the type of the parameter, being the value one of Types defined ones, or a specific one for the database that is not included in Types class.

mode - specifies the DslJdbcSampler.JdbcParamMode for the parameter.

Returns:

the DslJdbcSampler for further configuration or usage.

See Also:

param(Object, int), DslJdbcSampler.JdbcParamMode

vars

public DslJdbcSampler vars(String... vars)

Allows specifying the name prefixes of variables where to store query retrieved row columns.

JMeter adds a suffix to each variable with the row number, starting with 1 (eg: if the name of the variable is MY_FIELD, then the first row column value will be MY_FIELD_1). Additionally, JMeter creates a variable with "_#" suffix which includes the number of returned values/rows (eg: MY_FIELD_#).

Alternatively you may use resultsVar for getting a list of row maps.

Parameters:

vars - specifies variables names prefixes to use for each returned query column or function/procedure output parameter.

Returns:

the DslJdbcSampler for further configuration or usage.

resultsVar

public DslJdbcSampler resultsVar(String resultsVar)

Allows specifying the name of a variable where to store a list of query retrieved row maps.

Each element in the list will contain a map where the key is the column name or alias, or parameter output name, and the value is the associated value.

Parameters:

resultsVar - specifies the name of the variable where to store the list of row maps.

Returns:

the DslJdbcSampler for further configuration or usage.

timeout

public DslJdbcSampler timeout(Duration timeout)

Allows specifying a maximum amount of time a query can take before it fails. Warning: by default the timeout is not set, which differs from default JMeter component default behavior that sets it to 0 (infinity timeout). We decided to do this since we consider setting an infinity timeout to be a bad practices and additionally some database drivers might not support setting one.

You should set the timeout with a big enough value that covers all expected scenarios, but also low enough to quickly detect any potential abnormal behavior.

Parameters:

timeout - specifies the timeout duration.

By default, no timeout will be set, which might use the default timeout for the driver, connection, database. This also avoid issues with drivers that don't support a query timeout. When set to 0, then an infinity timeout will be considered (not recommended).

Since JDBC only supports specifying times in seconds, if you specify a smaller granularity (like milliseconds) it will be rounded up to seconds.

Returns:

the DslJdbcSampler for further configuration or usage.

commit

public DslJdbcSampler commit()

Allows committing changes applied by previous queries when auto-commit is disabled on the connection pool.

When this method is used, query string is ignored (so you can set it to null).

Returns:

the DslJdbcSampler for further configuration or usage.

rollback

public DslJdbcSampler rollback()

Allows undoing changes done by previous queries when auto-commit is disabled on the connection pool.

When this method is used, query string is ignored (so you can set it to null).

Returns:

the DslJdbcSampler for further configuration or usage.

autoCommit

public DslJdbcSampler autoCommit(boolean enabled)

Allows enabling or disabling auto-commits on the connection pool.

When this method is used, query string is ignored (so you can set it to null).

Parameters:

enabled - specifies to enable auto-commits when set to true, or disable them otherwise.

Returns:

the DslJdbcSampler for further configuration or usage.

queryType

public DslJdbcSampler queryType(DslJdbcSampler.QueryType queryType)

Allows to explicitly specify the query type when auto-detection is not enough.

In general this method should not be needed to invoke, but in some cases auto-detection may fail, and this method allows you to explicitly specify it.

Parameters:

queryType - the type of query to assign to use with the JDBC Driver.

Returns:

the DslJdbcSampler for further configuration or usage.

See Also:

DslJdbcSampler.QueryType

buildTestElement

protected org.apache.jmeter.testelement.TestElement buildTestElement()

Specified by:

buildTestElement in class BaseTestElement