HyukjinKwon commented on code in PR #37710: URL: https://github.com/apache/spark/pull/37710#discussion_r977268571
########## connect/src/main/protobuf/spark/connect/base.proto: ########## @@ -0,0 +1,127 @@ +/* + * 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. + */ + +syntax = 'proto3'; + +package spark.connect; + +import "spark/connect/commands.proto"; +import "spark/connect/relations.proto"; + +option java_multiple_files = true; +option java_package = "org.apache.spark.connect.proto"; +option go_package = "github.com/databricks/spark-connect/proto"; + + +// A [[Plan]] is the structure that carries the runtime information for the execution from the +// client to the server. A [[Plan]] can either be of the type [[Relation]] which is a reference +// to the underlying logical plan or it can be of the [[Command]] type that is used to execute +// commands on the server. +message Plan { + oneof op_type { + Relation root = 1; + Command command = 2; + } +} + +// A request to be executed by the service. +message Request { + // The client_id is set by the client to be able to collate streaming responses from + // different queries. + string client_id = 1; + // User context + UserContext user_context = 2; + // The logical plan to be executed / analyzed. + Plan plan = 3; + + // User Context is used to refer to one particular user session that is executing + // queries in the backend. + message UserContext { + string user_id = 1; + string user_name = 2; + } +} + +// The response of a query, can be one or more for each request. Responses belonging to the +// same input query, carry the same `client_id`. +message Response { + string client_id = 1; + + // Result type + oneof result_type { + ArrowBatch batch = 2; + CSVBatch csv_batch = 3; + } + + // Metrics for the query execution. Typically, this field is only present in the last + // batch of results and then represent the overall state of the query execution. + Metrics metrics = 4; + + // Batch results of metrics. + message ArrowBatch { + int64 row_count = 1; + int64 uncompressed_bytes = 2; + int64 compressed_bytes = 3; + bytes data = 4; + bytes schema = 5; + } + + message CSVBatch { Review Comment: I think CSV is more consistent -- 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: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
