Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
transaction_keyspace Struct Reference

Offline, serializable representation of a bucket, scope, and collection. More...

#include <couchbase/transactions/transaction_keyspace.hxx>

Public Member Functions

 transaction_keyspace (std::string bucket_name, std::string scope_name, std::string collection_name)
 
 transaction_keyspace (const std::string &bucket_name)
 
auto operator== (const transaction_keyspace &keyspace) const -> bool
 
auto valid () const -> bool
 Check if a keyspace is valid.
 

Public Attributes

std::string bucket
 
std::string scope
 
std::string collection
 

Friends

template<typename OStream >
auto operator<< (OStream &os, const transaction_keyspace &keyspace) -> OStream &
 

Detailed Description

Offline, serializable representation of a bucket, scope, and collection.

Constructor & Destructor Documentation

◆ transaction_keyspace() [1/2]

transaction_keyspace ( std::string bucket_name,
std::string scope_name,
std::string collection_name )

◆ transaction_keyspace() [2/2]

transaction_keyspace ( const std::string & bucket_name)
explicit

Member Function Documentation

◆ operator==()

auto operator== ( const transaction_keyspace & keyspace) const -> bool
inline

◆ valid()

auto valid ( ) const -> bool

Check if a keyspace is valid.

A valid transaction_keyspace must have the bucket, scope, and collection all set. Note that both the scope and collection default to _default, but there is no default for the bucket so it must be set.

Returns
true if valid.

Friends And Related Symbol Documentation

◆ operator<<

template<typename OStream >
auto operator<< ( OStream & os,
const transaction_keyspace & keyspace ) -> OStream&
friend

Member Data Documentation

◆ bucket

std::string bucket

◆ collection

std::string collection

◆ scope

std::string scope

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