Google Cloud Bigtable C++ Client  1.32.1
A C++ Client Library for Google Cloud Bigtable
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
google::cloud::bigtable Namespace Reference

Contains all the Cloud Bigtable C++ client APIs. More...

Namespaces

 examples
 
 v1
 The inlined, versioned namespace for the Cloud Bigtable C++ client APIs.
 

Classes

class  DefaultAdminClient
 An AdminClient for single-threaded programs that refreshes credentials on all gRPC errors. More...
 
class  AdminClient
 Connects to Cloud Bigtable's table administration APIs. More...
 
class  AppProfileConfig
 Specify the initial configuration for an application profile. More...
 
class  AppProfileUpdateConfig
 Build a proto to update an Application Profile configuration. More...
 
class  ClientOptions
 Configuration options for the Bigtable Client. More...
 
class  ClusterConfig
 Specify the initial configuration for a new cluster. More...
 
class  DefaultDataClient
 Implement a simple DataClient. More...
 
class  DataClient
 Connects to Cloud Bigtable's data manipulation APIs. More...
 
class  TableAdmin
 Implements the API to administer tables in a Cloud Bigtable instance. More...
 
class  InstanceAdmin
 Implements the APIs to administer Cloud Bigtable instances. More...
 
class  Table
 The main interface to interact with data in a Cloud Bigtable table. More...
 
struct  DataEndpointOption
 The endpoint for data operations. More...
 
struct  AdminEndpointOption
 The endpoint for table admin operations. More...
 
struct  InstanceAdminEndpointOption
 The endpoint for instance admin operations. More...
 
struct  MinConnectionRefreshOption
 Minimum time in ms to refresh connections. More...
 
struct  MaxConnectionRefreshOption
 Maximum time in ms to refresh connections. More...
 
class  GcRule
 Implement a thin wrapper around google::bigtable::admin::v2::GcRule. More...
 
class  ColumnFamilyModification
 Define the interfaces to create column family modifications. More...
 
class  MetadataParamTypes
 Define the class for governing x-goog-request-params metadata value. More...
 
class  MetadataUpdatePolicy
 MetadataUpdatePolicy holds supported metadata and setup ClientContext. More...
 
class  PollingPolicy
 Define the interface for providing asynchronous repetitive call rules. More...
 
class  GenericPollingPolicy
 Construct a polling policy from existing Retry and Backoff policies. More...
 
class  TableConfig
 Specify the initial schema for a new table. More...
 
struct  ClusterList
 The response for an asynchronous request listing all the clusters. More...
 
class  InstanceAdminClient
 Connects to Cloud Bigtable's instance administration APIs. More...
 
class  InstanceConfig
 Specify the initial configuration for a new instance. More...
 
struct  InstanceList
 The response for an asynchronous request listing all the instances. More...
 
class  InstanceUpdateConfig
 Specify the initial configuration for updating an instance. More...
 
class  RPCBackoffPolicy
 Define the interface for controlling how the Bigtable client backsoff from failed RPC operations. More...
 
class  ExponentialBackoffPolicy
 Implement a simple exponential backoff policy. More...
 
class  RPCRetryPolicy
 Define the interface for controlling how the Bigtable client retries RPC operations. More...
 
class  LimitedErrorCountRetryPolicy
 Implement a simple "count errors and then stop" retry policy. More...
 
class  LimitedTimeRetryPolicy
 Implement a simple "keep trying for this time" retry policy. More...
 
class  AsyncRowReader
 Objects of this class represent the state of reading rows via AsyncReadRows. More...
 
class  Row
 The in-memory representation of a Bigtable row. More...
 
class  Filter
 Define the interfaces to create filter expressions. More...
 
class  IdempotentMutationPolicy
 Defines the interface to control which mutations are idempotent and therefore can be re-tried. More...
 
class  SafeIdempotentMutationPolicy
 Implements a policy that only accepts truly idempotent mutations. More...
 
class  AlwaysRetryMutationPolicy
 Implements a policy that retries all mutations. More...
 
struct  Mutation
 Represent a single change to a specific row in a Table. More...
 
class  SingleRowMutation
 Represent a single row mutation. More...
 
class  FailedMutation
 A SingleRowMutation that failed. More...
 
class  PermanentMutationFailure
 Report unrecoverable errors in a partially completed mutation. More...
 
class  BulkMutation
 Represent a set of mutations across multiple rows. More...
 
class  ReadModifyWriteRule
 Define the interfaces to create ReadWriteModifyRule operations. More...
 
struct  RowKeySample
 A simple wrapper to represent the response from Table::SampleRowKeys(). More...
 
class  RowReader
 Object returned by Table::ReadRows(), enumerates rows in the response. More...
 
