spark package 源码

spark package 代码

文件路径：/connector/connect/src/main/scala/org/apache/spark/sql/connect/dsl/package.scala

/*
 * 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.
 */
package org.apache.spark.sql.connect

import scala.collection.JavaConverters._
import scala.language.implicitConversions

import org.apache.spark.connect.proto
import org.apache.spark.connect.proto.Join.JoinType
import org.apache.spark.sql.SaveMode
import org.apache.spark.sql.connect.planner.DataTypeProtoConverter

/**
 * A collection of implicit conversions that create a DSL for constructing connect protos.
 */

package object dsl {

  object expressions { // scalastyle:ignore
    implicit class DslString(val s: String) {
      def protoAttr: proto.Expression =
        proto.Expression
          .newBuilder()
          .setUnresolvedAttribute(
            proto.Expression.UnresolvedAttribute
              .newBuilder()
              .setUnparsedIdentifier(s))
          .build()

      def struct(
          attrs: proto.Expression.QualifiedAttribute*): proto.Expression.QualifiedAttribute = {
        val structExpr = proto.DataType.Struct.newBuilder()
        for (attr <- attrs) {
          val structField = proto.DataType.StructField.newBuilder()
          structField.setName(attr.getName)
          structField.setType(attr.getType)
          structExpr.addFields(structField)
        }
        proto.Expression.QualifiedAttribute
          .newBuilder()
          .setName(s)
          .setType(proto.DataType.newBuilder().setStruct(structExpr))
          .build()
      }

      /** Creates a new AttributeReference of type int */
      def int: proto.Expression.QualifiedAttribute = protoQualifiedAttrWithType(
        proto.DataType.newBuilder().setI32(proto.DataType.I32.newBuilder()).build())

      private def protoQualifiedAttrWithType(
          dataType: proto.DataType): proto.Expression.QualifiedAttribute =
        proto.Expression.QualifiedAttribute
          .newBuilder()
          .setName(s)
          .setType(dataType)
          .build()
    }

    implicit class DslExpression(val expr: proto.Expression) {
      def as(alias: String): proto.Expression = proto.Expression
        .newBuilder()
        .setAlias(proto.Expression.Alias.newBuilder().setName(alias).setExpr(expr))
        .build()

      def <(other: proto.Expression): proto.Expression =
        proto.Expression
          .newBuilder()
          .setUnresolvedFunction(
            proto.Expression.UnresolvedFunction
              .newBuilder()
              .addParts("<")
              .addArguments(expr)
              .addArguments(other))
          .build()
    }

    /**
     * Create an unresolved function from name parts.
     *
     * @param nameParts
     * @param args
     * @return
     *   Expression wrapping the unresolved function.
     */
    def callFunction(nameParts: Seq[String], args: Seq[proto.Expression]): proto.Expression = {
      proto.Expression
        .newBuilder()
        .setUnresolvedFunction(
          proto.Expression.UnresolvedFunction
            .newBuilder()
            .addAllParts(nameParts.asJava)
            .addAllArguments(args.asJava))
        .build()
    }

    /**
     * Creates an UnresolvedFunction from a single identifier.
     *
     * @param name
     * @param args
     * @return
     *   Expression wrapping the unresolved function.
     */
    def callFunction(name: String, args: Seq[proto.Expression]): proto.Expression = {
      proto.Expression
        .newBuilder()
        .setUnresolvedFunction(
          proto.Expression.UnresolvedFunction
            .newBuilder()
            .addParts(name)
            .addAllArguments(args.asJava))
        .build()
    }

    implicit def intToLiteral(i: Int): proto.Expression =
      proto.Expression
        .newBuilder()
        .setLiteral(proto.Expression.Literal.newBuilder().setI32(i))
        .build()
  }

  object commands { // scalastyle:ignore
    implicit class DslCommands(val logicalPlan: proto.Relation) {
      def write(
          format: Option[String] = None,
          path: Option[String] = None,
          tableName: Option[String] = None,
          mode: Option[String] = None,
          sortByColumns: Seq[String] = Seq.empty,
          partitionByCols: Seq[String] = Seq.empty,
          bucketByCols: Seq[String] = Seq.empty,
          numBuckets: Option[Int] = None): proto.Command = {
        val writeOp = proto.WriteOperation.newBuilder()
        format.foreach(writeOp.setSource(_))

        mode
          .map(SaveMode.valueOf(_))
          .map(DataTypeProtoConverter.toSaveModeProto(_))
          .foreach(writeOp.setMode(_))

        if (tableName.nonEmpty) {
          tableName.foreach(writeOp.setTableName(_))
        } else {
          path.foreach(writeOp.setPath(_))
        }
        sortByColumns.foreach(writeOp.addSortColumnNames(_))
        partitionByCols.foreach(writeOp.addPartitioningColumns(_))

        if (numBuckets.nonEmpty && bucketByCols.nonEmpty) {
          val op = proto.WriteOperation.BucketBy.newBuilder()
          numBuckets.foreach(op.setNumBuckets(_))
          bucketByCols.foreach(op.addBucketColumnNames(_))
          writeOp.setBucketBy(op.build())
        }
        writeOp.setInput(logicalPlan)
        proto.Command.newBuilder().setWriteOperation(writeOp.build()).build()
      }
    }
  }

  object plans { // scalastyle:ignore
    implicit class DslLogicalPlan(val logicalPlan: proto.Relation) {
      def select(exprs: proto.Expression*): proto.Relation = {
        proto.Relation
          .newBuilder()
          .setProject(
            proto.Project
              .newBuilder()
              .setInput(logicalPlan)
              .addAllExpressions(exprs.toIterable.asJava)
              .build())
          .build()
      }

      def limit(limit: Int): proto.Relation = {
        proto.Relation
          .newBuilder()
          .setLimit(
            proto.Limit
              .newBuilder()
              .setInput(logicalPlan)
              .setLimit(limit))
          .build()
      }

      def offset(offset: Int): proto.Relation = {
        proto.Relation
          .newBuilder()
          .setOffset(
            proto.Offset
              .newBuilder()
              .setInput(logicalPlan)
              .setOffset(offset))
          .build()
      }

      def where(condition: proto.Expression): proto.Relation = {
        proto.Relation
          .newBuilder()
          .setFilter(proto.Filter.newBuilder().setInput(logicalPlan).setCondition(condition))
          .build()
      }

      def join(
          otherPlan: proto.Relation,
          joinType: JoinType = JoinType.JOIN_TYPE_INNER,
          condition: Option[proto.Expression] = None): proto.Relation = {
        val relation = proto.Relation.newBuilder()
        val join = proto.Join.newBuilder()
        join
          .setLeft(logicalPlan)
          .setRight(otherPlan)
          .setJoinType(joinType)
        if (condition.isDefined) {
          join.setJoinCondition(condition.get)
        }
        relation.setJoin(join).build()
      }

      def as(alias: String): proto.Relation = {
        proto.Relation
          .newBuilder(logicalPlan)
          .setCommon(proto.RelationCommon.newBuilder().setAlias(alias))
          .build()
      }

      def sample(
          lowerBound: Double,
          upperBound: Double,
          withReplacement: Boolean,
          seed: Long): proto.Relation = {
        proto.Relation
          .newBuilder()
          .setSample(
            proto.Sample
              .newBuilder()
              .setInput(logicalPlan)
              .setUpperBound(upperBound)
              .setLowerBound(lowerBound)
              .setWithReplacement(withReplacement)
              .setSeed(seed))
          .build()
      }

      def groupBy(groupingExprs: proto.Expression*)(
          aggregateExprs: proto.Expression*): proto.Relation = {
        val agg = proto.Aggregate.newBuilder()
        agg.setInput(logicalPlan)

        for (groupingExpr <- groupingExprs) {
          agg.addGroupingExpressions(groupingExpr)
        }
        // TODO: support aggregateExprs, which is blocked by supporting any builtin function
        // resolution only by name in the analyzer.
        proto.Relation.newBuilder().setAggregate(agg.build()).build()
      }
    }
  }
}

相关信息

spark 源码目录

相关文章

spark ArrayWrappers 源码

spark InMemoryStore 源码

spark KVIndex 源码

spark KVStore 源码

spark KVStoreIterator 源码

spark KVStoreSerializer 源码

spark KVStoreView 源码

spark KVTypeInfo 源码

spark LevelDB 源码

spark LevelDBIterator 源码