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.

Sign up for GitHub

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

Update README regarding v3 release #197

Merged
merged 2 commits into from
Feb 14, 2022
Merged

Update README regarding v3 release #197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d86bc5
Update README
Aiee Feb 14, 2022
e6a8060
Update nebula go
Aiee Feb 14, 2022
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
33 changes: 6 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,8 @@ Currently, there are three methods to deploy Nebula Graph:

## **CAUTION**: Choose the correct branch

The rpc protocols (i.e., thrift) in Nebula Graph 1.x and v2 are incompatible.

Nebula Importer v1 branch can only connect to Nebula Graph 1.x.
Nebula Importer master and v2 branch can only connect to Nebula Graph 2.x.
The rpc protocols (i.e., thrift) in Nebula Graph 1.x, v2, v3 are incompatible.
Nebula Importer master and v3 branch can only connect to Nebula Graph 3.x.

> Do not mismatch.

Expand All @@ -45,13 +43,7 @@ Nebula Importer is compiled with Go **1.13** or later, so make sure that Go is i

1. Clone the repository

* For Nebula Graph 1.x, clone the `v1` branch.

``` bash
$ git clone --branch v1 https://github.com/vesoft-inc/nebula-importer.git
```

* For Nebula Graph 2.x, clone the master branch.
* For Nebula Graph 3.x, clone the master branch.
Aiee marked this conversation as resolved.
Show resolved Hide resolved

``` bash
$ git clone https://github.com/vesoft-inc/nebula-importer.git
Expand Down Expand Up @@ -81,31 +73,18 @@ The `--config` option in the preceding command is used to pass the path of the Y

If you are using Docker, you don't have to install Go locally. Pull the [Docker image](https://hub.docker.com/r/vesoft/nebula-importer) for Nebula Importer. Mount the local configuration file and the CSV data files into the container and you are done.

1. For Nebula Graph 1.x:

```bash
$ docker run --rm -ti \
--network=host \
-v {your-config-file}:{your-config-file} \
-v {your-csv-data-dir}:{your-csv-data-dir} \
vesoft/nebula-importer:v1
--config {your-config-file}
```

2. For Nebula Graph 2.x:

```bash
$ docker run --rm -ti \
--network=host \
-v {your-config-file}:{your-config-file} \
-v {your-csv-data-dir}:{your-csv-data-dir} \
vesoft/nebula-importer:v2
vesoft/nebula-importer:{image_version}
--config {your-config-file}
```

- `{your-config-file}`: Replace with the absolute path of the local YAML configuration file.
- `{your-csv-data-dir}`: Replace with the absolute path of the local CSV data file.

- `{image_version}`: Replace with the image version you need(e.g. `v1`, `v2`, `v3`)
> **NOTE**: We recommend that you use the relative paths in the `files.path` file. If you use the local absolute path, check how the path is mapped to Docker carefully.

## Prepare the configuration file
Expand All @@ -118,7 +97,7 @@ description: example
removeTempFiles: false
```

* `version`: **Required**. Indicates the configuration file version, the default value is `v2`.
* `version`: **Required**. Indicates the configuration file version, the default value is `v2`. Note that `v2` config can be used with both 2.x and 3.x Nebula service.
* `description`: **Optional**. Describes the configuration file.
* `removeTempFiles`: **Optional**. Whether to delete the temporarily generated log and error data files. The default value is `false`.
* `clientSettings`: Stores all the configurations related to the Nebula Graph service.
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module github.com/vesoft-inc/nebula-importer
require (
github.com/kr/text v0.2.0 // indirect
github.com/stretchr/testify v1.7.0
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220214062853-d0c59964d0af
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
gopkg.in/yaml.v2 v2.2.4
)
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d h1:spO7OAtYI1wiqBiJ9417pKhqx0IkqFAFdFQFPm4JIrs=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220119024722-ab348afbb79d/go.mod h1:+sXv05jYQBARdTbTcIEsWVXCnF/6ttOlDK35xQ6m54s=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220214062853-d0c59964d0af h1:5z3eC9o+LzDBeA2kRIMgj+k7C8bfSuWh9ffZXljkPzs=
github.com/vesoft-inc/nebula-go/v3 v3.0.0-20220214062853-d0c59964d0af/go.mod h1:+sXv05jYQBARdTbTcIEsWVXCnF/6ttOlDK35xQ6m54s=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
Expand Down