Class DeleteDocTask

  • All Implemented Interfaces:
    Cloneable

    public class DeleteDocTask
    extends PerfTask
    Delete a document by docid. If no docid param is supplied, deletes doc with id = last-deleted-doc + doc.delete.step.
    • Field Detail

      • DEFAULT_DOC_DELETE_STEP

        public static final int DEFAULT_DOC_DELETE_STEP
        Gap between ids of deleted docs, applies when no docid param is provided.
        See Also:
        Constant Field Values
    • Constructor Detail

      • DeleteDocTask

        public DeleteDocTask​(PerfRunData runData)
    • Method Detail

      • doLogic

        public int doLogic()
                    throws Exception
        Description copied from class: PerfTask
        Perform the task once (ignoring repetitions specification) Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.
        Specified by:
        doLogic in class PerfTask
        Returns:
        number of work items done by this task.
        Throws:
        Exception
      • setup

        public void setup()
                   throws Exception
        Description copied from class: PerfTask
        Task setup work that should not be measured for that specific task. By default it does nothing, but tasks can implement this, moving work from PerfTask.doLogic() to this method. Only the work done in PerfTask.doLogic() is measured for this task. Notice that higher level (sequence) tasks containing this task would then measure larger time than the sum of their contained tasks.
        Overrides:
        setup in class PerfTask
        Throws:
        Exception
      • setParams

        public void setParams​(String params)
        Set the params (docid only)
        Overrides:
        setParams in class PerfTask
        Parameters:
        params - docid to delete, or -1 for deleting by delete gap settings.
      • supportsParams

        public boolean supportsParams()
        Description copied from class: PerfTask
        Sub classes that support parameters must override this method to return true.
        Overrides:
        supportsParams in class PerfTask
        Returns:
        true iff this task supports command line params.