blob: 130042bc0481914aa9bb37be28f4a36596cf66cf (
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
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
81
82
83
84
85
86
87
88
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
#pragma once
#include "indexsearchable.h"
#include <vespa/searchcommon/common/schema.h>
#include <vespa/searchlib/common/serialnum.h>
#include <vespa/vespalib/stllike/string.h>
#include <vespa/vespalib/util/memoryusage.h>
namespace document { class Document; }
namespace vespalib { class IDestructorCallback; }
namespace vespalib::slime { struct Cursor; }
namespace searchcorespi::index {
/**
* Interface for a memory index as seen from an index maintainer.
*/
struct IMemoryIndex : public searchcorespi::IndexSearchable {
using LidVector = std::vector<uint32_t>;
using SP = std::shared_ptr<IMemoryIndex>;
using OnWriteDoneType = const std::shared_ptr<vespalib::IDestructorCallback> &;
virtual ~IMemoryIndex() {}
/**
* Returns true if this memory index has received any document insert operations.
*/
virtual bool hasReceivedDocumentInsert() const = 0;
/**
* Returns the memory usage of this memory index.
*/
virtual vespalib::MemoryUsage getMemoryUsage() const = 0;
/**
* Returns the memory usage of an empty version of this memory index.
*/
virtual uint64_t getStaticMemoryFootprint() const = 0;
/**
* Inserts the given document into this memory index.
* If the document already exists it should be removed first.
*
* @param lid the local document id.
* @param doc the document to insert.
* @param on_write_done shared object that notifies write done when destructed.
*/
virtual void insertDocument(uint32_t lid, const document::Document &doc, OnWriteDoneType on_write_done) = 0;
/**
* Removes the given document from this memory index.
*
* @param lid the local document id.
*/
void removeDocument(uint32_t lid) {
LidVector lids;
lids.push_back(lid);
removeDocuments(std::move(lids));
}
virtual void removeDocuments(LidVector lids) = 0;
/**
* Commits the inserts and removes since the last commit, making them searchable.
**/
virtual void commit(OnWriteDoneType onWriteDone, search::SerialNum serialNum) = 0;
/**
* Flushes this memory index to disk as a disk index.
* After a flush it should be possible to load a IDiskIndex from the flush directory.
* Note that the schema used when constructing the memory index should be flushed as well
* since a IDiskIndex should be able to return the schema used by the disk index.
*
* @param flushDir the directory in which to save the flushed index.
* @param docIdLimit the largest local document id used + 1
* @param serialNum the serial number of the last operation to the memory index.
*/
virtual void flushToDisk(const vespalib::string &flushDir,
uint32_t docIdLimit,
search::SerialNum serialNum) = 0;
virtual void pruneRemovedFields(const search::index::Schema &schema) = 0;
virtual search::index::Schema::SP getPrunedSchema() const = 0;
virtual void insert_write_context_state(vespalib::slime::Cursor& object) const = 0;
};
}
|
