package perspective.proto

Get desktop application:
View/edit binary Protocol Buffers messages

View types

Used in: Schema.KeyTypePair, TableValidateExprResp, ViewExpressionSchemaResp, ViewSchemaResp

• STRING = 0

• DATE = 1

• DATETIME = 2

• INTEGER = 3

• FLOAT = 4

• BOOLEAN = 5

Used in: ViewConfig

• oneof opt_columns

  • google.protobuf.NullValue default_columns = 1

  • ColumnsUpdate.Columns columns = 2

Used in: ColumnsUpdate

• repeated string columns = 1

Informs the client of the feature set, e.g. what to expect in the `ViewConfig` message.

Used in: Request

(message has no fields)

Used in: Response

• bool group_by = 1

• bool split_by = 2

• bool expressions = 3

• map<uint32, GetFeaturesResp.ColumnTypeOptions> filter_ops = 4

Used in: GetFeaturesResp

• repeated string options = 1

`Client::get_hosted_tables`

Used in: Request

• bool subscribe = 1

Used in: Response

• repeated HostedTable table_infos = 1

Used in: GetHostedTablesResp

• string entity_id = 1

• optional string index = 2

• optional uint32 limit = 3

The data type constructors Perspective supports.

Used in: MakeTableReq, TableRemoveReq, TableReplaceReq, TableUpdateReq

• oneof data

  • Schema from_schema = 1

  • string from_csv = 2

  • bytes from_arrow = 3

  • string from_rows = 4

  • string from_cols = 5

  • string from_view = 6

  • string from_ndjson = 7

`Client::table`.

Used in: Request

• optional MakeTableData data = 1

• optional MakeTableReq.MakeTableOptions options = 2

Used in: MakeTableReq

• oneof make_table_type

  • string make_index_table = 1

  • uint32 make_limit_table = 2

Used in: Response

(message has no fields)

Used in: Request

• uint32 id = 1

Used in: Response

(message has no fields)

• uint32 msg_id = 1

• string entity_id = 2

