Package io.deephaven.proto.backplane.grpc

Interface HierarchicalTableDescriptorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HierarchicalTableDescriptor, HierarchicalTableDescriptor.Builder
public interface HierarchicalTableDescriptorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getIsStatic()
    Whether or not this table might change.
    com.google.protobuf.ByteString
    getSnapshotSchema()
    Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSnapshotSchema

      com.google.protobuf.ByteString getSnapshotSchema()
       Schema to be used for snapshot or subscription requests as described in Arrow Message.fbs::Message.
 Field metadata is used to convey additional information about the structure of the HierarchicalTable, the
 special roles some columns play, and the relationships between columns.

 "hierarchicalTable.isStructuralColumn" is always "true" if set, and is set on columns that should be included on
 every snapshot or subscription request, but should not be directly user-visible.

 "hierarchicalTable.isExpandByColumn" is always "true" if set, and is set on all the columns that must be included
 in a HierarchicalTableViewRequest's key table, if a key table is specified. These columns are generally
 user-visible and displayed before other columns, unless they also have "hierarchicalTable.isStructuralColumn" set.

 "hierarchicalTable.isRowDepthColumn" is always "true" if set, and is set on a single column that specifies the
 depth of a row. That column will always have "hierarchicalTable.isExpandByColumn" set for RollupTables, but never
 for TreeTables.

 "hierarchicalTable.isRowExpandedColumn" is always "true" if set, and is set on a single nullable column of
 booleans that specifies whether a row is expandable or expanded. Values will be null for rows that are not
 expandable, true for expanded rows, false for rows that are not expanded (but expandable). Leaf rows have no
 children to expand, and hence will always have a null value for this column.

 "rollupTable.isAggregatedNodeColumn" is always "true" if set, and is set on all columns of a RollupTable that
 belong to the aggregated nodes.

 "rollupTable.isConstituentNodeColumn" is always "true" if set, and is set on all columns of a RollupTable that
 belong to the constituent nodes. No such columns will be present if constituents are not included in the
 RollupTable.

 "rollupTable.isGroupByColumn" is always "true" if set, and is set on all columns of a RollupTable that are
 "group-by columns", whether the node is aggregated or constituent. All nodes have the same names and types for
 columns labeled in this way. Such columns will always have "hierarchicalTable.isExpandByColumn" set if and only if
 they also have "rollupTable.isAggregatedNodeColumn" set.

 "rollupTable.aggregationInputColumnName" is set to the (string) name of the corresponding constituent column that
 was used as input to this aggregation node column. May have an empty value, because some aggregations take no
 input columns, for example "Count". This is only ever present on columns with "rollupTable.isAggregatedNodeColumn"
 set.

 "treeTable.isNodeColumn" is always "true" if set, and is set on all columns of a TreeTable that nodes inherit from
 the source Table.

 "treeTable.isIdentifierColumn" is always "true" if set, and is set on the single column that uniquely identifies a
 TreeTable row and links it to its children. Such columns will always have "hierarchicalTable.isExpandByColumn"
 set.

 "treeTable.isParentIdentifierColumn" is always "true" if set, and is set on the single column that links a
 TreeTable row to its parent row.
      bytes snapshot_schema = 1;
      Returns:
      The snapshotSchema.

    • getIsStatic

      boolean getIsStatic()
       Whether or not this table might change.
      bool is_static = 2;
      Returns:
      The isStatic.