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

Add api reference #2434

Merged
merged 4 commits into from
Jan 22, 2024
+13 −4
Merged

Add api reference #2434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
13266ad
add api reference for Java & python
ChrisChen2023 Jan 9, 2024
83a3d55
add cpp api
ChrisChen2023 Jan 22, 2024
338ad84
update
ChrisChen2023 Jan 22, 2024
4249ac8
Merge branch 'v3.6.0' into add_api_reference
ChrisChen2023 Jan 22, 2024
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
6 changes: 5 additions & 1 deletion docs-2.0-en/14.client/3.nebula-cpp-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[NebulaGraph CPP](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) is a C++ client for connecting to and managing the NebulaGraph database.

## Limitations
## Prerequisites

You have installed C++ and GCC 4.8 or later versions.

Expand Down Expand Up @@ -103,6 +103,10 @@ Compile the CPP file to an executable file, then you can use it. The following s
$ LIBRARY_PATH=/usr/local/nebula/lib64:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I/usr/local/nebula/include -lnebula_graph_client -o session_example
```

## API reference

Click [here](https://vesoft-inc.github.io/nebula-cpp/release-3.4/annotated.html) to check the classes and functions provided by the CPP Client.

## Core of the example code

Nebula CPP clients provide both Session Pool and Connection Pool methods to connect to NebulaGraph. Using the Connection Pool method requires users to manage session instances by themselves.
Expand Down
6 changes: 5 additions & 1 deletion docs-2.0-zh/14.client/3.nebula-cpp-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[NebulaGraph CPP](https://github.com/vesoft-inc/nebula-cpp/tree/{{cpp.branch}}) 是一款 C++ 语言的客户端，可以连接、管理 {{nebula.name}} 图数据库。

## 使用限制
## 前提条件

请确保已安装 C++ 且 GCC 版本为 4.8 及以上。

Expand Down Expand Up @@ -103,6 +103,10 @@
$ LIBRARY_PATH=/usr/local/nebula/lib64:$LIBRARY_PATH g++ -std=c++11 SessionExample.cpp -I/usr/local/nebula/include -lnebula_graph_client -o session_example
```

## API 文档

点击[此处](https://vesoft-inc.github.io/nebula-cpp/release-3.4/annotated.html)查看 CPP 客户端提供的各种类和方法。

## 核心代码

NebulaGraph CPP 客户端提供 Session Pool 和 Connection Pool 两种方式连接 {{nebula.name}} 。使用 Connection Pool 需要用户自行管理 Session 实例。
Expand Down
3 changes: 2 additions & 1 deletion docs-2.0-zh/14.client/4.nebula-java-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@

如果没有 Maven 管理项目，请手动[下载 JAR 包](https://repo1.maven.org/maven2/com/vesoft/)进行安装。

## API reference
## API 文档


点击[此处](https://vesoft-inc.github.io/nebula-java/release-3.6/annotated.html)查看 Java 客户端提供的各种类和方法。

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0-zh/14.client/5.nebula-python-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ $ pip install nebula3-python==<version>
$ pip install .
```

## API reference
## API 文档

点击[此处](https://vesoft-inc.github.io/nebula-python/release-3.4/annotated.html)查看 Python 客户端提供的各种类和方法。

Expand Down