Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add edge reader by ngql #57

Merged
merged 6 commits into from
Oct 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Nebula Spark Connector 2.0/3.0 only supports Nebula Graph 2.x/3.x. If you are us
$ mvn clean package -Dmaven.test.skip=true -Dgpg.skip -Dmaven.javadoc.skip=true
```

After the packaging, you can see the newly generated nebula-spark-connector-3.0-SNAPSHOT.jar under the nebula-spark-connector/nebula-spark-connector/target/ directory.
After the packaging, you can see the newly generated nebula-spark-connector-3.0.0.jar under the nebula-spark-connector/nebula-spark-connector/target/ directory.

## New Features (Compared to Nebula Spark Connector 1.0)
* Supports more connection configurations, such as timeout, connectionRetry, and executionRetry.
Expand All @@ -33,7 +33,7 @@ Nebula Spark Connector 2.0/3.0 only supports Nebula Graph 2.x/3.x. If you are us
<dependency>
<groupId>com.vesoft</groupId>
<artifactId>nebula-spark-connector</artifactId>
<version>3.0-SNAPSHOT</version>
<version>3.0.0</version>
</dependency>
```

Expand Down
4 changes: 2 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Nebula Spark Connector 2.0/3.0 仅支持 Nebula Graph 2.x/3.x。如果您正在
$ mvn clean package -Dmaven.test.skip=true -Dgpg.skip -Dmaven.javadoc.skip=true
```

编译打包完成后,可以在 nebula-spark-connector/nebula-spark-connector/target/ 目录下看到 nebula-spark-connector-3.0-SNAPSHOT.jar 文件。
编译打包完成后,可以在 nebula-spark-connector/nebula-spark-connector/target/ 目录下看到 nebula-spark-connector-3.0.0.jar 文件。

## 特性

Expand All @@ -32,7 +32,7 @@ Nebula Spark Connector 2.0/3.0 仅支持 Nebula Graph 2.x/3.x。如果您正在
<dependency>
<groupId>com.vesoft</groupId>
<artifactId>nebula-spark-connector</artifactId>
<version>3.0-SNAPSHOT</version>
<version>3.0.0</version>
</dependency>
```

Expand Down
2 changes: 1 addition & 1 deletion example/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>nebula-spark</artifactId>
<groupId>com.vesoft</groupId>
<version>3.0-SNAPSHOT</version>
<version>3.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
4 changes: 2 additions & 2 deletions nebula-spark-connector/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>nebula-spark</artifactId>
<groupId>com.vesoft</groupId>
<version>3.0-SNAPSHOT</version>
<version>3.0.0</version>
<relativePath>../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand All @@ -14,7 +14,7 @@

