Uploaded image for project: 'Apache Jena'
  1. Apache Jena
  2. JENA-29

cancellation during query execution



    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: Jena 2.11.0
    • Component/s: ARQ, TDB
    • Labels:


      The requested improvement and proposed patch is made by Simon Helsen on behalf of IBM

      ARQ query execution currently does not have a satisfactory way to cancel a running query in a safe way. Moreover, cancel (unlike a hard abort) is especially useful if it is able to provide partial result sets (i.e. all the results it managed to compute up to when the cancellation was requested). Although the exact cancellation behavior depends on the capabilities of the underlying triple store, the proposed patch merely relies on the iterators used by ARQ.

      Here is a more detailed explanation of the proposed changes:

      1) the cancel() method in the QueryIterator initiates a cancellation request (first boolean flag). In analogy with closeIterator(), it propagates through all chained iterators, so the entire calculation is aware that a cancellation is requested
      2) to ensure a thread-safe semantics, the cancelRequest becomes a real cancel once nextBinding() has been called. It sets the second boolean which is used in hasNext(). This 2-phase approach is critical since the cancel() method can be called at any time during a query execution by the external thread. And because the behavior of hasNext() is such that it has to return the same value until next() is called, this is the only way to guarantee semantic safety when cancel() is invoked (let me re-phrase this: it is the only way I was able to make it actually work)
      3) cancel() does not close anything since it allows execution to finish normally and the client is responsible to call close() just like with a regular execution. Note that the client has to call cancel() explicitly (typically in another thread) and has to assume that the returning result set may be incomplete if this method is called (it is undetermined whether the result is actually incomplete)
      4) in order to deal with order-by and groups, I had to make two more changes. First, I had to make QueryIterSort and QueryIterGroup a slightly bit more lazy. Currently, the full result set is calculated during plan calculation. With my proposed adjustments, this full result set is called on the first call to any of its Iterator methods (e.g. hasNext). This change does not AFAIK affect the semantics. Second, because the desired behavior of cancelling a sort or group query is to make sure everything is sorted/grouped even if the total result set is not completed, I added an exception which reverses the cancellation request of the encompassing iterator (as an example see cancel() in QueryIterSort). This makes sure that the entire subset of found and sorted elements is returned, not just the first element. However, it also implies in the case of sort that when a query is cancelled, it will first sort the partially complete result set before returning to the client.

      the attached patch is based on ARQ 2.8.5 (and a few classes in TDB 0.8.7 -> possibly the other triple store implementations need adjustement as well)


        1. cancelFix3.patch
          2 kB
          Simon Helsen
        2. jena.patch
          53 kB
          Simon Helsen
        3. JENA-29_ARQ_r8489.patch
          36 kB
          Paolo Castagna
        4. JENA-29_TDB_r8489.patch
          1 kB
          Paolo Castagna
        5. JENA-29_tests_ARQ_r8489.patch
          6 kB
          Paolo Castagna
        6. jenaAddition.patch
          2 kB
          Simon Helsen
        7. queryIterRepeatApply.patch
          2 kB
          Simon Helsen

          Issue Links



              • Assignee:
                andy Andy Seaborne
                shelsen Simon Helsen
              • Votes:
                5 Vote for this issue
                5 Start watching this issue


                • Created: