summaryrefslogtreecommitdiff
path: root/src/mongo/db/s/collection_range_deleter.h
blob: 4cb52d1ee3f3a080869956bc6dc81960446ad0bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/**
 *    Copyright (C) 2016 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */
#pragma once

#include "mongo/base/disallow_copying.h"
#include "mongo/db/namespace_string.h"
#include "mongo/s/catalog/type_chunk.h"

namespace mongo {

class BSONObj;
class Collection;
class OperationContext;

class CollectionRangeDeleter {
    MONGO_DISALLOW_COPYING(CollectionRangeDeleter);

public:
    CollectionRangeDeleter(NamespaceString nss);

    /**
     * Starts deleting ranges and cleans up this object when it is finished.
     */
    void run();

    /**
     * Acquires the collection IX lock and checks whether there are new entries for the collection's
     * rangesToClean structure.  If there are, deletes up to maxToDelete entries and yields using
     * the standard query yielding logic.
     *
     * Returns true if there are more entries in rangesToClean, false if there is no more progress
     * to be made.
     */
    bool cleanupNextRange(OperationContext* txn, int maxToDelete);

private:
    /**
     * Performs the deletion of up to maxToDelete entries within the range in progress.
     * This function will invariant if called while _rangeInProgress is not set.
     *
     * Returns the number of documents deleted (0 if deletion is finished), or -1 for error.
     */
    int _doDeletion(OperationContext* txn,
                    Collection* collection,
                    const BSONObj& keyPattern,
                    int maxToDelete);

    NamespaceString _nss;

    // Holds a range for which deletion has begun. If empty, then a new range
    // must be requested from rangesToClean
    boost::optional<ChunkRange> _rangeInProgress;
};

}  // namespace mongo