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.

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

fix #472

Closed
wants to merge 31 commits into from
Closed

fix #472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
e401e46
Update index.rst
zhangwh807 Mar 20, 2024
c5b8ae6
Update index.rst
zhangwh807 Mar 20, 2024
8fce33b
Update index.rst
zhangwh807 Mar 20, 2024
d2e9f54
Update index.rst
zhangwh807 Mar 20, 2024
bbe5fd6
文档目录调整。调整4,5级目录为2,3级目录
zhangwh807 Mar 20, 2024
90d7346
Merge remote-tracking branch 'origin/master'
zhangwh807 Mar 20, 2024
e48cd78
文档目录调整。调整4,5级目录为2,3级目录
zhangwh807 Mar 20, 2024
f17750c
Update conf.py
zhangwh807 Mar 20, 2024
4fedc98
文档目录调整。调整4,5级目录为2,3级目录
zhangwh807 Mar 20, 2024
f4ed142
文档目录调整。调整4,5级目录为2,3级目录
zhangwh807 Mar 21, 2024
c1b9464
调整Gql目录结构与cypher保持一致
zhangwh807 Mar 21, 2024
770a634
增加GQL查询页面目录,尝试调整C++API目录等级
zhangwh807 Mar 21, 2024
d319d46
增加GQL查询页面目录,尝试调整C++API目录等级
zhangwh807 Mar 21, 2024
69f56cf
调整C++API目录等级
zhangwh807 Mar 21, 2024
d057a23
调整C++API目录等级
zhangwh807 Mar 21, 2024
b0d0ccf
调整C++API目录等级
zhangwh807 Mar 21, 2024
69a2670
调整英文目录结构
zhangwh807 Mar 22, 2024
1ac6eec
锚点调整
zhangwh807 Mar 27, 2024
76a0bdf
Update 4.local-package-deployment.md
zhangwh807 Mar 27, 2024
3573ce4
Update 4.local-package-deployment.md
zhangwh807 Mar 27, 2024
7407b71
Update 4.local-package-deployment.md
zhangwh807 Mar 27, 2024
cef8dc0
Update 4.local-package-deployment.md
zhangwh807 Mar 27, 2024
de9dba4
中英文目录结构调整
zhangwh807 Mar 29, 2024
bf43768
Merge remote-tracking branch 'origin/master'
zhangwh807 Mar 29, 2024
f1df18f
锚点调整
zhangwh807 Apr 7, 2024
4541a2e
页面间跳转锚点调整
zhangwh807 Apr 7, 2024
7bcc51d
Merge branch 'zwh-dep1'
zhangwh807 Apr 7, 2024
06b89bf
调整目录结构
zhangwh807 Apr 7, 2024
96d4e85
更新文档中"修改角色对指定图的访问权限"的接口说明
zhangwh807 Apr 18, 2024
c4fc131
更新文档中"修改角色对指定图的访问权限"的接口说明
zhangwh807 Apr 18, 2024
f849339
更新文档中"修改角色对指定图的访问权限"的接口说明
zhangwh807 Apr 18, 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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ $ make package
We have prepared environment docker images for compiling in DockerHub, named `tugraph/tugraph-compile-[os]:[compile version]`,
for example, `tugraph/tugraph-compile-centos7:1.1.0`, which can help developers get started easily.

We have a [roadmap](docs/en-US/source/6.contributor-manual/5.roadmap.md) to help you understand TuGraph.
We have a [roadmap](docs/en-US/source/12.contributor-manual/5.roadmap.md) to help you understand TuGraph.

To contribute, please read [doc](docs/en-US/source/6.contributor-manual/1.contributing.md).
To contribute, please read [doc](docs/en-US/source/12.contributor-manual/1.contributing.md).