<properties>
<spark.version>2.4.4</spark.version>
<nebula.version>3.0-SNAPSHOT</nebula.version>
<nebula.version>3.0.0</nebula.version>
<compiler.source.version>1.8</compiler.source.version>
<compiler.target.version>1.8</compiler.target.version>
<scalatest.version>3.2.3</scalatest.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -670,20 +670,35 @@ object WriteNebulaEdgeConfig {
* you can set noColumn to true to read no vertex col, and you can set returnCols to read the specific cols, if the returnCols is empty, then read all the columns.
* you can set partitionNum to define spark partition nums to read nebula graph.
*/
class ReadNebulaConfig(space: String,
label: String,
returnCols: List[String],
noColumn: Boolean,
partitionNum: Int,
limit: Int)
extends Serializable {
def getSpace = space
def getLabel = label
def getReturnCols = returnCols
def getNoColumn = noColumn
def getPartitionNum = partitionNum
def getLimit = limit
class ReadNebulaConfig extends Serializable {
var getSpace: String = _
var getLabel: String = _
var getReturnCols: List[String] = _
var getNoColumn: Boolean = _
var getPartitionNum: Int = _
var getLimit: Int = _
var getNgql: String = _
// todo add filter
def this(space: String, label: String, returnCols: List[String], noColumn: Boolean, partitionNum: Int, limit: Int) = {
this()
this.getSpace = space
this.getLabel = label
this.getReturnCols = returnCols
this.getNoColumn = noColumn
this.getPartitionNum = partitionNum
this.getLimit = limit
}

def this(space: String, label: String, returnCols: List[String], noColumn: Boolean, ngql: String, limit: Int)={
this()
this.getNgql = ngql
this.getSpace = space
this.getLabel = label
this.getReturnCols = returnCols
this.getNoColumn = noColumn
this.getLimit = limit
this.getPartitionNum = 1
}
}

/**
Expand All @@ -699,6 +714,7 @@ object ReadNebulaConfig {
var noColumn: Boolean = false
var partitionNum: Int = 100
var limit: Int = 1000
var ngql: String = _

def withSpace(space: String): ReadConfigBuilder = {
this.space = space
Expand Down Expand Up @@ -740,9 +756,19 @@ object ReadNebulaConfig {
this
}

def withNgql(ngql: String): ReadConfigBuilder = {
this.ngql = ngql
this
}

def build(): ReadNebulaConfig = {
check()
new ReadNebulaConfig(space, label, returnCols.toList, noColumn, partitionNum, limit)
if(ngql!=null && !ngql.isEmpty){
new ReadNebulaConfig(space,label,returnCols.toList,noColumn,ngql,limit)
}
else {
new ReadNebulaConfig(space, label, returnCols.toList, noColumn, partitionNum, limit)
}
}

private def check(): Unit = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@ package com.vesoft.nebula.connector

import java.util.Map.Entry
import java.util.Optional

import com.vesoft.nebula.connector.exception.IllegalOptionException
import com.vesoft.nebula.connector.reader.{NebulaDataSourceEdgeReader, NebulaDataSourceVertexReader}
import com.vesoft.nebula.connector.reader.{NebulaDataSourceEdgeReader, NebulaDataSourceNgqlEdgeReader, NebulaDataSourceVertexReader}
import com.vesoft.nebula.connector.writer.{NebulaDataSourceEdgeWriter, NebulaDataSourceVertexWriter}
import org.apache.spark.sql.SaveMode
import org.apache.spark.sql.catalyst.util.CaseInsensitiveMap
Expand Down Expand Up @@ -46,6 +45,8 @@ class NebulaDataSource

if (DataTypeEnum.VERTEX == DataTypeEnum.withName(dataType)) {
new NebulaDataSourceVertexReader(nebulaOptions)
} else if (nebulaOptions.ngql != null && nebulaOptions.ngql.nonEmpty) {
new NebulaDataSourceNgqlEdgeReader(nebulaOptions)
} else {
new NebulaDataSourceEdgeReader(nebulaOptions)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -109,11 +109,19 @@ class NebulaOptions(@transient val parameters: CaseInsensitiveMap[String])(
var partitionNums: String = _
var noColumn: Boolean = _
var limit: Int = _
var ngql: String = _
if (operaType == OperaType.READ) {
returnCols = parameters(RETURN_COLS)
noColumn = parameters.getOrElse(NO_COLUMN, false).toString.toBoolean
partitionNums = parameters(PARTITION_NUMBER)
limit = parameters.getOrElse(LIMIT, DEFAULT_LIMIT).toString.toInt
ngql = parameters.getOrElse(NGQL,EMPTY_STRING)
ngql = parameters.getOrElse(NGQL,EMPTY_STRING)
if(ngql!=EMPTY_STRING){
require(parameters.isDefinedAt(GRAPH_ADDRESS),
s"option $GRAPH_ADDRESS is required for ngql and can not be blank")
graphAddress = parameters(GRAPH_ADDRESS)
}
}

/** write parameters */
Expand Down Expand Up @@ -236,6 +244,9 @@ object NebulaOptions {
val PARTITION_NUMBER: String = "partitionNumber"
val LIMIT: String = "limit"

/** read by ngql **/
val NGQL: String = "ngql"

/** write config */
val RATE_LIMIT: String = "rateLimit"
val VID_POLICY: String = "vidPolicy"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,45 @@ package object connector {
dfReader.load()
}

/**
* Reading edges from Nebula Graph by ngql
* @return DataFrame
*/
def loadEdgesToDfByNgql(): DataFrame = {
assert(connectionConfig != null && readConfig != null,
"nebula config is not set, please call nebula() before loadEdgesToDF")

val dfReader = reader
.format(classOf[NebulaDataSource].getName)
.option(NebulaOptions.TYPE, DataTypeEnum.EDGE.toString)
.option(NebulaOptions.SPACE_NAME, readConfig.getSpace)
.option(NebulaOptions.LABEL, readConfig.getLabel)
.option(NebulaOptions.RETURN_COLS, readConfig.getReturnCols.mkString(","))
.option(NebulaOptions.NO_COLUMN, readConfig.getNoColumn)
.option(NebulaOptions.LIMIT, readConfig.getLimit)
.option(NebulaOptions.PARTITION_NUMBER, readConfig.getPartitionNum)
.option(NebulaOptions.NGQL, readConfig.getNgql)
.option(NebulaOptions.META_ADDRESS, connectionConfig.getMetaAddress)
.option(NebulaOptions.GRAPH_ADDRESS, connectionConfig.getGraphAddress)
.option(NebulaOptions.TIMEOUT, connectionConfig.getTimeout)
.option(NebulaOptions.CONNECTION_RETRY, connectionConfig.getConnectionRetry)
.option(NebulaOptions.EXECUTION_RETRY, connectionConfig.getExecRetry)
.option(NebulaOptions.ENABLE_META_SSL, connectionConfig.getEnableMetaSSL)
.option(NebulaOptions.ENABLE_STORAGE_SSL, connectionConfig.getEnableStorageSSL)

if (connectionConfig.getEnableStorageSSL || connectionConfig.getEnableMetaSSL) {
dfReader.option(NebulaOptions.SSL_SIGN_TYPE, connectionConfig.getSignType)
SSLSignType.withName(connectionConfig.getSignType) match {
case SSLSignType.CA =>
dfReader.option(NebulaOptions.CA_SIGN_PARAM, connectionConfig.getCaSignParam)
case SSLSignType.SELF =>
dfReader.option(NebulaOptions.SELF_SIGN_PARAM, connectionConfig.getSelfSignParam)
}
}

dfReader.load()
}

/**
* read nebula vertex edge to graphx's vertex
* use hash() for String type vertex id.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
package com.vesoft.nebula.connector.reader

import com.vesoft.nebula.Value
import com.vesoft.nebula.client.graph.data.{Relationship, ResultSet, ValueWrapper}
import com.vesoft.nebula.connector.NebulaUtils.NebulaValueGetter
import com.vesoft.nebula.connector.nebula.GraphProvider
import com.vesoft.nebula.connector.{NebulaOptions, NebulaUtils}
import org.apache.spark.sql.catalyst.InternalRow
import org.apache.spark.sql.catalyst.expressions.SpecificInternalRow
import org.apache.spark.sql.sources.v2.reader.InputPartitionReader
import org.apache.spark.sql.types.StructType
import org.slf4j.{Logger, LoggerFactory}

import scala.collection.JavaConversions.asScalaBuffer
import scala.collection.mutable
import scala.collection.mutable.ListBuffer

/**
* create reader by ngql
*/
class NebulaNgqlEdgePartitionReader extends InputPartitionReader[InternalRow] {

private val LOG: Logger = LoggerFactory.getLogger(this.getClass)

private var nebulaOptions: NebulaOptions = _
private var graphProvider: GraphProvider = _
private var schema: StructType = _
private var resultSet: ResultSet = _
private var edgeIterator: Iterator[ListBuffer[ValueWrapper]] = _

def this(nebulaOptions: NebulaOptions, schema: StructType) {
this()
this.schema = schema
this.nebulaOptions = nebulaOptions
this.graphProvider = new GraphProvider(
nebulaOptions.getGraphAddress,
nebulaOptions.timeout,
nebulaOptions.enableGraphSSL,
nebulaOptions.sslSignType,
nebulaOptions.caSignParam,
nebulaOptions.selfSignParam
)
// add exception when session build failed
graphProvider.switchSpace(nebulaOptions.user, nebulaOptions.passwd, nebulaOptions.spaceName)
resultSet = graphProvider.submit(nebulaOptions.ngql)
edgeIterator = query()
}

def query(): Iterator[ListBuffer[ValueWrapper]] = {
val edges: ListBuffer[ListBuffer[ValueWrapper]] = new ListBuffer[ListBuffer[ValueWrapper]]
val properties = nebulaOptions.getReturnCols
for (i <- 0 until resultSet.rowsSize()) {
val rowValues = resultSet.rowValues(i).values()
for (j <- 0 until rowValues.size()) {
val value = rowValues.get(j)
val valueType = value.getValue.getSetField
if (valueType == Value.EVAL) {
val relationship = value.asRelationship()
if (checkLabel(relationship)) {
edges.append(convertToEdge(relationship, properties))
}
} else if (valueType == Value.LVAL) {
val list: mutable.Buffer[ValueWrapper] = value.asList()
edges.appendAll(
list.toStream.filter(e => checkLabel(e.asRelationship()))
.map(e => convertToEdge(e.asRelationship(), properties))
)
} else {
LOG.error(s"Exception convert edge type ${valueType} ")
throw new RuntimeException(" convert value type failed");
}
}
}
edges.iterator
}

def checkLabel(relationship: Relationship): Boolean = {
this.nebulaOptions.label.equals(relationship.edgeName())
}

def convertToEdge(relationship: Relationship, properties: List[String]): ListBuffer[ValueWrapper] = {
val edge: ListBuffer[ValueWrapper] = new ListBuffer[ValueWrapper]
edge.append(relationship.srcId())
edge.append(relationship.dstId())
edge.append(new ValueWrapper(new Value(3, relationship.ranking()), "utf-8"))
if (properties == null || properties.isEmpty)
return edge
else {
for (i <- properties.indices) {
edge.append(relationship.properties().get(properties(i)))
}
}
edge
}


override def next(): Boolean = {
edgeIterator.hasNext
}

override def get(): InternalRow = {
val getters: Array[NebulaValueGetter] = NebulaUtils.makeGetters(schema)
val mutableRow = new SpecificInternalRow(schema.fields.map(x => x.dataType))

val edge = edgeIterator.next();
for (i <- getters.indices) {
val value: ValueWrapper = edge(i)
var resolved = false
if (value.isNull) {
mutableRow.setNullAt(i)
resolved = true
}
if (value.isString) {
getters(i).apply(value.asString(), mutableRow, i)
resolved = true
}
if (value.isDate) {
getters(i).apply(value.asDate(), mutableRow, i)
resolved = true
}
if (value.isTime) {
getters(i).apply(value.asTime(), mutableRow, i)
resolved = true
}
if (value.isDateTime) {
getters(i).apply(value.asDateTime(), mutableRow, i)
resolved = true
}
if (value.isLong) {
getters(i).apply(value.asLong(), mutableRow, i)
}
if (value.isBoolean) {
getters(i).apply(value.asBoolean(), mutableRow, i)
}
if (value.isDouble) {
getters(i).apply(value.asDouble(), mutableRow, i)
}
if (value.isGeography) {
getters(i).apply(value.asGeography(), mutableRow, i)
}
if (value.isDuration) {
getters(i).apply(value.asDuration(), mutableRow, i)
}
}
mutableRow

}

override def close(): Unit = {
graphProvider.close();
}
}
Loading