ZIO Client for NebulaGraph

zio-nebula is a simple wrapper around nebula-java for easier integration into Scala, ZIO applications.

NebulaGraph is a popular open-source graph database that can handle large volumes of data with milliseconds of latency, scale up quickly, and have the ability to perform fast graph analytics. NebulaGraph has been widely used for social media, recommendation systems, knowledge graphs, security, capital flows, AI, etc.

Introduction

• Supports all clients: Session Pool、Pool、Storage、Meta
• Support for configuring clients with typesafe config
• Other optimizations suitable for Scala pure functional
• Support Scala 3, Scala 2.13 and Scala 2.12

Installation

In order to use this library, we need to add the following line in our build.sbt file:

libraryDependencies += "io.github.jxnu-liguobin" %% "zio-nebula" % <latest version>

There are the version correspondence between zio-nebula and nebula-java:

zio	zio-nebula	nebula-java
2.0.x	0.0.x	3.6.0
2.0.x	0.1.0	3.6.0
2.0.x	0.1.1	3.6.1

Example

Usually, we use a session client, which can be conveniently used in ZIO applications like this:

import zio._
import zio.nebula._

final class NebulaSessionClientExample(sessionClient: NebulaSessionClient) {

  def execute(stmt: String): ZIO[Any, Throwable, NebulaResultSet] = {
    // your custom logic
    sessionClient.execute(stmt)
  }
}

object NebulaSessionClientExample {
  lazy val layer = ZLayer.fromFunction(new NebulaSessionClientExample(_))
}

object NebulaSessionClientMain extends ZIOAppDefault {

  override def run = (for {
    // since 0.1.1, no need to call it manually.
    _ <- ZIO.serviceWithZIO[NebulaSessionClient](_.init()) 
    _ <- ZIO.serviceWithZIO[NebulaSessionClientExample](
             _.execute("""
                         |INSERT VERTEX person(name, age) VALUES 
                         |'Bob':('Bob', 10), 
                         |'Lily':('Lily', 9),'Tom':('Tom', 10),
                         |'Jerry':('Jerry', 13),
                         |'John':('John', 11);""".stripMargin)
           )
    _ <- ZIO.serviceWithZIO[NebulaSessionClientExample](
             _.execute("""
                         |INSERT EDGE like(likeness) VALUES
                         |'Bob'->'Lily':(80.0),
                         |'Bob'->'Tom':(70.0),
                         |'Lily'->'Jerry':(84.0),
                         |'Tom'->'Jerry':(68.3),
                         |'Bob'->'John':(97.2);""".stripMargin)
           )
    _ <- ZIO.serviceWithZIO[NebulaSessionClientExample](
             _.execute("""
                         |USE test;
                         |MATCH (p:person) RETURN p LIMIT 4;
                         |""".stripMargin)
           )
  } yield ())
    .provide(
      Scope.default,
      NebulaSessionClientExample.layer,
      SessionClientEnv
    )

}

Configuration

NebulaSessionClient Configuration:

For the entire structure, see zio.nebula.NebulaSessionPoolConfig.

{
  graph {
    address = [
      {
        host = "127.0.0.1",
        port = 9669
      }
    ]
    auth {
      username = "root"
      password = "nebula"
    }
    spaceName = "test"
    reconnect = true
  }
}

NebulaMetaClient Configuration:

For the entire structure, see zio.nebula.NebulaMetaConfig.

{
  meta {
    address = [
      {
        host = "127.0.0.1",
        port = 9559
      }
    ]
    timeoutMills = 30000
    connectionRetry = 3
    executionRetry = 1
    enableSSL = false
  }
}

NebulaStorageClient Configuration:

For the entire structure, see zio.nebula.NebulaStorageConfig.

{
  storage {
    address = [
      {
        host = "127.0.0.1",
        port = 9559
      }
    ]
    timeoutMills = 30000
    connectionRetry = 3
    executionRetry = 1
    enableSSL = false
  }
}

NebulaClient Configuration:

For the entire structure, see zio.nebula.NebulaPoolConfig.

{
  pool {
    address = [
      {
        host = "127.0.0.1",
        port = 9669
      }
    ]
    auth {
      username = "root"
      password = "nebula"
    }
    spaceName = "test"
    timeoutMills = 60000
    enableSsl = false
    minConnsSize = 10
    maxConnsSize = 10
    intervalIdleMills = 100
    waitTimeMills = 100
  }
}

See examples for more clients and configurations.