YugabyteDB (2.13.0.0-b42, bfc6a6643e7399ac8a0e81d06a3ee6d6571b33ab)

// Copyright (c) YugaByte, Inc.

//

// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

// in compliance with the License.  You may obtain a copy of the License at

//

// http://www.apache.org/licenses/LICENSE-2.0

//

// Unless required by applicable law or agreed to in writing, software distributed under the License

// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

// or implied.  See the License for the specific language governing permissions and limitations

// under the License.

//

#ifndef YB_DOCDB_DOC_PATH_H_

#define YB_DOCDB_DOC_PATH_H_

#include <stdint.h>

#include <cstring>

#include <functional>

#include <ostream>

#include <string>

#include <type_traits>

#include <unordered_set>

#include <utility>

#include <vector>

#include "yb/docdb/docdb_fwd.h"

#include "yb/docdb/key_bytes.h"

#include "yb/gutil/integral_types.h"

#include "yb/gutil/macros.h"

#include "yb/gutil/strings/substitute.h"

#include "yb/util/string_util.h"

namespace yb {

namespace docdb {

// Identifies a particular subdocument inside the logical representation of the document database.

// By "logical representation" we mean that we are not concerned with the exact keys used in the

// underlying key-value store. This is very similar to a SubDocKey without a hybrid time, and can

// probably be merged with it.

class DocPath {

 public:

  template<class... T>

  DocPath(const KeyBytes& encoded_doc_key, T... subkeys) {

    encoded_doc_key_ = encoded_doc_key;

    AppendPrimitiveValues(&subkeys_, subkeys...);

  }

_ZN2yb5docdb7DocPathC2IJNS0_14PrimitiveValueEEEERKNS0_8KeyBytesEDpT_

Line

Count

Source

48

78

  DocPath(const KeyBytes& encoded_doc_key, T... subkeys) {

49

78

    encoded_doc_key_ = encoded_doc_key;

50

78

    AppendPrimitiveValues(&subkeys_, subkeys...);

51

78

  }

Unexecuted instantiation: _ZN2yb5docdb7DocPathC2IJNS0_14PrimitiveValueES3_S3_EEERKNS0_8KeyBytesEDpT_

_ZN2yb5docdb7DocPathC2IJEEERKNS0_8KeyBytesEDpT_

Line

Count

Source

48

61.4k

  DocPath(const KeyBytes& encoded_doc_key, T... subkeys) {

49

61.4k

    encoded_doc_key_ = encoded_doc_key;

50

61.4k

    AppendPrimitiveValues(&subkeys_, subkeys...);

51

61.4k

  }

Unexecuted instantiation: _ZN2yb5docdb7DocPathC2IJNS0_14PrimitiveValueES3_EEERKNS0_8KeyBytesEDpT_

Unexecuted instantiation: _ZN2yb5docdb7DocPathC2IJPKciEEERKNS0_8KeyBytesEDpT_

Unexecuted instantiation: _ZN2yb5docdb7DocPathC2IJPKcEEERKNS0_8KeyBytesEDpT_

Unexecuted instantiation: _ZN2yb5docdb7DocPathC2IJPKcS4_EEERKNS0_8KeyBytesEDpT_

  template<class... T>

  DocPath(const Slice& encoded_doc_key, T... subkeys)

      : encoded_doc_key_(encoded_doc_key) {

    AppendPrimitiveValues(&subkeys_, subkeys...);

  }

_ZN2yb5docdb7DocPathC2IJNS0_14PrimitiveValueEEEERKNS_5SliceEDpT_

Line

Count

Source

55

21.0M

      : encoded_doc_key_(encoded_doc_key) {

56

21.0M

    AppendPrimitiveValues(&subkeys_, subkeys...);

57

21.0M

  }

_ZN2yb5docdb7DocPathC2IJEEERKNS_5SliceEDpT_

Line

Count

Source

55

122k

      : encoded_doc_key_(encoded_doc_key) {

56

122k

    AppendPrimitiveValues(&subkeys_, subkeys...);

57

122k

  }

  DocPath(const KeyBytes& encoded_doc_key, const vector<PrimitiveValue>& subkeys)

      : encoded_doc_key_(encoded_doc_key),

        subkeys_(subkeys) {

  }

  const KeyBytes& encoded_doc_key() const { return encoded_doc_key_; }

  size_t num_subkeys() const { return subkeys_.size(); }

  const PrimitiveValue& subkey(size_t i) const {

    assert(i < num_subkeys());

    return subkeys_[i];

  }

  std::string ToString() const;

  void AddSubKey(const PrimitiveValue& subkey);

  void AddSubKey(PrimitiveValue&& subkey);

  const PrimitiveValue& last_subkey() const {

    assert(!subkeys_.empty());

    return subkeys_.back();

  }

  // Note: the hash is supposed to be uint16_t, but protobuf only supports uint32.

  // So this function takes in uint32_t.

  // TODO (akashnil): Add uint16 data type in docdb.

  static DocPath DocPathFromRedisKey(uint16_t hash, const string& key, const string& subkey = "");

  const std::vector<PrimitiveValue>& subkeys() const {

    return subkeys_;

  }

 private:

  // Encoded key identifying the document. This key can itself contain multiple components

  // (hash bucket, hashed components, range components).

  // TODO(mikhail): should this really be encoded?

  KeyBytes encoded_doc_key_;

  std::vector<PrimitiveValue> subkeys_;

};

inline std::ostream& operator << (std::ostream& out, const DocPath& doc_path) {

  return out << doc_path.ToString();

}

}  // namespace docdb

}  // namespace yb

#endif  // YB_DOCDB_DOC_PATH_H_