{"id":18725188,"url":"https://github.com/vesoft-inc/nebula-go","last_synced_at":"2026-04-07T08:02:38.344Z","repository":{"id":36447501,"uuid":"210544241","full_name":"vesoft-inc/nebula-go","owner":"vesoft-inc","description":"Nebula client in Golang","archived":false,"fork":false,"pushed_at":"2024-05-22T18:52:44.000Z","size":2018,"stargazers_count":128,"open_issues_count":20,"forks_count":68,"subscribers_count":31,"default_branch":"master","last_synced_at":"2024-05-22T19:58:04.786Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vesoft-inc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-24T07:53:35.000Z","updated_at":"2024-05-27T12:50:39.227Z","dependencies_parsed_at":"2024-04-19T13:40:19.318Z","dependency_job_id":"b22f18e7-26ac-47e1-9941-6ebdd387b645","html_url":"https://github.com/vesoft-inc/nebula-go","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesoft-inc%2Fnebula-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesoft-inc%2Fnebula-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesoft-inc%2Fnebula-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vesoft-inc%2Fnebula-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vesoft-inc","download_url":"https://codeload.github.com/vesoft-inc/nebula-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247242681,"owners_count":20907134,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-11-07T14:09:27.448Z","updated_at":"2025-10-25T16:09:46.919Z","avatar_url":"https://github.com/vesoft-inc.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# nebula-go\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/vesoft-inc/nebula-go/v3.svg)](https://pkg.go.dev/github.com/vesoft-inc/nebula-go/v3)\n![functional tests](https://github.com/vesoft-inc/nebula-go/actions/workflows/test.yaml/badge.svg)\n[![codecov](https://codecov.io/gh/vesoft-inc/nebula-go/branch/master/graph/badge.svg?token=dzUo5KdSux)](https://codecov.io/gh/vesoft-inc/nebula-go)\n\n**IMPORTANT: Code of Nebula go client has been transferred from [nebula-clients](https://github.com/vesoft-inc/nebula-clients) to this repository(nebula-go), and new releases in the future will be published in this repository.\nPlease update your `go.mod` and imports correspondingly.**\n\nOfficial Nebula Go client which communicates with the server using [fbthrift](https://github.com/vesoft-inc/fbthrift/). Currently the latest stable release is **[v3.4.0](https://github.com/vesoft-inc/nebula-go/tree/release-v3.4)**\n\nThe code in **master branch** will be updated to accommodate the nightly changes made in NebulaGraph.\nTo Use the console with a stable release of NebulaGraph, please check the branches and use the corresponding version.\n\n|                             Client version                              | Nebula Service Version |\n| :---------------------------------------------------------------------: | :--------------------: |\n|     **[v1.0.0](https://github.com/vesoft-inc/nebula-go/tree/v1.0)**     |         1.x.x          |\n| **[v2.0.0-ga](https://github.com/vesoft-inc/nebula-go/tree/v2.0.0-ga)** |    2.0.0-ga, 2.0.1     |\n|    **[v2.5.1](https://github.com/vesoft-inc/nebula-go/tree/v2.5.1)**    |         2.5.0          |\n|    **[v2.6.0](https://github.com/vesoft-inc/nebula-go/tree/v2.6.0)**    |         2.6.0          |\n|    **[v3.0.0](https://github.com/vesoft-inc/nebula-go/tree/v3.0.0)**    |         3.0.0          |\n|    **[v3.1.x](https://github.com/vesoft-inc/nebula-go/tree/v3.1.0)**    |         3.1.x          |\n|    **[v3.2.x](https://github.com/vesoft-inc/nebula-go/tree/v3.2.0)**    |      3.1.x-3.2.x       |\n|    **[v3.3.x](https://github.com/vesoft-inc/nebula-go/tree/v3.3.0)**    |      3.1.x-3.3.x       |\n|    **[v3.4.x](https://github.com/vesoft-inc/nebula-go/tree/v3.4.0)**    |      3.1.x-3.4.x       |\n|    **[v3.5.x](https://github.com/vesoft-inc/nebula-go/tree/v3.5.0)**    |      3.1.x-3.5.x       |\n|    **[master](https://github.com/vesoft-inc/nebula-go/tree/master)**    |      3.x-nightly       |\n\nPlease be careful not to modify the files in the nebula directory, these codes were all generated by fbthrift.\n\n**NOTE** Installing Nebula Go v2.5.0 could cause **checksum mismatch**, use v2.5.1 instead.\n\n## Install \u0026 Update\n\n```shell\n$ go get -u -v github.com/vesoft-inc/nebula-go/v3@master\n```\n\nYou can specify the version of Nebula-go by substituting `\u003ctag\u003e` in `$ go get -u -v github.com/vesoft-inc/nebula-go@\u003ctag\u003e`.\nFor example:\n\n  for v3: `$ go get -u -v github.com/vesoft-inc/nebula-go/v3@v3.4.0`\n\n  for v2: `$ go get -u -v github.com/vesoft-inc/nebula-go/v2@v2.6.0`\n\n**Note**: You will get a message like this if you don't specify a tag:\n\n\u003e ```shell\n\u003e $ go get -u -v github.com/vesoft-inc/nebula-go/v2@master\n\u003e go: github.com/vesoft-inc/nebula-go/v2 master =\u003e v2.0.0-20210506025434-97d4168c5c4d\n\u003e ```\n\u003e\n\u003e Here the `20210506025434-97d4168c5c4d` is a version tag auto-generated by GitHub using commit date and SHA.\n\u003e This should match the latest commit in the master branch.\n\n## Usage example\n\n### Mininal example\n\nSuppose you already initialized your space and defined the schema as:\n1. Vertex `person` with properties `name: string`, `age: int`\n2. Edge `like` with properties `likeness: double`\n\nYou can query the Nebula by the minimal example:\n\n```go\npackage main\n\nimport (\n  nebula \"github.com/vesoft-inc/nebula-go/v3\"\n)\n\ntype Person struct {\n  Name     string  `nebula:\"name\"`\n  Age      int     `nebula:\"age\"`\n  Likeness float64 `nebula:\"likeness\"`\n}\n\nfunc main() {\n  hostAddress := nebula.HostAddress{Host: \"127.0.0.1\", Port: 3699}\n\n  config, err := nebula.NewSessionPoolConf(\n    \"user\",\n    \"password\",\n    []nebula.HostAddress{hostAddress},\n    \"space_name\",\n  )\n\n  sessionPool, err := nebula.NewSessionPool(*config, nebula.DefaultLogger{})\n\n  query := `GO FROM 'Bob' OVER like YIELD\n    $^.person.name AS name,\n    $^.person.age AS age,\n    like.likeness AS likeness`\n\n  resultSet, err := sessionPool.Execute(query)\n  if err != nil {\n    panic(err)\n  }\n\n  var personList []Person\n  resultSet.Scan(\u0026personList)\n}\n```\n\n### More examples\n\n[Simple Code Example](https://github.com/vesoft-inc/nebula-go/tree/master/examples/basic_example/graph_client_basic_example.go)\n\n[Code Example with Goroutines](https://github.com/vesoft-inc/nebula-go/tree/master/examples/goroutines_example/graph_client_goroutines_example.go)\n\n[Session Pool Example](https://github.com/vesoft-inc/nebula-go/blob/master/examples/session_pool_example/session_pool_example.go)\n\nThere are some limitations while using the session pool:\n1. There MUST be an existing space in the DB before initializing the session pool.\n2. Each session pool is corresponding to a single USER and a single Space. This is to ensure that the user's access control is consistent. i.g. The same user may have different access privileges in different spaces. If you need to run queries in different spaces, you may have multiple session pools.\n3. Every time when `sessionPool.Execute()` is called, the session will execute the query in the space set in the session pool config.\n4. Commands that alter passwords or drop users should NOT be executed via session pool.\n\n## Code of Conduct\n\nThis project and everyone participating in it is governed by the\n[Vesoft Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are\nexpected to uphold this code.\n\n## Licensing\n\n**Nebula GO** is under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license, so you can freely download, modify, and deploy the source code to meet your needs. You can also freely deploy **Nebula GO** as a back-end service to support your SaaS deployment.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvesoft-inc%2Fnebula-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvesoft-inc%2Fnebula-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvesoft-inc%2Fnebula-go/lists"}