NOTICE: If you want to contribute code, you should sign a [cla doc](https://cla-assistant.io/TuGraph-db/tugraph-db).

Expand Down
6 changes: 3 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ $ make package

我们已为在DockerHub中编译准备了环境docker镜像,可以帮助开发人员轻松入门,名称为 `tugraph/tugraph-compile-[os]:[compile version]`, 例如, `tugraph/tugraph-compile-centos7:1.1.0`。

可以访问 [技术规划](./docs/zh-CN/source/6.contributor-manual/5.roadmap.md) 来了解TuGraph进展。
可以访问 [技术规划](docs/zh-CN/source/12.contributor-manual/5.roadmap.md) 来了解TuGraph进展。

如需贡献,请阅读 [如何贡献](./docs/zh-CN/source/6.contributor-manual/1.contributing.md)。
如需贡献,请阅读 [如何贡献](docs/zh-CN/source/12.contributor-manual/1.contributing.md)。

注意:如果您想贡献代码,需要签署[个人贡献者许可协议](./docs/zh-CN/source/6.contributor-manual/3.individual-cla.md)或者[公司贡献者许可协议](./docs/zh-CN/source/6.contributor-manual/4.corporate-cla.md)。
注意:如果您想贡献代码,需要签署[个人贡献者许可协议](docs/zh-CN/source/12.contributor-manual/3.individual-cla.md)或者[公司贡献者许可协议](docs/zh-CN/source/12.contributor-manual/4.corporate-cla.md)。

## 5. 合作伙伴

Expand Down
18 changes: 9 additions & 9 deletions docs/en-US/source/1.guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

## Quick Start

> Understand [What is a Graph](./2.introduction/1.what-is-graph.md),[The application scenarios of graph](./2.introduction/7.scenarios.md),[What is TuGraph](./2.introduction/3.what-is-tugraph.md).
> Understand [What is a Graph](./2.introduction/1.what-is-graph.md),[The application scenarios of graph](./2.introduction/8.scenarios.md),[What is TuGraph](./2.introduction/3.what-is-tugraph.md).

> Quickly Install and deploy TuGraph:[Cloud Deployment](./5.developer-manual/1.installation/5.cloud-deployment.md),[Docker Deployment](./5.developer-manual/1.installation/3.docker-deployment.md)Rapid deployment TuGraph.
> Quickly Install and deploy TuGraph:[Cloud Deployment](5.installation&running/5.cloud-deployment.md),[Docker Deployment](5.installation&running/3.docker-deployment.md)Rapid deployment TuGraph.

> Quickly get started with DEMO:[Movie](./3.quick-start/2.demo/1.movie.md),[The Wandering Earth](./3.quick-start/2.demo/2.wandering-earth.md),[Three Body](./3.quick-start/2.demo/3.the-three-body.md),[Three Kingdoms](./3.quick-start/2.demo/4.three-kingdoms.md).

> User Guide:[TuGraph Browser](./4.user-guide/1.tugraph-browser.md),[TuGraph Browser Legacy](./4.user-guide/2.tugraph-browser-legacy.md).

## Development Guide

> Client Tools:[Cpp Client](./5.developer-manual/4.client-tools/2.cpp-client.md),[Java Client](./5.developer-manual/4.client-tools/3.java-client.md),[Python Client](./5.developer-manual/4.client-tools/1.python-client.md).
> Client Tools:[Cpp Client](7.client-tools/2.cpp-client.md),[Java Client](7.client-tools/3.java-client.md),[Python Client](7.client-tools/1.python-client.md).

> TuGraph Query Language:[Cypher API](./5.developer-manual/6.interface/1.query/1.cypher.md).
> TuGraph Query Language:[Cypher API](8.query/1.cypher.md).

> Procedure And Algorithm:[Procedure API (POG API)](./5.developer-manual/6.interface/3.procedure/1.procedure.md)、[OLAP API](./5.developer-manual/6.interface/2.olap/1.tutorial.md).
> Procedure And Algorithm:[Procedure API (POG API)](9.olap&procedure/1.procedure/1.procedure.md)、[OLAP API](9.olap&procedure/2.olap/1.tutorial.md).

> C++/Python Procedure Interfaces:[C++/Python Procedure API](./5.developer-manual/6.interface/3.procedure/index.rst)。
> C++/Python Procedure Interfaces:[C++/Python Procedure API](9.olap&procedure/1.procedure/index.rst)。

## Community Contribution

> Before starting to contribute, you can learn [how to contribute](./6.contributor-manual/1.contributing.md)
> Before starting to contribute, you can learn [how to contribute](12.contributor-manual/1.contributing.md)

> If you want to understand the division of community roles, please visit [community roles](./6.contributor-manual/2.community-roles.md)
> If you want to understand the division of community roles, please visit [community roles](12.contributor-manual/2.community-roles.md)

## Main warehouse

Expand Down Expand Up @@ -73,4 +73,4 @@

For the version update log, see: [Link](https://github.com/TuGraph-family/tugraph-db/blob/master/release/CHANGELOG_CN.md).

If you don't know how to use installation packages and images, please refer to [Environment and Version Selection](./7.best-practices/4.selection.md).
If you don't know how to use installation packages and images, please refer to [Environment and Version Selection](13.best-practices/4.selection.md).
Original file line number Diff line number Diff line change
Expand Up @@ -131,5 +131,12 @@ CALL dbms.security.rebuildUserRoles(user::STRING,roles::LIST)
- Modifies the access permission of a role to a specified graph

```cypher
CALL dbms.security.modSpecifiedAccessLevel(role::STRING,access_level::MAP)
CALL dbms.security.modRoleAccessLevel(role::STRING,access_level::MAP)
```

_Example_

```cypher
CALL dbms.security.modRoleAccessLevel('test_role', {test_graph1:'FULL', test_graph2:'NONE'})
```

Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ The second timestamp `expire_time` is the forced expiration timestamp (default 2
### 2.4. Token Expiration Modification
To facilitate developers to develop on their own, TuGraph provides two ways to modify the expiration time, both of which require admin privileges.

* Set through the interface call. The interfaces involved in modifying the expiration time are `update_token_time` and `get_token_time` for querying the expiration time. For details, please refer to the [REST interface document](../../5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md).
* Set through startup parameters. When the server-side is started, adding the parameter `-unlimited_token 1` can set the Token to be unlimited. Please refer to the [service running document](../../5.developer-manual/2.running/2.tugraph-running.md) for details.
* Set through the interface call. The interfaces involved in modifying the expiration time are `update_token_time` and `get_token_time` for querying the expiration time. For details, please refer to the [REST interface document](../7.client-tools/9.restful-api-legacy.md).
* Set through startup parameters. When the server-side is started, adding the parameter `-unlimited_token 1` can set the Token to be unlimited. Please refer to the [service running document](../5.installation&running/7.tugraph-running.md) for details.
## 3. Introduction to Token-Related Requests Sent by Clients
The client handles two types of protocol-related requests: REST and RPC.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Please use Python's built-in print to output debug information. The debug inform

Audit logs record each request and response, as well as the user who sent the request and when the request received. Audit logging can only be turned on or off. The results can be queried using the TuGraph visualization tool and the REST API.

To enable the Audit Log, you need to set the `enable_audit_log` parameter to `true` in the configuration file. For the configuration file and parameter descriptions, see:[Tugraph Running/Service configuration](../2.running/2.tugraph-running.md/#4service-configuration)
To enable the Audit Log, you need to set the `enable_audit_log` parameter to `true` in the configuration file. For the configuration file and parameter descriptions, see:[Tugraph Running/Service configuration](../../5.installation&running/7.tugraph-running.md/#4service-configuration)
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
TuGraph DB Other
TuGraph DB Privilege And Operations
========================

.. toctree::
:maxdepth: 2
:caption: Contents:
:glob:

*
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ TuGraph DB Quality

.. toctree::
:maxdepth: 2
:caption: Contents:
:glob:

*
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can get start with TuGraph follow instrcutions in [Guide Doc](../1.guide.md)

For document contributions, you can directly modify and submit a pull request by clicking on "Edit on GitHub" in the upper right corner of the [documentation](https://tugraph-db.readthedocs.io/en/latest).

For code contributions, it is usually necessary to set up the environment for compilation and execution. You can deploy using [Docker](../5.developer-manual/1.installation/3.docker-deployment.md) or [local package deployment](../5.developer-manual/1.installation/4.local-package-deployment.md).
For code contributions, it is usually necessary to set up the environment for compilation and execution. You can deploy using [Docker](../5.installation&running/3.docker-deployment.md) or [local package deployment](../5.installation&running/4.local-package-deployment.md).

## 3.3. License Agreement

Expand Down
3 changes: 3 additions & 0 deletions docs/en-US/source/13.best-practices/1.rdbms-to-tugraph.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Importing Data from Relational Databases to TuGraph

> Using [DataX](../6.utility-tools/7.tugraph-datax.md),to be completed.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ TuGraph has provided the Cora dataset import tool, which users can use directly.
### 3.2. Data Import
The Cora dataset is located in the test/integration/data/algo directory and contains the cora_vertices point set and the cora_edge edge set.

First, the Cora dataset needs to be imported into the TuGraph database. Please refer to [Data Import](../5.developer-manual/3.server-tools/1.data-import.md).
First, the Cora dataset needs to be imported into the TuGraph database. Please refer to [Data Import](../6.utility-tools/1.data-import.md).

In the build/output section below the line:
``` bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Use the `lgraph_export` tool to export the data and transfer the data to the new
```

### 3.2. Import data
Use the `lgraph_import` tool to import data and manually load the stored procedure (see [client operation steps](../5.developer-manual/4.client-tools/2.cpp-client.md) for details)
Use the `lgraph_import` tool to import data and manually load the stored procedure (see [client operation steps](../7.client-tools/2.cpp-client.md) for details)
```bash
lgraph_import -c db.export/import.config -d db
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ Users can choose different environments based on actual usage scenarios. The com
| Running environment | Run TuGraph installation package | Applicable to most users |
| Simplified operating environment | Run simplified TuGraph installation package | Less dependence on the operating system |

For a detailed introduction to different environments, see [link](../5.developer-manual/1.installation/2.environment-mode.md).
For a detailed introduction to different environments, see [link](../5.installation&running/2.environment-mode.md).

## 3. Deployment method selection

TuGraph deployment only requires one server (high availability mode requires multiple servers), and you can choose a suitable deployment method based on actual resource conditions and usage scenarios.

| Deployment method | Description | Remarks |
|----------|-----------------------|--------------- -------------------------------------------------- --------------------------|
| Cloud deployment | Alibaba Cloud Computing Nest one-click deployment, free trial | Suitable for novices, process reference [Link](../5.developer-manual/1.installation/5.cloud-deployment.md) |
| Cloud deployment | Alibaba Cloud Computing Nest one-click deployment, free trial | Suitable for novices, process reference [Link](../5.installation&running/5.cloud-deployment.md) |
| Docker deployment | Cross-platform deployment through pre-prepared Docker images | Users with hardware requirements, such as performance testing, please refer to [link](../5.developer-manual/1.installation/3.docker-deployment. md) |
| Local deployment | Tightly coupled deployment in existing systems | Applicable to specified production environment, refer to the process [Link](../5.developer-manual/1.installation/4.local-package-deployment.md) |
| Local deployment | Tightly coupled deployment in existing systems | Applicable to specified production environment, refer to the process [Link](../5.installation&running/4.local-package-deployment.md) |

## 4. Next steps

After the deployment is completed, you can proceed to [Start Service](../5.developer-manual/2.running/2.tugraph-running.md) and [Data Import](../5.developer-manual/3. server-tools/1.data-import.md) and other operations, you can also experience the entire process through [Sample Data](../3.quick-start/2.demo/1.movie.md).
After the deployment is completed, you can proceed to [Start Service](../5.installation&running/7.tugraph-running.md) and [Data Import](../5.developer-manual/3. server-tools/1.data-import.md) and other operations, you can also experience the entire process through [Sample Data](../3.quick-start/2.demo/1.movie.md).
File renamed without changes.
File renamed without changes.
Loading
Loading