Package io.jmix.reports.yarg.loaders.impl

Class SqlDataLoader

java.lang.Object

io.jmix.reports.yarg.loaders.impl.AbstractDataLoader

io.jmix.reports.yarg.loaders.impl.AbstractDbDataLoader

io.jmix.reports.yarg.loaders.impl.SqlDataLoader

All Implemented Interfaces:

ReportDataLoader, StreamingReportDataLoader

Direct Known Subclasses:

JmixSqlDataLoader

public class SqlDataLoader
extends AbstractDbDataLoader
implements StreamingReportDataLoader

Loads data from database using sql You can use aliases for output values Example: select login as "Login", password as "Password" from user where create_ts > ${startDate} ${startDate} is alias of the input parameter, which will be passed to the query

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SqlDataLoader.SqlRowIterator	Forward-only row iterator; output columns are captured from metadata once, at construction.

Nested classes/interfaces inherited from class io.jmix.reports.yarg.loaders.impl.AbstractDbDataLoader

AbstractDbDataLoader.OutputValue, AbstractDbDataLoader.QueryPack, AbstractDbDataLoader.QueryParameter

Field Summary

Fields

Modifier and Type	Field	Description
protected int	streamingFetchSize	JDBC fetch size for the streaming cursor; PostgreSQL also requires autoCommit=false to stream.

Fields inherited from class io.jmix.reports.yarg.loaders.impl.AbstractDbDataLoader

COMMON_PARAM_PATTERN

Fields inherited from class io.jmix.reports.yarg.loaders.impl.AbstractDataLoader

fieldsConverter, parametersConverter

Constructor Summary

Constructors

Constructor	Description
SqlDataLoader(DataSource dataSource)

Method Summary

Modifier and Type	Method	Description
protected List<AbstractDbDataLoader.OutputValue>	buildOutputValues(ResultSetMetaData metaData, String query)	Builds the output-value descriptors from the result-set metadata, capturing each column's case-sensitive as <synonym> alias from the query.
DataSource	getDataSource()
List<Map<String,Object>>	loadData(ReportQuery reportQuery, @Nullable BandData parentBand, Map<String,Object> params)	This method MUST return list of mutable maps.
<T> T	loadDataStreaming(ReportQuery reportQuery, @Nullable BandData parentBand, Map<String,Object> params, Function<Iterator<Map<String,Object>>,T> work)
protected DataSource	resolveDataSource(ReportQuery reportQuery)	The data source the streaming cursor connects to.
protected int	resolveStreamingFetchSize(Connection connection)	MySQL Connector/J ignores positive fetch sizes and buffers the whole result set client-side; Integer.MIN_VALUE switches it (and MariaDB Connector/J) to row streaming.
protected List	runQuery(ReportQuery reportQuery, String queryString, Object[] params, ResultSetHandler<List> handler)
void	setStreamingFetchSize(int streamingFetchSize)

Methods inherited from class io.jmix.reports.yarg.loaders.impl.AbstractDbDataLoader

fillOutputData, fillOutputRow, findParameterNames, insertParameterToQuery, prepareQuery, processQueryTemplate

Methods inherited from class io.jmix.reports.yarg.loaders.impl.AbstractDataLoader

addParentBandDataToParameters, convertOutputValue, convertParameter, getFieldsConverter, getParametersConverter, setFieldsConverter, setParametersConverter

Methods inherited from class java.lang.Object

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

Field Details

streamingFetchSize

protected int streamingFetchSize

JDBC fetch size for the streaming cursor; PostgreSQL also requires autoCommit=false to stream.

Constructor Details

SqlDataLoader

public SqlDataLoader(DataSource dataSource)

Method Details

setStreamingFetchSize

public void setStreamingFetchSize(int streamingFetchSize)

loadData

public List<Map<String,Object>> loadData(ReportQuery reportQuery,
 @Nullable BandData parentBand,
 Map<String,Object> params)

Description copied from interface: ReportDataLoader

This method MUST return list of mutable maps. We need mutability to put there some values implicitly.

Specified by:

loadData in interface ReportDataLoader

runQuery

protected List runQuery(ReportQuery reportQuery,
 String queryString,
 Object[] params,
 ResultSetHandler<List> handler)
                 throws SQLException

Throws:

SQLException

loadDataStreaming

public <T> T loadDataStreaming(ReportQuery reportQuery,
 @Nullable BandData parentBand,
 Map<String,Object> params,
 Function<Iterator<Map<String,Object>>,T> work)

Specified by:

loadDataStreaming in interface StreamingReportDataLoader

getDataSource

public DataSource getDataSource()

resolveDataSource

protected DataSource resolveDataSource(ReportQuery reportQuery)

The data source the streaming cursor connects to. The default is the constructor-injected one; subclasses may route by the dataset's data store (mirrors runQuery overrides).

resolveStreamingFetchSize

protected int resolveStreamingFetchSize(Connection connection)
                                 throws SQLException

MySQL Connector/J ignores positive fetch sizes and buffers the whole result set client-side; Integer.MIN_VALUE switches it (and MariaDB Connector/J) to row streaming.

Throws:

SQLException

buildOutputValues

protected List<AbstractDbDataLoader.OutputValue> buildOutputValues(ResultSetMetaData metaData,
 String query)
                                                            throws SQLException

Builds the output-value descriptors from the result-set metadata, capturing each column's case-sensitive as <synonym> alias from the query. Shared by the batch loader and the streaming cursor so the synonym semantics stay in one place.

Throws:

SQLException