Viam C++ SDK current
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
viam::sdk::DataClient Class Reference

Classes

struct  tabular_data_by_mql_opts
 Options which are passed to a tabular_data_by_mql request. More...
 

Public Types

enum class  TabularDataSourceType { k_standard , k_hot_storage , k_pipeline_sink }
 
using BSONBytes = std::vector<uint8_t>
 

Public Member Functions

 DataClient (DataClient &&)=default
 
DataClientoperator= (DataClient &&)=default
 
const ViamChannelchannel () const
 
std::vector< BSONBytes > tabular_data_by_mql (const std::string &org_id, const std::vector< BSONBytes > &mql_binary, const tabular_data_by_mql_opts &opts)
 Request tabular data using an MQL query.
 
std::vector< BSONBytes > tabular_data_by_mql (const std::string &org_id, const std::vector< BSONBytes > &mql_binary)
 Convenience overload with default options.
 

Static Public Member Functions

static DataClient from_viam_client (const ViamClient &)
 

Member Function Documentation

◆ tabular_data_by_mql()

std::vector< BSONBytes > viam::sdk::DataClient::tabular_data_by_mql ( const std::string & org_id,
const std::vector< BSONBytes > & mql_binary,
const tabular_data_by_mql_opts & opts )

Request tabular data using an MQL query.

Parameters
mql_binaryA MongoDB aggregation pipeline as a list of BSON documents, each representing one stage in the pipeline.
Returns
BSON documents of unified tabular data and metadata.
Remarks
This interface deals exclusively with BSON as vectors of bytes; it is up to users to perform BSON encoding/decoding with their library of choice.

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