| // Licensed to Apache Software Foundation (ASF) under one or more contributor |
| // license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright |
| // ownership. Apache Software Foundation (ASF) licenses this file to you under |
| // the Apache License, Version 2.0 (the "License"); you may |
| // not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| |
| syntax = "proto3"; |
| |
| package banyandb.measure.v1; |
| |
| import "banyandb/model/v1/common.proto"; |
| import "banyandb/model/v1/query.proto"; |
| import "google/protobuf/timestamp.proto"; |
| import "validate/validate.proto"; |
| |
| option go_package = "github.com/apache/skywalking-banyandb/api/proto/banyandb/measure/v1"; |
| option java_package = "org.apache.skywalking.banyandb.measure.v1"; |
| |
| // DataPoint is stored in Measures |
| message DataPoint { |
| // timestamp is in the timeunit of milliseconds. |
| google.protobuf.Timestamp timestamp = 1; |
| // tag_families contains tags selected in the projection |
| repeated model.v1.TagFamily tag_families = 2; |
| message Field { |
| string name = 1; |
| model.v1.FieldValue value = 2; |
| } |
| // fields contains fields selected in the projection |
| repeated Field fields = 3; |
| } |
| |
| // QueryResponse is the response for a query to the Query module. |
| message QueryResponse { |
| // data_points are the actual data returned |
| repeated DataPoint data_points = 1; |
| } |
| |
| // QueryRequest is the request contract for query. |
| message QueryRequest { |
| // groups indicate where the data points are stored. |
| repeated string groups = 1 [(validate.rules).repeated.min_items = 1]; |
| // name is the identity of a measure. |
| string name = 2 [(validate.rules).string.min_len = 1]; |
| // time_range is a range query with begin/end time of entities in the timeunit of milliseconds. |
| model.v1.TimeRange time_range = 3 [(validate.rules).message.required = true]; |
| // tag_families are indexed. |
| model.v1.Criteria criteria = 4; |
| // tag_projection can be used to select tags of the data points in the response |
| model.v1.TagProjection tag_projection = 5; |
| message FieldProjection { |
| repeated string names = 1; |
| } |
| // field_projection can be used to select fields of the data points in the response |
| FieldProjection field_projection = 6; |
| message GroupBy { |
| // tag_projection must be a subset of the tag_projection of QueryRequest |
| model.v1.TagProjection tag_projection = 1; |
| // field_name must be one of fields indicated by field_projection |
| string field_name = 2; |
| } |
| // group_by groups data points based on their field value for a specific tag and use field_name as the projection name |
| GroupBy group_by = 7; |
| message Aggregation { |
| model.v1.AggregationFunction function = 1; |
| // field_name must be one of files indicated by the field_projection |
| string field_name = 2; |
| } |
| // agg aggregates data points based on a field |
| Aggregation agg = 8; |
| message Top { |
| // number set the how many items should be returned |
| int32 number = 1; |
| // field_name must be one of files indicated by the field_projection |
| string field_name = 2; |
| // field_value_sort indicates how to sort fields |
| // ASC: bottomN |
| // DESC: topN |
| // UNSPECIFIED: topN |
| model.v1.Sort field_value_sort = 3; |
| } |
| // top limits the result based on a particular field. |
| // If order_by is specified, top sorts the dataset based on order_by's output |
| Top top = 9; |
| // offset is used to support pagination, together with the following limit. |
| // If top is specified, offset processes the dataset based on top's output |
| uint32 offset = 10; |
| // limit is used to impose a boundary on the number of records being returned. |
| // If top is specified, limit processes the dataset based on top's output |
| uint32 limit = 11; |
| // order_by is given to specify the sort for a tag. |
| model.v1.QueryOrder order_by = 12; |
| } |