カーソル検索

• カーソル検索とは？
• 安全性を確保したカーソル検索
  • ConditionBean
  • 外だしSQL
• トランザクションには注意
• データの受け取り方の違い
  • サポートしている二つのやり方
  • サポートしていないもう二つのやり方
  • 外だしSQLのカーソル検索は最速
• 厳密には 1 ループで破棄しないことも
• Exampleのススメ

カーソル検索とは？

そもそもカーソル検索とは？について説明するページがあります。

安全性を確保したカーソル検索

カーソル検索のよくある悩みは、どうしても安全性を失ってしまうやり方になってしまうことですが、 DBFluteでは、安全性を確保した状態でカーソル検索ができるような工夫がされております。

ConditionBean

ConditionBeanでは、EntityRowHandler を利用したコールバックを指定することで実装できます。

e.g. ConditionBeanでカーソル検索 {MEMBER} @Java
MemberCB cb = new MemberCB();
cb.setupSelect_MemberStatus();
cb.query().setMemberName_PrefixSearch("S");

memberBhv.selectCursor(cb, new EntityRowHandler<Member>() {
    public void handle(Member entity) { // called per one record
        ... = entity.getMemberId();
        ... = entity.getMemberName();
        ... = entity.getMemberStatus();
    }
});

外だしSQL

外だしSQLでは、Sql2Entityで TypeSafeCursor を自動生成することで実装できます。

e.g. 外だしSQLでカーソル検索 @Java
memberBhv.outsideSql().cursorHandling()
.selectCursor(pmb, new PurchaseSummaryMemberCursorHandler() {
    protected Object fetchCursor(PurchaseSummaryMemberCursor cursor) thr... {
        while (cursor.next()) { // on memory per one record
            // type safe access
            Integer memberId = cursor.getMemberId();
            String memberName = cursor.getMemberName();
            Date birthdate = cursor.getBirthdate();
            Timestamp formalizedDatetime = cursor.getFormalizedDatetime();
            Long purchaseSummary = cursor.getPurchaseSummary();

            ...
        }
        return null; // basically null
    }
});

トランザクションには注意

大量データを検索して別のテーブルに登録処理(insert)をするような処理の場合で、 カーソル検索のループの中でのコミット処理をカーソル検索と同じトランザクションでコミットしてしまうと、 カーソル検索自体が(ループが終わる前に)終わってしまいます。当然のことながら、そのカーソルの接続が切断されるからです。 そのような場合は、必ず カーソル検索と登録処理のトランザクションは別々 にします。

e.g. カーソル内で登録処理のトランザクション {Spring, Lasta Di} @Java
public void migrateMember() {
    MemberCB cb = new MemberCB();
    ...
    memberBhv.selectCursor(cb, new EntityRowHandler<Member>() {
        public void handle(Member entity) {
            registerAnotherMember(entity); // 一件ごとにコミット
        }
    });
}

@Transactional(TxType.REQUIRES_NEW)
public void registerAnotherMember(Member entity) { // 新しいトランザクション
    ... // 別のテーブルに登録
}

トランザクションの指定の仕方は、利用しているDIコンテナなどによって変わります。 (DBFlute自体はトランザクション制御に関与はせず、連携するフレームワークにトランザクション制御を任せています)

Exampleのススメ

dbflute-basic-example では、テストケースの中で実際にカーソル検索を利用しています。 (他の多くのExampleでも同様に利用されています)