mutation_token Class Reference

Value object to contain partition details and sequence number. More...

#include <couchbase/mutation_token.hxx>

Public Member Functions
	mutation_token ()=default
	mutation_token (std::uint64_t partition_uuid, std::uint64_t sequence_number, std::uint16_t partition_id, std::string bucket_name)
auto	partition_uuid () const -> std::uint64_t
	UUID of partition.
auto	sequence_number () const -> std::uint64_t
	Sequence number associated with the document.
auto	partition_id () const -> std::uint16_t
	ID of partition (also known as vBucket).
auto	bucket_name () const -> std::string
	Name of the bucket.

Detailed Description

Value object to contain partition details and sequence number.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

mutation_token() [1/2]

mutation_token ( )

default

Since

1.0.0

Committed

Generally available API and should be preferred in production

mutation_token() [2/2]

mutation_token ( std::uint64_t partition_uuid, std::uint64_t sequence_number, std::uint16_t partition_id, std::string bucket_name )

inlineexplicit

Parameters

partition_uuid
sequence_number
partition_id
bucket_name

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

bucket_name()

auto bucket_name ( ) const -> std::string

inlinenodiscard

Name of the bucket.

Returns

Since

1.0.0

Committed

Generally available API and should be preferred in production

partition_id()

auto partition_id ( ) const -> std::uint16_t

inlinenodiscard

ID of partition (also known as vBucket).

Returns

Since

1.0.0

Committed

Generally available API and should be preferred in production

partition_uuid()

auto partition_uuid ( ) const -> std::uint64_t

inlinenodiscard

UUID of partition.

Returns

Since

1.0.0

Committed

Generally available API and should be preferred in production

sequence_number()

auto sequence_number ( ) const -> std::uint64_t

inlinenodiscard

Sequence number associated with the document.

Returns

Since

1.0.0

Committed

Generally available API and should be preferred in production

---

The documentation for this class was generated from the following file:

• couchbase/mutation_token.hxx