• oneof client_req

  • GetFeaturesReq get_features_req = 3

    Minimum Virtual API (theoretical).

  • GetHostedTablesReq get_hosted_tables_req = 4

  • RemoveHostedTablesUpdateReq remove_hosted_tables_update_req = 37

  • TableMakePortReq table_make_port_req = 5

  • TableMakeViewReq table_make_view_req = 6

  • TableSchemaReq table_schema_req = 7

  • TableSizeReq table_size_req = 8

  • TableValidateExprReq table_validate_expr_req = 9

  • ViewColumnPathsReq view_column_paths_req = 10

  • ViewDeleteReq view_delete_req = 11

  • ViewDimensionsReq view_dimensions_req = 12

  • ViewExpressionSchemaReq view_expression_schema_req = 13

  • ViewGetConfigReq view_get_config_req = 14

  • ViewSchemaReq view_schema_req = 15

  • ViewToArrowReq view_to_arrow_req = 16

  • ServerSystemInfoReq server_system_info_req = 17

    Optional (we can enable real-time/autocomplete/etc with these, but not required).

  • ViewCollapseReq view_collapse_req = 18

  • ViewExpandReq view_expand_req = 19

  • ViewGetMinMaxReq view_get_min_max_req = 20

  • ViewOnUpdateReq view_on_update_req = 21

  • ViewRemoveOnUpdateReq view_remove_on_update_req = 22

  • ViewSetDepthReq view_set_depth_req = 23

  • ViewToColumnsStringReq view_to_columns_string_req = 24

  • ViewToCSVReq view_to_csv_req = 25

  • ViewToRowsStringReq view_to_rows_string_req = 26

  • ViewToNdjsonStringReq view_to_ndjson_string_req = 36

  • MakeTableReq make_table_req = 27

    External (we don't need these for viewer, but the developer may).

  • TableDeleteReq table_delete_req = 28

  • TableOnDeleteReq table_on_delete_req = 29

  • TableRemoveDeleteReq table_remove_delete_req = 30

  • TableRemoveReq table_remove_req = 31

  • TableReplaceReq table_replace_req = 32

  • TableUpdateReq table_update_req = 33

  • ViewOnDeleteReq view_on_delete_req = 34

  • ViewRemoveDeleteReq view_remove_delete_req = 35

• uint32 msg_id = 1

• string entity_id = 2

• oneof client_resp

  • GetFeaturesResp get_features_resp = 3

  • GetHostedTablesResp get_hosted_tables_resp = 4

  • RemoveHostedTablesUpdateResp remove_hosted_tables_update_resp = 37

  • TableMakePortResp table_make_port_resp = 5

  • TableMakeViewResp table_make_view_resp = 6

  • TableSchemaResp table_schema_resp = 7

  • TableSizeResp table_size_resp = 8

  • TableValidateExprResp table_validate_expr_resp = 9

  • ViewColumnPathsResp view_column_paths_resp = 10

  • ViewDeleteResp view_delete_resp = 11

  • ViewDimensionsResp view_dimensions_resp = 12

  • ViewExpressionSchemaResp view_expression_schema_resp = 13

  • ViewGetConfigResp view_get_config_resp = 14

  • ViewSchemaResp view_schema_resp = 15

  • ViewToArrowResp view_to_arrow_resp = 16

  • ServerSystemInfoResp server_system_info_resp = 17

  • ViewCollapseResp view_collapse_resp = 18

  • ViewExpandResp view_expand_resp = 19

  • ViewGetMinMaxResp view_get_min_max_resp = 20

  • ViewOnUpdateResp view_on_update_resp = 21

  • ViewRemoveOnUpdateResp view_remove_on_update_resp = 22

  • ViewSetDepthResp view_set_depth_resp = 23

  • ViewToColumnsStringResp view_to_columns_string_resp = 24

  • ViewToCSVResp view_to_csv_resp = 25

  • ViewToRowsStringResp view_to_rows_string_resp = 26

  • ViewToNdjsonStringResp view_to_ndjson_string_resp = 36

  • MakeTableResp make_table_resp = 27

  • TableDeleteResp table_delete_resp = 28

  • TableOnDeleteResp table_on_delete_resp = 29

  • TableRemoveDeleteResp table_remove_delete_resp = 30

  • TableRemoveResp table_remove_resp = 31

  • TableReplaceResp table_replace_resp = 32

  • TableUpdateResp table_update_resp = 33

  • ViewOnDeleteResp view_on_delete_resp = 34

  • ViewRemoveDeleteResp view_remove_delete_resp = 35

  • ServerError server_error = 50

Filter type scalars - this is _not_ the same as a Columns scalar, as this value is used in the view config and must be JSON safe!

Used in: ViewConfig.Filter

• oneof scalar

  • bool bool = 1

  • double float = 4

    int64 date = 2; // TODO these are the wrong type int64 datetime = 3;

  • string string = 6

    int32 int = 5;

  • google.protobuf.NullValue null = 7

Used in: MakeTableData, TableSchemaResp

• repeated Schema.KeyTypePair schema = 1

Used in: Schema

• string name = 1

• ColumnType type = 2

Recoverable, user-readable error reporting from the engine.

Used in: Response

• string message = 1

• StatusCode status_code = 2

Used in: Request

(message has no fields)

Used in: Response

• double heap_size = 1

TODO This belongs in features

Used in: ViewConfig.Sort

• SORT_NONE = 0

• SORT_ASC = 1

• SORT_DESC = 2

• SORT_COL_ASC = 3

• SORT_COL_DESC = 4

• SORT_ASC_ABS = 5

• SORT_DESC_ABS = 6

• SORT_COL_ASC_ABS = 7

• SORT_COL_DESC_ABS = 8

Used in: ServerError

• SERVER_ERROR = 0

• VIEW_NOT_FOUND = 1

`Table::delete`

Used in: Request

• bool is_immediate = 1

Used in: Response

(message has no fields)

`Table::make_port`

Used in: Request

(message has no fields)

Used in: Response

• uint32 port_id = 1

`Table::view`

Used in: Request

• string view_id = 1

• optional ViewConfig config = 2

Used in: Response

• string view_id = 1

`Table::on_delete`

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

`Table::remove_delete`

Used in: Request

• uint32 id = 1

Used in: Response

(message has no fields)

`Table::remove`

Used in: Request

• optional MakeTableData data = 1

Used in: Response

(message has no fields)

`Table::replace`

Used in: Request

• optional MakeTableData data = 1

Used in: Response

(message has no fields)

`Table::schema`

Used in: Request

(message has no fields)

Used in: Response

• optional Schema schema = 1

`Table::size`

Used in: Request

(message has no fields)

Used in: Response

• uint32 size = 2

`Table::update`

Used in: Request

• optional MakeTableData data = 1

• uint32 port_id = 2

Used in: Response

(message has no fields)

`Table::validate_expressions` TODO: This should be just `validate()`

Used in: Request

• map<string, string> column_to_expr = 1

Used in: Response

• map<string, ColumnType> expression_schema = 1

• map<string, TableValidateExprResp.ExprValidationError> errors = 2

• map<string, string> expression_alias = 3

Used in: TableValidateExprResp

• string error_message = 1

• uint32 line = 2

• uint32 column = 3

Used in: Request

• uint32 row_index = 1

Used in: Response

• uint32 num_changed = 1

Used in: Request

(message has no fields)

Used in: Response

• repeated string paths = 1

  repeated ColumnPath paths = 1;

Used in: TableMakeViewReq, ViewGetConfigResp

• repeated string group_by = 1

• repeated string split_by = 2

• optional ColumnsUpdate columns = 3

• repeated ViewConfig.Filter filter = 4

• repeated ViewConfig.Sort sort = 5

• map<string, string> expressions = 6

• map<string, ViewConfig.AggList> aggregates = 7

• ViewConfig.FilterReducer filter_op = 8

• optional uint32 group_by_depth = 9

Used in: ViewConfig

• repeated string aggregations = 1

Used in: ViewConfig

• string column = 1

• string op = 2

• repeated Scalar value = 3

Used in: ViewConfig

• AND = 0

• OR = 1

Used in: ViewConfig

• string column = 1

• SortOp op = 2

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

`View::dimensions`

Used in: Request

(message has no fields)

Used in: Response

• uint32 num_table_rows = 1

• uint32 num_table_columns = 2

• uint32 num_view_rows = 3

• uint32 num_view_columns = 4

Used in: Request

• uint32 row_index = 1

Used in: Response

• uint32 num_changed = 1

Used in: Request

(message has no fields)

Used in: Response

• map<string, ColumnType> schema = 1

`View::get_config`

Used in: Request

(message has no fields)

Used in: Response

• optional ViewConfig config = 1

Used in: Request

• string column_name = 1

Used in: Response

• string min = 1

• string max = 2

Used in: Request

(message has no fields)

Used in: Response

(message has no fields)

Used in: Request

• optional ViewOnUpdateReq.Mode mode = 1

Used in: ViewOnUpdateReq

• ROW = 0

Used in: Response

• optional bytes delta = 1

• uint32 port_id = 2

Options for requresting a slice of data, starting with the rectangular viewport.

Used in: ViewToArrowReq, ViewToCSVReq, ViewToColumnsStringReq, ViewToNdjsonStringReq, ViewToRowsStringReq

• optional uint32 start_row = 1

• optional uint32 start_col = 2

• optional uint32 end_row = 3

• optional uint32 end_col = 4

  optional bool id = 5; optional bool index = 3; optional bool formatted = 6; optional bool leaves_only = 7; optional bool compression = 3;

Used in: Request

• uint32 id = 1

Used in: Response

(message has no fields)

Used in: Request

• uint32 id = 1

Used in: Response

(message has no fields)

`View::schema`

Used in: Request

(message has no fields)

Used in: Response

• map<string, ColumnType> schema = 1

`View::set_depth`

Used in: Request

• uint32 depth = 1

Used in: Response

(message has no fields)

Used in: Request

• optional ViewPort viewport = 1

• optional string compression = 2

Used in: Response

• bytes arrow = 1

Used in: Request

• optional ViewPort viewport = 1

Used in: Response

• string csv = 1

Used in: Request

• optional ViewPort viewport = 1

• optional bool id = 2

• optional bool index = 3

• optional bool formatted = 4

• optional bool leaves_only = 5

Used in: Response

• string json_string = 1

Used in: Request

• optional ViewPort viewport = 1

• optional bool id = 2

• optional bool index = 3

• optional bool formatted = 4

• optional bool leaves_only = 5

Used in: Response

• string ndjson_string = 1

Used in: Request

• optional ViewPort viewport = 1

• optional bool id = 2

• optional bool index = 3

• optional bool formatted = 4

• optional bool leaves_only = 5

Used in: Response

• string json_string = 1