vortex-proto 0.69.0

Protocol buffer definitions for Vortex types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

syntax = "proto3";

package vortex.expr;

import "scalar.proto";
import "dtype.proto";

option java_package = "dev.vortex.proto";
option java_outer_classname = "ExprProtos";

// Captures a generic representation of expressions in Vortex.
// Expression deserializers can be registered with a Vortex session to handle parsing this into
// an in-memory expression for execution.
message Expr {
  string id = 1;
  repeated Expr children = 2;
  optional bytes metadata = 3;
}

// Captures a serialized aggregate function with its ID and options metadata.
message AggregateFn {
  string id = 1;
  optional bytes metadata = 2;
}

// Options for `vortex.literal`
message LiteralOpts {
  vortex.scalar.Scalar value = 1;
}

// Options for `vortex.pack`
message PackOpts {
  repeated string paths = 1;
  bool nullable = 2;
}

// Options for `vortex.getitem`
message GetItemOpts {
  string path = 1;
}

// Options for `vortex.binary`
message BinaryOpts {
  BinaryOp op = 1;

  enum BinaryOp {
    Eq = 0;
    NotEq = 1;
    Gt = 2;
    Gte = 3;
    Lt = 4;
    Lte = 5;
    And = 6;
    Or = 7;
    Add = 8;
    Sub = 9;
    Mul = 10;
    Div = 11;
  }
}

message BetweenOpts {
  bool lower_strict = 1;
  bool upper_strict = 2;
}

message LikeOpts {
  bool negated = 1;
  bool case_insensitive = 2;
}

message CastOpts {
  vortex.dtype.DType target = 1;
}

message FieldNames {
  repeated string names = 1;
}

message SelectOpts {
  oneof opts {
    FieldNames include = 1;
    FieldNames exclude = 2;
  }
}

// Options for `vortex.case_when`
// Encodes num_when_then_pairs and has_else into a single u32 (num_children).
// num_children = num_when_then_pairs * 2 + (has_else ? 1 : 0)
// has_else = num_children % 2 == 1
// num_when_then_pairs = num_children / 2
message CaseWhenOpts {
  uint32 num_children = 1;
}