dongjoon-hyun commented on a change in pull request #24851: [SPARK-27303][GRAPH] Add Spark Graph API URL: https://github.com/apache/spark/pull/24851#discussion_r333345612
########## File path: graph/api/src/main/scala/org/apache/spark/graph/api/CypherSession.scala ########## @@ -0,0 +1,263 @@ +/* + * 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.graph.api + +import scala.collection.JavaConverters._ + +import org.apache.spark.internal.Logging +import org.apache.spark.sql.{DataFrame, SaveMode, SparkSession} +import org.apache.spark.sql.types.{BooleanType, StructType} + +/** + * Contains constants used for convention based column naming. + */ +object CypherSession { + + /** + * Naming convention for identifier columns, both node and relationship identifiers. + */ + val ID_COLUMN = "$ID" + + /** + * Naming convention for relationship source identifier. + */ + val SOURCE_ID_COLUMN = "$SOURCE_ID" + + /** + * Naming convention for relationship target identifier. + */ + val TARGET_ID_COLUMN = "$TARGET_ID" + + /** + * Naming convention both for node label and relationship type prefixes. + */ + val LABEL_COLUMN_PREFIX = ":" +} + +/** + * A CypherSession allows for creating, storing and loading [[PropertyGraph]] instances as well as + * executing Cypher queries on them. + * + * Wraps a [[org.apache.spark.sql.SparkSession]]. + * + * @since 3.0.0 + */ +trait CypherSession extends Logging { + + def sparkSession: SparkSession + + /** + * Executes a Cypher query on the given input graph. + * + * @see <a href="https://neo4j.com/docs/cypher-manual/current/";>Cypher Manual</a> + * @param graph [[PropertyGraph]] on which the query is executed + * @param query Cypher query to execute + * @since 3.0.0 + */ + def cypher(graph: PropertyGraph, query: String): CypherResult + + /** + * Executes a Cypher query on the given input graph. + * + * Note that queries can take optional parameters: + * + * {{{ + * Parameters: + * + * { + * "name" : "Alice" + * } + * + * Query: + * + * MATCH (n:Person) + * WHERE n.name = $name + * RETURN n + * }}} + * + * @see <a href="https://neo4j.com/docs/cypher-manual/current/";>Cypher Manual</a> + * @see <a href="https://neo4j.com/docs/cypher-manual/current/syntax/parameters/";>Parameters</a> Review comment: Let's remove these two lines. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
