cpcloud commented on a change in pull request #10934: URL: https://github.com/apache/arrow/pull/10934#discussion_r697506852
########## File path: format/ComputeIR.fbs ########## @@ -0,0 +1,348 @@ +// Licensed to the 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. The 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. + +include "Schema.fbs"; + +namespace org.apache.arrow.flatbuf.computeir; + +/// Avoid use of org.apache.arrow.Buffer because it requires a +/// sidecar block of bytes. +table InlineBuffer { + // ulong is used to guarantee alignment and padding of `bytes` so that flatbuffers + // and other alignment sensitive blobs can be stored here + bytes: [ulong] (required); +} + +/// An expression is one of +/// - a Literal datum +/// - a reference to a Field from a Relation +/// - a call to a named function +/// On evaluation, an Expression will have either array or scalar shape. +union ExpressionImpl { + Literal, FieldRef, Call +} + +table Expression { + // Ideally we'd simply have `union Expression { Literal, FieldRef, Call }` + // but not all generators support vectors of unions so we provide minimal + // indirection to support them. + impl: ExpressionImpl (required); +} + +union Shape { + Array, Scalar +} + +table Scalar {} + +table Array { + /// Number of slots. + length: long; +} + +table Literal { + /// Shape of this literal. + /// + /// Note that this is orthogonal to type and refers to the number + /// of rows spanned by this Literal - a Literal may be Scalar shaped + /// with multiple "columns" if the type happens to be Struct. + shape: Shape (required); + + /// The type of this literal. Field is used instead of Type to pick + /// up child fields, dictionary encoding, etc. + field: Field (required); + + /// Buffers containing N elements of arrow-formatted data, where N + /// is Array.length if shape is Array or 1 if shape is Scalar. + /// XXX this can be optimized for trivial scalars later + buffers: [InlineBuffer]; + + /// If (and only if) this Literal has dictionary type, this field dictionary + /// into which the literal's indices refer. + dictionary: Literal; +} + +table FieldRef { + /// A sequence of field names to allow referencing potentially nested fields + path: [string]; + + /// For Expressions which might reference fields in multiple Relations, + /// this index may be provided to indicate which Relation's fields + /// `path` points into. For example in the case of a join, + /// 0 refers to the left relation and 1 to the right relation. + relation_index: int; + + /// The type of the referenced Field. Field is used instead of Type to pick + /// up child fields, dictionary encoding, etc. + field: Field; +} + +/// A canonical (probably SQL equivalent) function +enum CanonicalFunctionId : uint32 { + // logical + And, + Not, + Or, + + // arithmetic + Add, + Subtract, + Multiply, + Divide, + Power, + AbsoluteValue, + Negate, + Sign, + + // comparison + Equal, + NotEqual, + Greater, + GreaterOrEqual, + Less, + LessOrEqual, + + // aggregations + All, + Any, + Count, + Mean, + Min, + Max, + Mode, + Product, + Sum, + Tdigest, + Quantile, + Variance, + StandardDeviation, +} + +table CanonicalFunction { + id: CanonicalFunctionId; +} + +table NonCanonicalFunction { + name_space: string (required); + name: string (required); +} + +union Function { + CanonicalFunction, NonCanonicalFunction Review comment: I think that makes sense. We'll have to a lot more legwork to make user-defined structures a thing. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
