# nebula-java

**Repository Path**: luoqi3713/nebula-java

## Basic Information

- **Project Name**: nebula-java
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-04-21
- **Last Updated**: 2021-04-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nebula-java

![](https://img.shields.io/badge/language-java-orange.svg)
[![star this repo](http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula-java&style=default)](https://github.com/vesoft-inc/nebula-java)
[![fork this repo](http://githubbadges.com/fork.svg?user=vesoft-inc&repo=nebula-java&style=default)](https://github.com/vesoft-inc/nebula-java/fork)

Nebula Java is a Java client for developers to connect their projects to Nebula Graph.

> **NOTE**: Nebula Java is not thread-safe.

## Two main branches of this repository

In this repository, you can find two branches for the source code of Nebula Java of different versions.

### The master branch

The master branch is for Nebula Java v2.0, which works with Nebula Graph v2.0 nightly.

This README file provides Java developers with instructions on how to connect to Nebula Graph v2.0.

### The v1.0 branch

In the v1.0 branch, you can find source code of these:

- Nebula Java v1.0, which works with Nebula Graph v1.1.0 and earlier versions only.
- Nebula Graph Exchange, Nebula Spark Connector, Nebula Flink Connector, and nebula-algorithm.

For more information, see [README of v1.0](https://github.com/vesoft-inc/nebula-java/blob/v1.0/README.md).

### The v2.0.0-rc branch

The v2.0.0-rc branch works with Nebula Graph v2.0.0-beta and v2.0.0-rc1, but not for the latest nightly Nebula Graph.

## Prerequisites

To use this Java client, do a check of  these:

- Java 8 or a later version is installed.
- Nebula Graph v2.0 is deployed. For more information, see [Deployment and installation of Nebula Graph](https://docs.nebula-graph.io/2.0/4.deployment-and-installation/1.resource-preparations/ "Click to go to Nebula Graph website").

## Modify pom.xml

If you use Maven to manage your project, add the following dependency to your `pom.xml` file. 
Replace `2.0.0-SNAPSHOT` with an appropriate Nebula Java v2.x version. 
For more versions, visit [releases](https://github.com/vesoft-inc/nebula-java/releases).

```xml
  <dependency>
    <groupId>com.vesoft</groupId>
    <artifactId>client</artifactId>
    <version>2.0.0-SNAPSHOT</version>
  </dependency>
```
There are the version correspondence between client and Nebula:

| Client version | Nebula Version |
|:--------------:|:-------------------:|
|     1.0.0      |       1.0.0         |
|     1.0.1      |    1.1.0,1.2.0     |
|     1.1.0      |    1.1.0,1.2.0     |
|     1.2.0      | 1.1.0,1.2.0,1.2.1   |
|    2.0.0-beta  |      2.0.0-beta     |
|    2.0.0-rc1   |       2.0.0-rc1     |
|    2.0.0       |      >= 2.0.0       |
|  2.0.0-SNAPSHOT|    2.0.0-nightly    |

## Graph client example

To connect to the `nebula-graphd` process of Nebula Graph v2.0:

```java
NebulaPoolConfig nebulaPoolConfig = new NebulaPoolConfig();
nebulaPoolConfig.setMaxConnSize(10);
List<HostAddress> addresses = Arrays.asList(new HostAddress("127.0.0.1", 9669),
        new HostAddress("127.0.0.1", 9670));
NebulaPool pool = new NebulaPool();
pool.init(addresses, nebulaPoolConfig);
Session session = pool.getSession("root", "nebula", false);
session.execute("SHOW HOSTS;");
session.release();
pool.close();
```