package frostdb.storage.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

FrostDBService is a service that allows clients to execute queries as logicalplan against an instance of FrostDB.

• rpc Query (QueryRequest, stream QueryResponse)

  storage.proto:10

  Query executes the query plan contained in the request and returns back the results as arrow records in IPC format.

  message QueryRequest

  storage.proto:14

  QueryRequest is the message sent to the Query gRPC endpoint.

  • optional PlanNode plan_root = 1

    PlanRoot is the root of the query plan (i.e. a scan node).

  • string description = 2

    description describes the query.

  message QueryResponse

  storage.proto:22

  QueryResponse is the message received from the Query gRPC endpoint.

  • bytes record = 1

    The resulting arrow record as bytes.

Aggregation describes an aggregation node.

Used in: PlanNodeSpec

• repeated Expr group_exprs = 1

  GroupExprs are the expressions to group by.

• repeated Expr agg_exprs = 2

  AggExprs are the aggregation functions applied to values of each group.

AggregationFunction is an aggregation function.

Used in: ExprDef

• AggregationFunction.Type type = 1

  type is the type of aggregation function.

• optional Expr expr = 2

  expr is the expression to aggregate.

Type is the type of aggregation function.

Used in: AggregationFunction

• TYPE_UNKNOWN_UNSPECIFIED = 0

  UNKNOWN_UNSPECIFIED is the default value. It should not be used.

• TYPE_SUM = 1

  SUM is the sum aggregation function.

• TYPE_MIN = 2

  MIN is the min aggregation function.

• TYPE_MAX = 3

  MAX is the max aggregation function.

• TYPE_COUNT = 4

  COUNT is the count aggregation function.

• TYPE_AVG = 5

  AVG is the avg aggregation function.

• TYPE_UNIQUE = 6

  UNIQUE is the unique aggregation function.

• TYPE_AND = 7

  AND is the and aggregation function.

Alias is an alias for an expression.

Used in: ExprDef

• string name = 1

  name is the name of the alias.

• optional Expr expr = 2

  expr is the expression to alias.

BinaryExpression is a binary expression.

Used in: ExprDef

• optional Expr left = 1

  left is the left operand.

• optional Expr right = 2

  right is the right operand.

• Op op = 3

  op is the operator.

Column is an explicit column in a table.

Used in: ExprDef

• string name = 1

  name is the name of the column.

ConvertExpr is an expression to convert an expression to another type.

Used in: ExprDef

• optional Expr expr = 1

  the expression to convert

• Type type = 2

  the type to convert to

Distinct describes a distinct node.

Used in: PlanNodeSpec

• repeated Expr exprs = 1

  Exprs are the expressions to distinct by.

DurationExpr is a duration expressed in milliseconds.

Used in: ExprDef

• int64 milliseconds = 1

  milliseconds is the duration in milliseconds.

DynamicColumn is a dynamic column.

Used in: ExprDef

• string name = 1

  name is the name of the dynamic column.

Expr is the base type for all expressions.

Used in: Aggregation, AggregationFunction, Alias, BinaryExpr, ConvertExpr, Distinct, Filter, IfExpr, Limit, Projection

• optional ExprDef def = 1

  def is the definition of the expression.

ExprDefinition is a definition of an expression. It is intentionally only a single field that is a oneof to maintain forward compatibility when changing fields in each of the oneofs. This message should never have any other fields for forward compatibility.

Used in: Expr

• oneof content

  content is the content of the expression definition.

  • BinaryExpr binary_expr = 1

    BinaryExpr is a binary expression.

  • Column column = 2

    Column is a column expression.

  • Literal literal = 3

    Literal is a literal expression.

  • DynamicColumn dynamic_column = 4

    DynamicColumn is a dynamic column expression.

  • AggregationFunction aggregation_function = 5

    AggregationFunction is an aggregation function expression.

  • Alias alias = 6

    Alias is an alias expression.

  • DurationExpr duration = 7

    DurationExpr is a duration expression to group by.

  • ConvertExpr convert = 8

    ConvertExpr is an expression to convert a column from one type to another.

  • IfExpr if = 9

    IfExpr is an if expression.

Filter describes a filter.

Used in: PlanNodeSpec

• optional Expr expr = 1

  Expr is the filter expression.

IfExpr represents an if expression.

Used in: ExprDef

• optional Expr condition = 1

  the condition

• optional Expr then = 2

  the true branch

• optional Expr else = 3

  the false branch

Limit describes a limit node.

Used in: PlanNodeSpec

• optional Expr expr = 1

  Expr is the expression to limit by.

Literal is a literal value.

