summaryrefslogtreecommitdiffstats
path: root/storage/src/vespa/storage/visiting/reindexing_visitor.h
blob: d9e18542818c5554e3fb5b176902bf087e1af9ff (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once

#include "visitor.h"

namespace storage {

/**
 * A visitor instance that is intended to be used for background reindexing.
 * Only meant to be run alongside distributor-level bucket locking support
 * that prevents concurrent writes to documents in the visited bucket.
 *
 * The bucket lock is explicitly bypassed by the Puts sent by the visitor
 * by having all these be augmented with a special TaS string that is
 * recognized by the distributor.
 */
class ReindexingVisitor : public Visitor {
public:
    explicit ReindexingVisitor(StorageComponent& component);
    ~ReindexingVisitor() override = default;

private:
    void handleDocuments(const document::BucketId&, DocEntryList&, HitCounter&) override;
    bool remap_docapi_message_error_code(api::ReturnCode& in_out_code) override;
    vespalib::string make_lock_access_token() const;
};

struct ReindexingVisitorFactory : public VisitorFactory {
    VisitorEnvironment::UP makeVisitorEnvironment(StorageComponent&) override {
        return std::make_unique<VisitorEnvironment>();
    };

    Visitor* makeVisitor(StorageComponent& c, VisitorEnvironment&, const vdslib::Parameters&) override {
        return new ReindexingVisitor(c);
    }
};

}