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
|
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
/**
* \class storage::spi::DocEntry
* \ingroup spi
*
* \brief Represents a document with metadata stored.
*
* To do merge, all SPI implementations need some common metadata. To do iterate
* efficiently, we also want options to only return metadata or similar. Thus
* we need a class to contain all generic parts stored by all SPI
* implementations.
*/
#pragma once
#include <vespa/persistence/spi/types.h>
#include <vespa/document/base/globalid.h>
namespace storage::spi {
enum class DocumentMetaEnum {
NONE = 0x0,
REMOVE_ENTRY = 0x1
};
class DocEntry {
public:
using SizeType = uint32_t;
using UP = std::unique_ptr<DocEntry>;
using SP = std::shared_ptr<DocEntry>;
DocEntry(const DocEntry &) = delete;
DocEntry & operator=(const DocEntry &) = delete;
DocEntry(DocEntry &&) = delete;
DocEntry & operator=(DocEntry &&) = delete;
virtual ~DocEntry();
bool isRemove() const { return (_metaEnum == DocumentMetaEnum::REMOVE_ENTRY); }
Timestamp getTimestamp() const { return _timestamp; }
DocumentMetaEnum getMetaEnum() const { return _metaEnum; }
/**
* If entry contains a document, returns its serialized size.
* If entry contains a document id, returns the serialized size of
* the id alone.
* Otherwise (i.e. metadata only), returns sizeof(DocEntry).
*/
SizeType getSize() const { return _size; }
virtual vespalib::string toString() const;
virtual const Document* getDocument() const { return nullptr; }
virtual const DocumentId* getDocumentId() const { return nullptr; }
virtual vespalib::stringref getDocumentType() const { return vespalib::stringref(); }
virtual GlobalId getGid() const { return GlobalId(); }
virtual DocumentUP releaseDocument();
static UP create(Timestamp t, DocumentMetaEnum metaEnum);
static UP create(Timestamp t, DocumentMetaEnum metaEnum, const DocumentId &docId);
static UP create(Timestamp t, DocumentMetaEnum metaEnum, vespalib::stringref docType, GlobalId gid);
static UP create(Timestamp t, DocumentUP doc);
static UP create(Timestamp t, DocumentUP doc, SizeType serializedDocumentSize);
protected:
DocEntry(Timestamp t, DocumentMetaEnum metaEnum, SizeType size)
: _timestamp(t),
_metaEnum(metaEnum),
_size(size)
{}
private:
DocEntry(Timestamp t, DocumentMetaEnum metaEnum) : DocEntry(t, metaEnum, sizeof(DocEntry)) { }
Timestamp _timestamp;
DocumentMetaEnum _metaEnum;
SizeType _size;
};
std::ostream & operator << (std::ostream & os, const DocEntry & r);
}
|