Used in: ExprDef

• optional LiteralContent content = 1

  content is the content of the literal.

LiteralContent is the content of a literal.

Used in: Literal

• oneof value

  value is the value of the literal.

  • Null null_value = 1

    null whether the value is the null value.

  • bool bool_value = 2

    bool_value is the bool value.

  • int32 int32_value = 3

    int32_value is the int32 value.

  • uint32 uint32_value = 4

    uint32_value is the uint32 value.

  • int64 int64_value = 5

    int64_value is the int64 value.

  • uint64 uint64_value = 6

    uint64_value is the uint64 value.

  • float float_value = 7

    float_value is the float value.

  • double double_value = 8

    double_value is the double value.

  • bytes binary_value = 9

    binary_value is the binary value.

  • string string_value = 10

    string_value is the string value.

Null is the null value.

Used in: LiteralContent

(message has no fields)

Op describes a binary operator.

Used in: BinaryExpr

• OP_UNKNOWN_UNSPECIFIED = 0

  OP_UNKNOWN_UNSPECIFIED is the default value. It should not be used.

• OP_EQ = 1

  OP_EQ is the equality operator (`==`).

• OP_NOT_EQ = 2

  OP_NOT_EQ is the not-equality operator (`!=`).

• OP_LT = 3

  OP_LT is the less-than operator (`<`).

• OP_LT_EQ = 4

  OP_LT_EQ is the less-than-or-equal operator (`<=`).

• OP_GT = 5

  OP_GT is the greater-than operator (`>`).

• OP_GT_EQ = 6

  OP_GT_EQ is the greater-than-or-equal operator (`>=`).

• OP_REGEX_MATCH = 7

  OP_REGEX_MATCH is the regular expression match operator (`=~`).

• OP_REGEX_NOT_MATCH = 8

  OP_REGEX_NOT_MATCH is the regular expression not-match operator (`!~`).

• OP_AND = 9

  OP_AND is the logical and operator (`&&`).

• OP_OR = 10

  OP_OR is the logical or operator (`||`).

• OP_ADD = 11

  OP_ADD is the arithmetric addition (`+`).

• OP_SUB = 12

  OP_SUB is the arithmetric subtraction (`-`).

• OP_MUL = 13

  OP_MUL is the arithmetric multiplication (`*`).

• OP_DIV = 14

  OP_DIV is the arithmetric division (`/`).

• OP_CONTAINS = 15

  OP_CONTAINS performs substring matches.

• OP_NOT_CONTAINS = 16

  OP_NOT_CONTAINS performs substring matches.

PlanNode describes a query plan.

Used in: QueryRequest

• optional PlanNode next = 1

  Next is the next PlanNode in the plan, i.e. the node that this node should push data to.

• optional PlanNodeSpec spec = 2

  Spec is this PlanNode's spec.

PlanNodeSpec is a PlanNode's information. This is a message that wraps oneof to ensure forward compatibility: https://developers.google.com/protocol-buffers/docs/proto3#backwards-compatibility_issues

Used in: PlanNode

• oneof spec

  Spec is this PlanNode's information.

  • TableScan table_scan = 1

    TableScan is specified if this PlanNode represents a table scan.

  • SchemaScan schema_scan = 2

    SchemaScan is specified if this PlanNode represents a table scan.

  • Filter filter = 3

    Filter is specified if this PlanNode represents a filter.

  • Projection projection = 4

    Projections is specified if this PlanNode represents a projection.

  • Distinct distinct = 5

    Distinct is specified if this PlanNode represents a distinct.

  • Aggregation aggregation = 6

    Aggregation is specified if this PlanNode represents an aggregation.

  • Limit limit = 7

    Limit is specified if this PlanNode represents a limit.

Projection describes a projection node.

Used in: PlanNodeSpec

• repeated Expr exprs = 1

  Exprs are the expressions to project.

ScanBase is a collection of fields shared by scans.

Used in: SchemaScan, TableScan

• string database = 1

  Database is the name of the database to scan.

• string table = 2

  Table is the name of the table to scan.

SchemaScan describes scanning a table to obtain the schema.

Used in: PlanNodeSpec

• optional ScanBase base = 1

  Base specifies the fields shared with TableScan.

TableScan describes scanning a table to obtain rows.

Used in: PlanNodeSpec

• optional ScanBase base = 1

  Base specifies the fields shared with SchemaScan.

Apache Arrow type.

Used in: ConvertExpr

• TYPE_UNKNOWN_UNSPECIFIED = 0

  The default value, this must not occur.

• TYPE_FLOAT64 = 1

  Float64