Trait DataSourceService

pub trait DataSourceService {
    // Required methods
    fn search_channels(
        &self,
        auth_: BearerToken,
        query: SearchChannelsRequest,
    ) -> Result<SearchChannelsResponse, Error>;
    fn search_filtered_channels(
        &self,
        auth_: BearerToken,
        query: SearchFilteredChannelsRequest,
    ) -> Result<SearchFilteredChannelsResponse, Error>;
    fn search_hierarchical_channels(
        &self,
        auth_: BearerToken,
        query: SearchHierarchicalChannelsRequest,
    ) -> Result<SearchHierarchicalChannelsResponse, Error>;
    fn index_channel_prefix_tree(
        &self,
        auth_: BearerToken,
        request: IndexChannelPrefixTreeRequest,
    ) -> Result<ChannelPrefixTree, Error>;
    fn batch_get_channel_prefix_trees(
        &self,
        auth_: BearerToken,
        request: BatchGetChannelPrefixTreeRequest,
    ) -> Result<BatchGetChannelPrefixTreeResponse, Error>;
    fn get_available_tags_for_channel(
        &self,
        auth_: BearerToken,
        request: GetAvailableTagsForChannelRequest,
    ) -> Result<GetAvailableTagsForChannelResponse, Error>;
    fn get_data_scope_bounds(
        &self,
        auth_: BearerToken,
        request: BatchGetDataScopeBoundsRequest,
    ) -> Result<BatchGetDataScopeBoundsResponse, Error>;
    fn get_tag_values_for_data_source(
        &self,
        auth_: BearerToken,
        data_source_rid: DataSourceRid,
        request: GetTagValuesForDataSourceRequest,
    ) -> Result<BTreeMap<TagName, BTreeSet<TagValue>>, Error>;
}

Data sources are data input to runs, including databases, CSV, video, and streaming data. They contain channels that represent the series data. The DataSource Service is responsible for indexing and searching channels across data sources.

Required Methods

fn search_channels( &self, auth_: BearerToken, query: SearchChannelsRequest, ) -> Result<SearchChannelsResponse, Error>

Returns channels that match the search criteria. Results are sorted by similarity score.

fn search_filtered_channels( &self, auth_: BearerToken, query: SearchFilteredChannelsRequest, ) -> Result<SearchFilteredChannelsResponse, Error>

Returns channels that match the search criteria. Results are sorted by similarity score.

fn search_hierarchical_channels( &self, auth_: BearerToken, query: SearchHierarchicalChannelsRequest, ) -> Result<SearchHierarchicalChannelsResponse, Error>

Returns only channels that are direct children of the parent. Returns results sorted alphabetically.

fn index_channel_prefix_tree( &self, auth_: BearerToken, request: IndexChannelPrefixTreeRequest, ) -> Result<ChannelPrefixTree, Error>

Indexes the channel prefix tree for a specified data source. This operation constructs a prefix tree from the channels available in the data source.

fn batch_get_channel_prefix_trees( &self, auth_: BearerToken, request: BatchGetChannelPrefixTreeRequest, ) -> Result<BatchGetChannelPrefixTreeResponse, Error>

Returns the channel prefix tree for each of the specified data sources. If the tree for a data source has not been indexed, it will be omitted from the map.

fn get_available_tags_for_channel( &self, auth_: BearerToken, request: GetAvailableTagsForChannelRequest, ) -> Result<GetAvailableTagsForChannelResponse, Error>

Returns the the set of all tag keys and their values that are available for the specified channel given an initial set of filters.

fn get_data_scope_bounds( &self, auth_: BearerToken, request: BatchGetDataScopeBoundsRequest, ) -> Result<BatchGetDataScopeBoundsResponse, Error>

Returns the maximum data timestamps for the specified data scopes. Responses are returned in the same order as requests.

fn get_tag_values_for_data_source( &self, auth_: BearerToken, data_source_rid: DataSourceRid, request: GetTagValuesForDataSourceRequest, ) -> Result<BTreeMap<TagName, BTreeSet<TagValue>>, Error>

Returns available tag values for a given data source for a set of tag keys. For Nominal data sources, a time range can be provided to filter tag values to those present within the months spanned by the range. If no time range is provided, this defaults to the last month. For external data sources, the range must not be specified, as all tag values are returned.

Implementors