クラス AbstractSqlPagingQueryProvider
java.lang.ObjectSE
org.springframework.batch.item.database.support.AbstractSqlPagingQueryProvider
- 実装されたすべてのインターフェース:
PagingQueryProvider
- 既知の直属サブクラス
H2PagingQueryProvider
、HanaPagingQueryProvider
、HsqlPagingQueryProvider
、MariaDBPagingQueryProvider
、MySqlPagingQueryProvider
、OraclePagingQueryProvider
、PostgresPagingQueryProvider
、SqlitePagingQueryProvider
、SqlWindowingPagingQueryProvider
public abstract class AbstractSqlPagingQueryProvider
extends ObjectSE
implements PagingQueryProvider
提供されるすべての SQL ページングクエリプロバイダーの基本クラスとして機能する抽象 SQL ページングクエリプロバイダー。
どの実装でも、select 句、from 句、オプションで where 句を指定する方法を提供する必要があります。さらに、単一列のソートキーを指定する方法も提供する必要があります。このソートキーはページング機能を提供するために使用されます。パフォーマンスを向上させるために、ソートキーのインデックスを作成することをお勧めします。
必須の "selectClause" と "fromClause"、およびオプションの "whereClause" のプロパティと準備を提供します。また、必須の "sortKeys" のプロパティも提供します。 注 : ソートキーを構成する列は、単なる並べ替えの基準となる列ではなく、真のキーである必要があります。実行間でデータが失われないようにするには、ソートキーに一意のキー制約を設定することが重要です。
- 導入:
- 2.0
- 作成者:
- Thomas Risberg, Dave Syer, Michael Minella, Mahmoud Ben Hassine, Benjamin Hetz
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明abstract StringSE
generateFirstPageQuery
(int pageSize) 最初のページを取得するために使用されるクエリ文字列を生成するメソッド。abstract StringSE
generateRemainingPagesQuery
(int pageSize) 最初のページに続くページを取得するために使用されるクエリ文字列を生成するメソッド。protected StringSE
group by 句の getterint
クエリで宣言されているパラメーターの数protected StringSE
getSortKeyPlaceHolder
(StringSE keyName) ソートキーのプレースホルダーは、名前付きパラメーターまたは従来のプレースホルダーがクエリ文字列で使用されているかどうかによって異なります。キーとしてのソート列の Map <String、Boolean> および昇順 / 降順のブール値(ascending = true)。エイリアスのない並べ替えキー(一意の単一列名)。protected StringSE
void
init
(DataSourceSE dataSource) 必須プロパティを確認してください。boolean
生成されたクエリが名前付きパラメーター構文を使用するかどうかを示します。void
setFromClause
(StringSE fromClause) void
setGroupClause
(StringSE groupClause) group by 句の settervoid
setSelectClause
(StringSE selectClause) void
setSortKeys
(MapSE<StringSE, Order> sortKeys) void
setWhereClause
(StringSE whereClause)
コンストラクターの詳細
AbstractSqlPagingQueryProvider
public AbstractSqlPagingQueryProvider()
メソッドの詳細
setGroupClause
group by 句の setter- パラメーター:
groupClause
- SQL クエリ文字列の SQL GROUP BY 句の一部
getGroupClause
group by 句の getter- 戻り値:
- SQL クエリ文字列の SQL GROUP BY 句の一部
setSelectClause
- パラメーター:
selectClause
- SQL クエリ文字列の SELECT 句の一部
getSelectClause
- 戻り値:
- SQL クエリ文字列の SQL SELECT 句の一部
setFromClause
- パラメーター:
fromClause
- SQL クエリ文字列の FROM 句の一部
getFromClause
- 戻り値:
- SQL クエリ文字列の SQL FROM 句の一部
setWhereClause
- パラメーター:
whereClause
- SQL クエリ文字列の WHERE 句の一部
getWhereClause
- 戻り値:
- SQL クエリ文字列の SQL WHERE 句の一部
setSortKeys
- パラメーター:
sortKeys
- ページコンテンツの並べ替えと制限に使用するキー
getSortKeys
キーとしてのソート列の Map <String、Boolean> および昇順 / 降順のブール値(ascending = true)。- 次で指定:
- インターフェース
PagingQueryProvider
のgetSortKeys
- 戻り値:
- ページコンテンツの並べ替えや制限に使用する sortKey キー
getParameterCount
public int getParameterCount()インターフェースからコピーされた説明:PagingQueryProvider
クエリで宣言されているパラメーターの数- 次で指定:
- インターフェース
PagingQueryProvider
のgetParameterCount
- 戻り値:
- パラメーター数
isUsingNamedParameters
public boolean isUsingNamedParameters()インターフェースからコピーされた説明:PagingQueryProvider
生成されたクエリが名前付きパラメーター構文を使用するかどうかを示します。- 次で指定:
- インターフェース
PagingQueryProvider
のisUsingNamedParameters
- 戻り値:
- 名前付きパラメーター構文が使用されている場合は true
getSortKeyPlaceHolder
ソートキーのプレースホルダーは、名前付きパラメーターまたは従来のプレースホルダーがクエリ文字列で使用されているかどうかによって異なります。- 次で指定:
- インターフェース
PagingQueryProvider
のgetSortKeyPlaceHolder
- パラメーター:
keyName
- ソートキー名- 戻り値:
- sortKey のプレースホルダー。
init
必須プロパティを確認してください。- 次で指定:
- インターフェース
PagingQueryProvider
のinit
- パラメーター:
dataSource
- 初期化に使用する DataSource- 例外:
ExceptionSE
- 初期化時のエラー- 関連事項:
InitializingBean.afterPropertiesSet()
generateFirstPageQuery
最初のページを取得するために使用されるクエリ文字列を生成するメソッド。このメソッドはサブクラスで実装する必要があります。- 次で指定:
- インターフェース
PagingQueryProvider
のgenerateFirstPageQuery
- パラメーター:
pageSize
- ページごとに読み取る行数- 戻り値:
- クエリ文字列
generateRemainingPagesQuery
最初のページに続くページを取得するために使用されるクエリ文字列を生成するメソッド。このメソッドはサブクラスで実装する必要があります。- 次で指定:
- インターフェース
PagingQueryProvider
のgenerateRemainingPagesQuery
- パラメーター:
pageSize
- ページごとに読み取る行数- 戻り値:
- クエリ文字列
getSortKeysWithoutAliases
インターフェースからコピーされた説明:PagingQueryProvider
エイリアスのない並べ替えキー(一意の単一列名)。- 次で指定:
- インターフェース
PagingQueryProvider
のgetSortKeysWithoutAliases
- 戻り値:
- ページコンテンツの並べ替えや制限に使用する sortKey キー (エイリアスなし)