couchbase::subdoc Namespace Reference

Classes
class	array_add_unique
	An intention to perform a SubDocument array_add_unique operation. More...
class	array_append
	An intention to perform a SubDocument array_append operation. More...
class	array_insert
	An intention to perform a SubDocument array_insert operation. More...
class	array_prepend
	An intention to perform a SubDocument array_prepend operation. More...
class	count
	An intention to perform a SubDocument count operation. More...
class	counter
	An intention to perform a SubDocument counter operation. More...
class	exists
	An intention to perform a SubDocument exists operation. More...
class	get
	An intention to perform a SubDocument get operation. More...
class	insert
	An intention to perform a SubDocument insert operation. More...
class	remove
	An intention to perform a SubDocument remove operation. More...
class	replace
	An intention to perform a SubDocument replace operation. More...
class	upsert
	An intention to perform a SubDocument upsert operation. More...

Enumerations
enum class	lookup_in_macro {   document , expiry_time , cas , sequence_number ,   vbucket_uuid , last_modified , is_deleted , value_size_bytes ,   revision_id , flags , vbucket }
enum class	mutate_in_macro { cas , sequence_number , value_crc32c }

Functions
auto	to_lookup_in_macro (std::string_view input) -> std::optional< lookup_in_macro >
	Parses string as lookup_in macro.
auto	to_string (lookup_in_macro value) -> std::string
	Converts macro into binary array suitable for sending to the server.
auto	to_mutate_in_macro (std::string_view input) -> std::optional< mutate_in_macro >
	Parses string as mutate_in macro.
auto	to_binary (mutate_in_macro value) -> std::vector< std::byte >
	Converts macro into binary array suitable for sending to the server.

Enumeration Type Documentation

lookup_in_macro

enum class lookup_in_macro

strong

Since

1.0.0

Volatile

Should not be used in production

Enumerator
document
expiry_time
cas
sequence_number
vbucket_uuid
last_modified
is_deleted
value_size_bytes
revision_id
flags
vbucket

mutate_in_macro

enum class mutate_in_macro

strong

Since

1.0.0

Volatile

Should not be used in production

Enumerator
cas
sequence_number
value_crc32c

Function Documentation

to_binary()

auto to_binary

(

mutate_in_macro

value

)

-> std::vector< std::byte >

Converts macro into binary array suitable for sending to the server.

Parameters

value

macro

Returns

binary string

Since

1.0.0

Volatile

Should not be used in production

to_lookup_in_macro()

auto to_lookup_in_macro

(

std::string_view

input

)

-> std::optional< lookup_in_macro >

Parses string as lookup_in macro.

Parameters

input

string

Returns

empty optional if the string does not contain macro, corresponding enum value otherwise.

Since

1.0.0

Volatile

Should not be used in production

to_mutate_in_macro()

auto to_mutate_in_macro

(

std::string_view

input

)

-> std::optional< mutate_in_macro >

Parses string as mutate_in macro.

Parameters

input

string

Returns

empty optional if the string does not contain macro, corresponding enum value otherwise.

Since

1.0.0

Volatile

Should not be used in production

to_string()

auto to_string

(

lookup_in_macro

value

)

-> std::string

Converts macro into binary array suitable for sending to the server.

Parameters

value

macro

Returns

binary string

Since

1.0.0

Volatile

Should not be used in production