class  RowSet
 Represent a (possibly non-continuous) set of row keys. More...
 
class  Cell
 The in-memory representation of a Bigtable cell. More...
 
class  RowRange
 Define the interfaces to create row key ranges. More...
 
class  MutationBatcher
 Objects of this class pack single row mutations into bulk mutations. More...
 

Typedefs

using ClientOptionList = OptionList< DataEndpointOption, AdminEndpointOption, InstanceAdminEndpointOption, MinConnectionRefreshOption, MaxConnectionRefreshOption >
 The complete list of options accepted by bigtable::*Client More...
 
using Instance = ::google::bigtable::admin::v2::Instance
 
using ColumnQualifierType = std::decay< decltype(std::declval< google::bigtable::v2::Column >().qualifier())>::type
 Defines the type for column qualifiers. More...
 
using CellValueType = std::decay< decltype(std::declval< google::bigtable::v2::Cell >().value())>::type
 Defines the type for cell values. More...
 
using RowKeyType = std::decay< decltype(std::declval< google::bigtable::v2::Row >().key())>::type
 Defines the type for row keys. More...
 
using ClientUtils = bigtable::internal::UnaryClientUtils< InstanceAdminClient >
 Shortcuts to avoid typing long names over and over. More...
 

Enumerations

enum class  Consistency { kInconsistent , kConsistent }
 The result of checking replication against a given token. More...
 
enum class  MutationBranch { kPredicateNotMatched , kPredicateMatched }
 The branch taken by a Table::CheckAndMutateRow operation. More...
 

Functions

std::shared_ptr< AdminClientMakeAdminClient (std::string project, Options options={})
 Create a new table admin client configured via options. More...
 
std::shared_ptr< AdminClientCreateDefaultAdminClient (std::string project, ClientOptions options)
 Create a new table admin client configured via options. More...
 
std::shared_ptr< DataClientMakeDataClient (std::string project_id, std::string instance_id, Options options={})
 Create a new data client configured via options. More...
 
std::shared_ptr< DataClientCreateDefaultDataClient (std::string project_id, std::string instance_id, ClientOptions options)
 Create a new data client configured via options. More...
 
std::string InstanceName (std::shared_ptr< DataClient > const &client)
 Return the fully qualified instance name for the client. More...
 
std::string TableName (std::shared_ptr< DataClient > const &client, std::string const &table_id)
 Return the full table name. More...
 
constexpr int version_major ()
 The Cloud Bigtable C++ Client major version. More...
 
constexpr int version_minor ()
 The Cloud Bigtable C++ Client minor version. More...
 
constexpr int version_patch ()
 The Cloud Bigtable C++ Client patch version. More...
 
constexpr int version ()
 A single integer representing the Major/Minor/Patch version. More...
 
std::string version_string ()
 The version as a string, in MAJOR.MINOR.PATCH+gitrev format. More...
 
template<class InputIt >
google::iam::v1::Policy IamPolicy (InputIt first_binding, InputIt last_binding, std::string etag="", std::int32_t version=0)
 Create a google::iam::v1::Policy. More...
 
google::iam::v1::Policy IamPolicy (std::initializer_list< google::iam::v1::Binding > bindings, std::string etag="", std::int32_t version=0)
 Create a google::iam::v1::Policy. More...
 
google::iam::v1::Policy IamPolicy (std::vector< google::iam::v1::Binding > bindings, std::string etag="", std::int32_t version=0)
 Create a google::iam::v1::Policy. More...
 
std::ostream & operator<< (std::ostream &os, google::iam::v1::Policy const &rhs)
 
template<typename Functor >
size_t RemoveBindingsFromPolicyIf (google::iam::v1::Policy &policy, Functor pred)
 Remove all bindings matching a predicate from a policy. More...
 
void RemoveBindingFromPolicy (google::iam::v1::Policy &policy, google::protobuf::RepeatedPtrField< google::iam::v1::Binding >::iterator to_remove)
 Remove a specific binding from a policy. More...
 
bool operator== (MetadataParamTypes const &lhs, MetadataParamTypes const &rhs)
 
bool operator!= (MetadataParamTypes const &lhs, MetadataParamTypes const &rhs)
 
std::unique_ptr< PollingPolicyDefaultPollingPolicy (internal::RPCPolicyParameters defaults)
 
std::string InstanceName (std::string const &project_id, std::string const &instance_id)
 
std::string TableName (std::string const &project_id, std::string const &instance_id, std::string const &table_id)
 
std::string ClusterName (std::string const &project_id, std::string const &instance_id, std::string const &cluster_id)
 
std::string AppProfileName (std::string const &project_id, std::string const &instance_id, std::string const &app_profile_id)
 
std::string BackupName (std::string const &project_id, std::string const &instance_id, std::string const &cluster_id, std::string const &backup_id)
 
template<class InputIt >
google::iam::v1::Binding IamBinding (std::string role, InputIt begin, InputIt end)
 Create a google::iam::v1::Binding. More...
 
template<class InputIt >
google::iam::v1::Binding IamBinding (std::string role, InputIt begin, InputIt end, google::type::Expr condition)
 Create a google::iam::v1::Binding. More...
 
google::iam::v1::Binding IamBinding (std::string role, std::initializer_list< std::string > members)
 Create a google::iam::v1::Binding. More...
 
google::iam::v1::Binding IamBinding (std::string role, std::initializer_list< std::string > members, google::type::Expr condition)
 Create a google::iam::v1::Binding. More...
 
google::iam::v1::Binding IamBinding (std::string role, std::vector< std::string > members)
 Create a google::iam::v1::Binding. More...
 
google::iam::v1::Binding IamBinding (std::string role, std::vector< std::string > members, google::type::Expr condition)
 Create a google::iam::v1::Binding. More...
 
std::ostream & operator<< (std::ostream &os, google::iam::v1::Binding const &binding)
 
template<class InputIt >
google::iam::v1::Binding IamBindingAppendMembers (google::iam::v1::Binding binding, InputIt begin, InputIt end)
 Append members to a google::iam::v1::Binding. More...
 
google::iam::v1::Binding IamBindingSetCondition (google::iam::v1::Binding binding, google::type::Expr condition)
 Set a condition to an google::iam::v1::Binding. More...
 
std::shared_ptr< InstanceAdminClientMakeInstanceAdminClient (std::string project, Options options={})
 Create a new instance admin client configured via options. More...
 
std::shared_ptr< InstanceAdminClientCreateDefaultInstanceAdminClient (std::string project, ClientOptions options)
 Create a new instance admin client configured via options. More...
 
std::unique_ptr< RPCBackoffPolicyDefaultRPCBackoffPolicy (internal::RPCPolicyParameters defaults)
 Return an instance of the default RPCBackoffPolicy. More...
 
std::unique_ptr< RPCRetryPolicyDefaultRPCRetryPolicy (internal::RPCPolicyParameters defaults)
 Return an instance of the default RPCRetryPolicy. More...
 
std::unique_ptr< IdempotentMutationPolicyDefaultIdempotentMutationPolicy ()
 Return an instance of the default IdempotentMutationPolicy. More...
 
constexpr std::int64_t ServerSetTimestamp ()
 A magic value where the server sets the timestamp. More...
 
template<typename ColumnType , typename ValueType >
Mutation SetCell (std::string family, ColumnType &&column, std::chrono::milliseconds timestamp, ValueType &&value)
 Create a mutation to set a cell value. More...
 
template<typename ColumnType >
Mutation SetCell (std::string family, ColumnType &&column, std::chrono::milliseconds timestamp, std::int64_t value)
 Create a mutation to store a 64-bit big endian integer value. More...
 
template<typename ColumnType , typename ValueType >
Mutation SetCell (std::string family, ColumnType &&column, ValueType &&value)
 Create a mutation to set a cell value where the server sets the time. More...
 
template<typename ColumnType >
Mutation SetCell (std::string family, ColumnType &&column, std::int64_t value)
 Create a mutation to store a 64-bit big endian integer value. More...
 
Mutation SetCell (Cell cell)
 Create a mutation to set a cell value based on a bigtable::Cell. More...
 
bool operator== (RowRange const &lhs, RowRange const &rhs)
 
bool operator!= (RowRange const &lhs, RowRange const &rhs)
 
std::ostream & operator<< (std::ostream &os, RowRange const &x)
 Print a human-readable representation of the range, mostly for testing. More...
 
google::type::Expr Expression (std::string expression, std::string title="", std::string description="", std::string location="")
 Create a google::type::Expr. More...
 
std::ostream & operator<< (std::ostream &stream, google::type::Expr const &e)
 
google::bigtable::admin::v2::RestoreTableRequest AsProto (std::string const &instance_name, TableAdmin::RestoreTableFromInstanceParams p)
 

Variables

constexpr auto kBigtableMutationLimit = 100000
 
constexpr auto kDefaultMutationLimit = 1000
 
constexpr auto kBigtableOutstandingMutationLimit = 300000
 
constexpr auto kDefaultMaxSizePerBatch
 
constexpr auto kDefaultMaxBatches = 4
 
constexpr auto kDefaultMaxOutstandingSize
 

Detailed Description

Contains all the Cloud Bigtable C++ client APIs.