From e401e466f9b13a9c0ee68914d8060746bcaef5a7 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:44:13 +0800 Subject: [PATCH 01/28] Update index.rst --- docs/zh-CN/source/5.developer-manual/index.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst index 0a60fbc698..a5f82e6445 100644 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ b/docs/zh-CN/source/5.developer-manual/index.rst @@ -1,11 +1,11 @@ -开发者文档 -============= - -.. toctree:: - :maxdepth: 2 +开发者文档 +============= + +.. toctree:: + :maxdepth: 2 :glob: - 1.installation/index.rst + 1.installation&running/index.rst 2.running/index.rst 3.server-tools/index.rst 4.client-tools/index.rst From c5b8ae6f7edae385ab603ec8198c3685a483740b Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:49:36 +0800 Subject: [PATCH 02/28] Update index.rst --- docs/zh-CN/source/5.developer-manual/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst index a5f82e6445..9cb92e07bd 100644 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ b/docs/zh-CN/source/5.developer-manual/index.rst @@ -5,7 +5,7 @@ :maxdepth: 2 :glob: - 1.installation&running/index.rst + 1.installation/index.rst 2.running/index.rst 3.server-tools/index.rst 4.client-tools/index.rst From 8fce33b49745c68487628bea167e0bbafc9dd7a6 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:54:55 +0800 Subject: [PATCH 03/28] Update index.rst --- docs/zh-CN/source/5.developer-manual/index.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst index 9cb92e07bd..efaf8a031b 100644 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ b/docs/zh-CN/source/5.developer-manual/index.rst @@ -5,12 +5,10 @@ :maxdepth: 2 :glob: - 1.installation/index.rst - 2.running/index.rst - 3.server-tools/index.rst - 4.client-tools/index.rst - 5.ecosystem-tools/index.rst - 6.interface/index.rst - 7.quality/index.rst - 8.other/index.rst - + 1.installation&running/index.rst + 2.server-tools/index.rst + 3.client-tools/index.rst + 4.ecosystem-tools/index.rst + 5.interface/index.rst + 6.quality/index.rst + 7.other/index.rst From d2e9f548be5f7d85126cf639b83d832096ca0c53 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 20 Mar 2024 11:09:11 +0800 Subject: [PATCH 04/28] Update index.rst --- docs/zh-CN/source/5.developer-manual/index.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst index efaf8a031b..09e1522a7c 100644 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ b/docs/zh-CN/source/5.developer-manual/index.rst @@ -5,10 +5,11 @@ :maxdepth: 2 :glob: - 1.installation&running/index.rst - 2.server-tools/index.rst - 3.client-tools/index.rst - 4.ecosystem-tools/index.rst - 5.interface/index.rst - 6.quality/index.rst - 7.other/index.rst + 1.installation/index.rst + 2.running/index.rst + 3.server-tools/index.rst + 4.client-tools/index.rst + 5.ecosystem-tools/index.rst + 6.interface/index.rst + 7.quality/index.rst + 8.other/index.rst From bbe5fd69f0e0e2725947e606247db92f7ed9381b Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Wed, 20 Mar 2024 13:00:53 +0800 Subject: [PATCH 05/28] =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4=E3=80=82=E8=B0=83=E6=95=B44=EF=BC=8C5?= =?UTF-8?q?=E7=BA=A7=E7=9B=AE=E5=BD=95=E4=B8=BA2=EF=BC=8C3=E7=BA=A7?= =?UTF-8?q?=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README_CN.md | 6 +++--- docs/zh-CN/source/1.guide.md | 16 +++++++-------- .../8.other => 10. permission}/1.privilege.md | 0 .../8.other => 10. permission}/2.token.md | 4 ++-- .../3.reset_admin_password.md | 0 .../4.monitoring.md} | 0 .../4.log.md => 10. permission/5.log.md} | 2 +- .../8.other => 10. permission}/index.rst | 0 .../1.unit-testing.md | 0 .../2.integration-testing.md | 0 .../7.quality => 11.quality}/index.rst | 0 .../1.contributing.md | 2 +- .../2.community-roles.md | 0 .../3.individual-cla.md | 0 .../4.corporate-cla.md | 0 .../5.roadmap.md | 0 .../index.rst | 0 .../13.best-practices/1.rdbms-to-tugraph.md | 3 +++ .../2.learn_practices.md | 2 +- .../3.data_migration.md | 2 +- .../4.selection.md | 10 +++++----- .../index.rst | 0 docs/zh-CN/source/{8.faq.md => 14.faq.md} | 0 .../source/{9.contacts.md => 15.contacts.md} | 0 .../source/2.introduction/6.functionality.md | 2 +- .../source/3.quick-start/1.preparation.md | 2 +- .../source/4.user-guide/1.tugraph-browser.md | 6 +++--- .../5.developer-manual/2.running/index.rst | 8 -------- .../5.ecosystem-tools/3.tugraph-explorer.md | 3 --- .../5.ecosystem-tools/index.rst | 8 -------- .../6.interface/4.protocol/index.rst | 8 -------- .../5.developer-manual/6.interface/index.rst | 12 ----------- .../zh-CN/source/5.developer-manual/index.rst | 16 --------------- .../1.environment.md | 0 .../2.environment-mode.md | 0 .../3.docker-deployment.md | 2 +- .../4.local-package-deployment.md | 0 .../5.cloud-deployment.md | 20 +++++++++---------- .../6.compile.md} | 2 +- .../7.tugraph-running.md} | 2 +- .../8.high-availability-mode.md} | 2 +- .../index.rst | 0 .../1.data-import.md | 0 .../2.data-export.md | 0 .../3.backup-and-restore.md | 0 .../4.data-warmup.md | 0 .../5.ha-cluster-management.md | 0 .../6.tugraph-cli.md} | 0 .../7.tugraph-datax.md} | 2 +- .../6.utility-tools/8.tugraph-explorer.md | 3 +++ .../9.restful.md} | 0 .../index.rst | 0 .../7.best-practices/1.rdbms-to-tugraph.md | 3 --- .../1.python-client.md | 0 .../10.restful-api-legacy.md} | 0 .../2.cpp-client.md | 0 .../3.java-client.md | 0 .../4.tugraph-ogm.md | 0 .../6.bolt-client.md | 0 .../7.bolt-console-client.md | 0 .../8.restful-api.md} | 0 .../9.rpc-api.md} | 0 .../index.rst | 0 .../1.query => 8.query}/1.cypher.md | 0 .../1.query => 8.query}/2.gql/1.intro.md | 0 .../2.gql/2.clauses/1.match.md | 0 .../2.gql/2.clauses/2.optional_match.md | 0 .../2.gql/2.clauses/3.return.md | 0 .../2.gql/2.clauses/4.next.md | 0 .../2.gql/2.clauses/5.where.md | 0 .../2.gql/2.clauses/6.orderby.md | 0 .../2.gql/2.clauses/7.skip.md | 0 .../2.gql/2.clauses/8.limit.md | 0 .../2.gql/2.clauses/index.rst | 0 .../1.query => 8.query}/2.gql/index.rst | 0 .../6.interface/1.query => 8.query}/index.rst | 0 .../1.procedure}/1.procedure.md | 0 .../1.procedure}/2.traversal.md | 0 .../3.C++-procedure/1.base64_encode.rst | 0 .../3.C++-procedure/10.lgraph_result.rst | 0 .../3.C++-procedure/11.lgraph_rpc_client.rst | 0 .../3.C++-procedure/12.lgraph_traversal.rst | 0 .../3.C++-procedure/13.lgraph_txn.rst | 0 .../3.C++-procedure/14.lgraph_types.rst | 0 .../3.C++-procedure/15.lgraph_utils.rst | 0 .../16.lgraph_vertex_index_iterator.rst | 0 .../17.lgraph_vertex_iterator.rst | 0 .../3.C++-procedure/18.olap_base.rst | 0 .../3.C++-procedure/19.olap_on_db.rst | 0 .../1.procedure}/3.C++-procedure/2.lgraph.rst | 0 .../3.C++-procedure/20.olap_profile.rst | 0 .../3.C++-procedure/3.lgraph_atomic.rst | 0 .../3.C++-procedure/4.lgraph_date_time.rst | 0 .../3.C++-procedure/5.lgraph_db.rst | 0 .../6.lgraph_edge_index_iterator.rst | 0 .../7.lgraph_edge_iterator.rst | 0 .../3.C++-procedure/8.lgraph_exceptions.rst | 0 .../3.C++-procedure/9.lgraph_galaxy.rst | 0 .../1.procedure}/3.C++-procedure/index.rst | 0 .../1.procedure}/4.Python-procedure.rst | 0 .../1.procedure}/5.Rust-procedure.md | 0 .../1.procedure}/Doxyfile | 0 .../1.procedure}/index.rst | 0 .../1.procedure}/index.rst.aci | 0 .../2.olap/1.tutorial.md | 0 .../2.olap/2.olap-base-api.md | 0 .../2.olap/3.olap-on-db-api.md | 0 .../2.olap/4.olap-on-disk-api.md | 0 .../2.olap/5.python-api.md | 0 .../2.olap/6.algorithms.md | 0 .../2.olap/index.rst | 0 .../3.learn}/1.tutorial.md | 6 +++--- .../3.learn}/2.sampling_api.md | 0 .../3.learn}/3.training.md | 0 .../3.learn}/4.heterogeneous_graph.md | 0 .../3.learn}/index.rst | 0 docs/zh-CN/source/9.olap&procedure/index.rst | 10 ++++++++++ docs/zh-CN/source/index.rst | 16 ++++++++++----- 118 files changed, 72 insertions(+), 108 deletions(-) rename docs/zh-CN/source/{5.developer-manual/8.other => 10. permission}/1.privilege.md (100%) rename docs/zh-CN/source/{5.developer-manual/8.other => 10. permission}/2.token.md (94%) rename docs/zh-CN/source/{5.developer-manual/8.other => 10. permission}/3.reset_admin_password.md (100%) rename docs/zh-CN/source/{5.developer-manual/5.ecosystem-tools/1.monitoring.md => 10. permission/4.monitoring.md} (100%) rename docs/zh-CN/source/{5.developer-manual/5.ecosystem-tools/4.log.md => 10. permission/5.log.md} (97%) rename docs/zh-CN/source/{5.developer-manual/8.other => 10. permission}/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/7.quality => 11.quality}/1.unit-testing.md (100%) rename docs/zh-CN/source/{5.developer-manual/7.quality => 11.quality}/2.integration-testing.md (100%) rename docs/zh-CN/source/{5.developer-manual/7.quality => 11.quality}/index.rst (100%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/1.contributing.md (97%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/2.community-roles.md (100%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/3.individual-cla.md (100%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/4.corporate-cla.md (100%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/5.roadmap.md (100%) rename docs/zh-CN/source/{6.contributor-manual => 12.contributor-manual}/index.rst (100%) create mode 100644 docs/zh-CN/source/13.best-practices/1.rdbms-to-tugraph.md rename docs/zh-CN/source/{7.best-practices => 13.best-practices}/2.learn_practices.md (98%) rename docs/zh-CN/source/{7.best-practices => 13.best-practices}/3.data_migration.md (97%) rename docs/zh-CN/source/{7.best-practices => 13.best-practices}/4.selection.md (69%) rename docs/zh-CN/source/{7.best-practices => 13.best-practices}/index.rst (100%) rename docs/zh-CN/source/{8.faq.md => 14.faq.md} (100%) rename docs/zh-CN/source/{9.contacts.md => 15.contacts.md} (100%) delete mode 100644 docs/zh-CN/source/5.developer-manual/2.running/index.rst delete mode 100644 docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md delete mode 100644 docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/index.rst delete mode 100644 docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/index.rst delete mode 100644 docs/zh-CN/source/5.developer-manual/6.interface/index.rst delete mode 100644 docs/zh-CN/source/5.developer-manual/index.rst rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/1.environment.md (100%) rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/2.environment-mode.md (100%) rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/3.docker-deployment.md (97%) rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/4.local-package-deployment.md (100%) rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/5.cloud-deployment.md (91%) rename docs/zh-CN/source/{5.developer-manual/2.running/1.compile.md => 5.installation&running/6.compile.md} (94%) rename docs/zh-CN/source/{5.developer-manual/2.running/2.tugraph-running.md => 5.installation&running/7.tugraph-running.md} (99%) rename docs/zh-CN/source/{5.developer-manual/2.running/3.high-availability-mode.md => 5.installation&running/8.high-availability-mode.md} (99%) rename docs/zh-CN/source/{5.developer-manual/1.installation => 5.installation&running}/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/1.data-import.md (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/2.data-export.md (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/3.backup-and-restore.md (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/4.data-warmup.md (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/5.ha-cluster-management.md (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools/5.tugraph-cli.md => 6.utility-tools/6.tugraph-cli.md} (100%) rename docs/zh-CN/source/{5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md => 6.utility-tools/7.tugraph-datax.md} (99%) create mode 100644 docs/zh-CN/source/6.utility-tools/8.tugraph-explorer.md rename docs/zh-CN/source/{5.developer-manual/5.ecosystem-tools/5.restful.md => 6.utility-tools/9.restful.md} (100%) rename docs/zh-CN/source/{5.developer-manual/3.server-tools => 6.utility-tools}/index.rst (100%) delete mode 100644 docs/zh-CN/source/7.best-practices/1.rdbms-to-tugraph.md rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/1.python-client.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md => 7.client-tools/10.restful-api-legacy.md} (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/2.cpp-client.md (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/3.java-client.md (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/4.tugraph-ogm.md (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/6.bolt-client.md (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/7.bolt-console-client.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/4.protocol/3.restful-api.md => 7.client-tools/8.restful-api.md} (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/4.protocol/2.rpc-api.md => 7.client-tools/9.rpc-api.md} (100%) rename docs/zh-CN/source/{5.developer-manual/4.client-tools => 7.client-tools}/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/1.cypher.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/1.intro.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/1.match.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/2.optional_match.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/3.return.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/4.next.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/5.where.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/6.orderby.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/7.skip.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/8.limit.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/2.clauses/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/2.gql/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/1.query => 8.query}/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/1.procedure.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/2.traversal.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/1.base64_encode.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/10.lgraph_result.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/11.lgraph_rpc_client.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/12.lgraph_traversal.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/13.lgraph_txn.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/14.lgraph_types.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/15.lgraph_utils.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/16.lgraph_vertex_index_iterator.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/17.lgraph_vertex_iterator.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/18.olap_base.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/19.olap_on_db.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/2.lgraph.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/20.olap_profile.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/3.lgraph_atomic.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/4.lgraph_date_time.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/5.lgraph_db.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/6.lgraph_edge_index_iterator.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/7.lgraph_edge_iterator.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/8.lgraph_exceptions.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/9.lgraph_galaxy.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/3.C++-procedure/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/4.Python-procedure.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/5.Rust-procedure.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/Doxyfile (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/index.rst.aci (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/1.tutorial.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/2.olap-base-api.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/3.olap-on-db-api.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/4.olap-on-disk-api.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/5.python-api.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/6.algorithms.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/index.rst (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/1.tutorial.md (95%) rename docs/zh-CN/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/2.sampling_api.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/3.training.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/4.heterogeneous_graph.md (100%) rename docs/zh-CN/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/index.rst (100%) create mode 100644 docs/zh-CN/source/9.olap&procedure/index.rst diff --git a/README_CN.md b/README_CN.md index 2e19ba7b60..c927ba99ec 100644 --- a/README_CN.md +++ b/README_CN.md @@ -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. 合作伙伴 diff --git a/docs/zh-CN/source/1.guide.md b/docs/zh-CN/source/1.guide.md index 171d27d498..ab1b0d7b0c 100644 --- a/docs/zh-CN/source/1.guide.md +++ b/docs/zh-CN/source/1.guide.md @@ -6,7 +6,7 @@ > 可以先了解[什么是图](./2.introduction/1.what-is-graph.md)、图[可以做什么](./2.introduction/7.scenarios.md)、以及[什么是TuGraph](./2.introduction/3.what-is-tugraph.md)。 -> 基于[阿里云计算巢](./5.developer-manual/1.installation/5.cloud-deployment.md)或[Docker方式](./5.developer-manual/1.installation/3.docker-deployment.md)快速部署TuGraph。 +> 基于[阿里云计算巢](5.installation&running/5.cloud-deployment.md)或[Docker方式](5.installation&running/3.docker-deployment.md)快速部署TuGraph。 > 通过产品内置的场景上手体验:[电影](./3.quick-start/2.demo/1.movie.md)、[流浪地球](./3.quick-start/2.demo/2.wandering-earth.md)、[三体](./3.quick-start/2.demo/3.the-three-body.md)、[三国](./3.quick-start/2.demo/4.three-kingdoms.md)。 @@ -14,19 +14,19 @@ ## 开发指南 -> 通过客户端访问TuGraph:[C++](./5.developer-manual/4.client-tools/2.cpp-client.md)、[Java](./5.developer-manual/4.client-tools/3.java-client.md)、[Python](./5.developer-manual/4.client-tools/1.python-client.md)。 +> 通过客户端访问TuGraph:[C++](7.client-tools/2.cpp-client.md)、[Java](7.client-tools/3.java-client.md)、[Python](7.client-tools/1.python-client.md)。 -> 查询语言、语句创建图模型看这里:[Cypher API](./5.developer-manual/6.interface/1.query/1.cypher.md). +> 查询语言、语句创建图模型看这里:[Cypher API](8.query/1.cypher.md). -> 存储过程和算法介绍看这里:[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 API (POG API)](9.olap&procedure/1.procedure/1.procedure.md)、[OLAP API](9.olap&procedure/2.olap/1.tutorial.md)。 -> C++/Python开发存储过程接口看这里:[C++/Python Procedure API](./5.developer-manual/6.interface/3.procedure/index.rst)。 +> C++/Python开发存储过程接口看这里:[C++/Python Procedure API](9.olap&procedure/1.procedure/index.rst)。 ## 参与社区贡献 -> 在开始贡献前,可以先了解[如何贡献](./6.contributor-manual/1.contributing.md) +> 在开始贡献前,可以先了解[如何贡献](12.contributor-manual/1.contributing.md) -> 如果想了解社区角色的划分,请访问[社区角色](./6.contributor-manual/2.community-roles.md) +> 如果想了解社区角色的划分,请访问[社区角色](12.contributor-manual/2.community-roles.md) ## 主要仓库 @@ -73,4 +73,4 @@ 版本更新日志见:[链接](https://github.com/TuGraph-family/tugraph-db/blob/master/release/CHANGELOG_CN.md )。 -如果您不清楚使用安装包和镜像,请参考 [环境和版本选择](./7.best-practices/4.selection.md)。 \ No newline at end of file +如果您不清楚使用安装包和镜像,请参考 [环境和版本选择](13.best-practices/4.selection.md)。 \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/8.other/1.privilege.md b/docs/zh-CN/source/10. permission/1.privilege.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/8.other/1.privilege.md rename to docs/zh-CN/source/10. permission/1.privilege.md diff --git a/docs/zh-CN/source/5.developer-manual/8.other/2.token.md b/docs/zh-CN/source/10. permission/2.token.md similarity index 94% rename from docs/zh-CN/source/5.developer-manual/8.other/2.token.md rename to docs/zh-CN/source/10. permission/2.token.md index 57b36bc07d..c8c97b1b04 100644 --- a/docs/zh-CN/source/5.developer-manual/8.other/2.token.md +++ b/docs/zh-CN/source/10. permission/2.token.md @@ -30,9 +30,9 @@ Token有效期存在刷新机制,默认关闭。如果打开后,Token的安 为了方便开发者自行开发,TuGraph提供了两种方式修改有效期,均需要admin权限。 * 通过接口调用设置。涉及有效期修改的接口`update_token_time`和有效期查询接口`get_token_time`。 -具体可查询[REST接口文档](../../5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md)。 +具体可查询[REST接口文档](../7.client-tools/10.restful-api-legacy.md)。 -* 通过启动参数设置。server端启动时,添加参数`-unlimited_token 1` 参数可以设置为无期限。可参考[服务运行文档](../../5.developer-manual/2.running/2.tugraph-running.md)。 +* 通过启动参数设置。server端启动时,添加参数`-unlimited_token 1` 参数可以设置为无期限。可参考[服务运行文档](../5.installation&running/7.tugraph-running.md)。 ## 3. 客户端发送Token相关请求介绍 diff --git a/docs/zh-CN/source/5.developer-manual/8.other/3.reset_admin_password.md b/docs/zh-CN/source/10. permission/3.reset_admin_password.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/8.other/3.reset_admin_password.md rename to docs/zh-CN/source/10. permission/3.reset_admin_password.md diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/1.monitoring.md b/docs/zh-CN/source/10. permission/4.monitoring.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/1.monitoring.md rename to docs/zh-CN/source/10. permission/4.monitoring.md diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md b/docs/zh-CN/source/10. permission/5.log.md similarity index 97% rename from docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md rename to docs/zh-CN/source/10. permission/5.log.md index f2cde8edca..71c35801cb 100644 --- a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/4.log.md +++ b/docs/zh-CN/source/10. permission/5.log.md @@ -71,4 +71,4 @@ extern "C" bool Process(GraphDB& db, const std::string& request, std::string& re 审核日志记录每个请求和响应,以及发送请求的用户以及收到请求的时间。审核日志只能是打开或关闭状态。可以使用 TuGraph 可视化工具和 REST API 查询结果。 -开启审计日志需要在配置文件中将`enable_audit_log`参数设置为`true`。配置文件和配置参数说明详见:[数据库运行/服务配置](../2.running/2.tugraph-running.md/#4服务配置)。 +开启审计日志需要在配置文件中将`enable_audit_log`参数设置为`true`。配置文件和配置参数说明详见:[数据库运行/服务配置](../../5.installation&running/7.tugraph-running.md/#4服务配置)。 diff --git a/docs/zh-CN/source/5.developer-manual/8.other/index.rst b/docs/zh-CN/source/10. permission/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/8.other/index.rst rename to docs/zh-CN/source/10. permission/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/7.quality/1.unit-testing.md b/docs/zh-CN/source/11.quality/1.unit-testing.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/7.quality/1.unit-testing.md rename to docs/zh-CN/source/11.quality/1.unit-testing.md diff --git a/docs/zh-CN/source/5.developer-manual/7.quality/2.integration-testing.md b/docs/zh-CN/source/11.quality/2.integration-testing.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/7.quality/2.integration-testing.md rename to docs/zh-CN/source/11.quality/2.integration-testing.md diff --git a/docs/zh-CN/source/5.developer-manual/7.quality/index.rst b/docs/zh-CN/source/11.quality/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/7.quality/index.rst rename to docs/zh-CN/source/11.quality/index.rst diff --git a/docs/zh-CN/source/6.contributor-manual/1.contributing.md b/docs/zh-CN/source/12.contributor-manual/1.contributing.md similarity index 97% rename from docs/zh-CN/source/6.contributor-manual/1.contributing.md rename to docs/zh-CN/source/12.contributor-manual/1.contributing.md index de5b25b6f6..18c9c1daec 100644 --- a/docs/zh-CN/source/6.contributor-manual/1.contributing.md +++ b/docs/zh-CN/source/12.contributor-manual/1.contributing.md @@ -19,7 +19,7 @@ 对于文档贡献,可以直接通过[文档](https://tugraph-db.readthedocs.io/zh_CN/latest),点击右上角的"在GitHub上编译"直接修改并提PR。 -对于代码贡献,通常需要在搭建编译执行的环境,可以采用[Docker部署](../5.developer-manual/1.installation/3.docker-deployment.md)或[本地部署](../5.developer-manual/1.installation/4.local-package-deployment.md)。 +对于代码贡献,通常需要在搭建编译执行的环境,可以采用[Docker部署](../5.installation&running/3.docker-deployment.md)或[本地部署](../5.installation&running/4.local-package-deployment.md)。 ### 3.3. 许可协议 diff --git a/docs/zh-CN/source/6.contributor-manual/2.community-roles.md b/docs/zh-CN/source/12.contributor-manual/2.community-roles.md similarity index 100% rename from docs/zh-CN/source/6.contributor-manual/2.community-roles.md rename to docs/zh-CN/source/12.contributor-manual/2.community-roles.md diff --git a/docs/zh-CN/source/6.contributor-manual/3.individual-cla.md b/docs/zh-CN/source/12.contributor-manual/3.individual-cla.md similarity index 100% rename from docs/zh-CN/source/6.contributor-manual/3.individual-cla.md rename to docs/zh-CN/source/12.contributor-manual/3.individual-cla.md diff --git a/docs/zh-CN/source/6.contributor-manual/4.corporate-cla.md b/docs/zh-CN/source/12.contributor-manual/4.corporate-cla.md similarity index 100% rename from docs/zh-CN/source/6.contributor-manual/4.corporate-cla.md rename to docs/zh-CN/source/12.contributor-manual/4.corporate-cla.md diff --git a/docs/zh-CN/source/6.contributor-manual/5.roadmap.md b/docs/zh-CN/source/12.contributor-manual/5.roadmap.md similarity index 100% rename from docs/zh-CN/source/6.contributor-manual/5.roadmap.md rename to docs/zh-CN/source/12.contributor-manual/5.roadmap.md diff --git a/docs/zh-CN/source/6.contributor-manual/index.rst b/docs/zh-CN/source/12.contributor-manual/index.rst similarity index 100% rename from docs/zh-CN/source/6.contributor-manual/index.rst rename to docs/zh-CN/source/12.contributor-manual/index.rst diff --git a/docs/zh-CN/source/13.best-practices/1.rdbms-to-tugraph.md b/docs/zh-CN/source/13.best-practices/1.rdbms-to-tugraph.md new file mode 100644 index 0000000000..addc159170 --- /dev/null +++ b/docs/zh-CN/source/13.best-practices/1.rdbms-to-tugraph.md @@ -0,0 +1,3 @@ +# 从关系型数据库导入TuGraph + +> 使用 [DataX](../6.utility-tools/7.tugraph-datax.md),待完善 \ No newline at end of file diff --git a/docs/zh-CN/source/7.best-practices/2.learn_practices.md b/docs/zh-CN/source/13.best-practices/2.learn_practices.md similarity index 98% rename from docs/zh-CN/source/7.best-practices/2.learn_practices.md rename to docs/zh-CN/source/13.best-practices/2.learn_practices.md index e4551f6f99..01171c1f11 100644 --- a/docs/zh-CN/source/7.best-practices/2.learn_practices.md +++ b/docs/zh-CN/source/13.best-practices/2.learn_practices.md @@ -39,7 +39,7 @@ TuGraph中已经提供了Cora数据集的导入工具,用户可以直接使用 ### 3.2. 数据导入 Cora数据集在test/integration/data/algo目录下,包含点集cora_vertices和边集cora_edge。 -首先需要将Cora数据集导入到TuGraph数据库中,详细操作可参考[数据导入](../5.developer-manual/3.server-tools/1.data-import.md)。 +首先需要将Cora数据集导入到TuGraph数据库中,详细操作可参考[数据导入](../6.utility-tools/1.data-import.md)。 在build/output目录下执行: ```bash diff --git a/docs/zh-CN/source/7.best-practices/3.data_migration.md b/docs/zh-CN/source/13.best-practices/3.data_migration.md similarity index 97% rename from docs/zh-CN/source/7.best-practices/3.data_migration.md rename to docs/zh-CN/source/13.best-practices/3.data_migration.md index 189f3015fe..df74c5c673 100644 --- a/docs/zh-CN/source/7.best-practices/3.data_migration.md +++ b/docs/zh-CN/source/13.best-practices/3.data_migration.md @@ -44,7 +44,7 @@ ``` ### 3.2. 导入数据 -使用`lgraph_import`工具导入数据,并手动加载存储过程(详见[client操作步骤](../5.developer-manual/4.client-tools/2.cpp-client.md)) +使用`lgraph_import`工具导入数据,并手动加载存储过程(详见[client操作步骤](../7.client-tools/2.cpp-client.md)) ```bash lgraph_import -c db.export/import.config -d db ``` diff --git a/docs/zh-CN/source/7.best-practices/4.selection.md b/docs/zh-CN/source/13.best-practices/4.selection.md similarity index 69% rename from docs/zh-CN/source/7.best-practices/4.selection.md rename to docs/zh-CN/source/13.best-practices/4.selection.md index 499d90a5c7..dd635f6f27 100644 --- a/docs/zh-CN/source/7.best-practices/4.selection.md +++ b/docs/zh-CN/source/13.best-practices/4.selection.md @@ -16,7 +16,7 @@ TuGraph为不同需求的用户提供了差异化的系统环境和部署方式 | 运行环境 | 运行TuGraph安装包 | 适用于大部分用户 | | 精简运行环境 | 运行精简TuGraph安装包 | 对系运行统依赖较小 | -不同环境的具体介绍参见 [链接](../5.developer-manual/1.installation/2.environment-mode.md)。 +不同环境的具体介绍参见 [链接](../5.installation&running/2.environment-mode.md)。 ## 3. 部署方式选择 @@ -24,10 +24,10 @@ TuGraph部署仅需一台服务器(高可用模式需要多台),可根据 | 部署方式 | 描述 | 备注 | |----------|----------------------|-----------------------------------------------------------------------------------------| -| 云部署 | 阿里云计算巢一键部署,免费试用 | 新手适用,流程参考 [链接](../5.developer-manual/1.installation/5.cloud-deployment.md) | -| Docker部署 | 通过预先准备的Docker镜像跨平台部署 | 对硬件有要求的用户,比如性能测试,流程参考 [链接](../5.developer-manual/1.installation/3.docker-deployment.md) | -| 本地部署 | 在现有系统紧耦合部署 | 指定生产环境适用,流程参考 [链接](../5.developer-manual/1.installation/4.local-package-deployment.md) | +| 云部署 | 阿里云计算巢一键部署,免费试用 | 新手适用,流程参考 [链接](../5.installation&running/5.cloud-deployment.md) | +| Docker部署 | 通过预先准备的Docker镜像跨平台部署 | 对硬件有要求的用户,比如性能测试,流程参考 [链接](../5.installation&running/3.docker-deployment.md) | +| 本地部署 | 在现有系统紧耦合部署 | 指定生产环境适用,流程参考 [链接](../5.installation&running/4.local-package-deployment.md) | ## 4. 后续步骤 -部署完成后,后续可以进行[启动服务](../5.developer-manual/2.running/2.tugraph-running.md)、[数据导入](../5.developer-manual/3.server-tools/1.data-import.md)等操作,也可以通过[样例数据](../3.quick-start/2.demo/1.movie.md)来体验整个流程。 \ No newline at end of file +部署完成后,后续可以进行[启动服务](../5.installation&running/7.tugraph-running.md)、[数据导入](../6.utility-tools/1.data-import.md)等操作,也可以通过[样例数据](../3.quick-start/2.demo/1.movie.md)来体验整个流程。 \ No newline at end of file diff --git a/docs/zh-CN/source/7.best-practices/index.rst b/docs/zh-CN/source/13.best-practices/index.rst similarity index 100% rename from docs/zh-CN/source/7.best-practices/index.rst rename to docs/zh-CN/source/13.best-practices/index.rst diff --git a/docs/zh-CN/source/8.faq.md b/docs/zh-CN/source/14.faq.md similarity index 100% rename from docs/zh-CN/source/8.faq.md rename to docs/zh-CN/source/14.faq.md diff --git a/docs/zh-CN/source/9.contacts.md b/docs/zh-CN/source/15.contacts.md similarity index 100% rename from docs/zh-CN/source/9.contacts.md rename to docs/zh-CN/source/15.contacts.md diff --git a/docs/zh-CN/source/2.introduction/6.functionality.md b/docs/zh-CN/source/2.introduction/6.functionality.md index 3178cf6d88..d146ff5239 100644 --- a/docs/zh-CN/source/2.introduction/6.functionality.md +++ b/docs/zh-CN/source/2.introduction/6.functionality.md @@ -58,7 +58,7 @@ TuGraph 支持 POG (Procedres on Graph Query Languages) 编程和 POG 库,其 制定中的 ISO GQL 等图查询语言。POG 库提供在查询语言中对用户定义的存储过程的访问,打破了查询语言和存储过程之间的界限,扩展了查询 语言的使用范围。 -> 这个文档描述了 [新的 Procedure 编程范式以及 POG](../5.developer-manual/6.interface/3.procedure/1.procedure.md)。 +> 这个文档描述了 [新的 Procedure 编程范式以及 POG](../9.olap&procedure/1.procedure/1.procedure.md)。 ### 4.3.数据导入导出 diff --git a/docs/zh-CN/source/3.quick-start/1.preparation.md b/docs/zh-CN/source/3.quick-start/1.preparation.md index 5e30ca1f00..99a093e150 100644 --- a/docs/zh-CN/source/3.quick-start/1.preparation.md +++ b/docs/zh-CN/source/3.quick-start/1.preparation.md @@ -48,7 +48,7 @@ TuGraph 可以通过 Docker Image 快速安装,或者通过 rpm/deb 包本地 > 安装包/镜像下载:[下载地址](../1.guide.md#TuGraph最新版本 )。 -> 计算巢部署:可以在阿里云计算巢自行搜索,也可以通过[部署链接]( ../5.developer-manual/1.installation/5.cloud-deployment.md )快速访问。 +> 计算巢部署:可以在阿里云计算巢自行搜索,也可以通过[部署链接]( ../5.installation&running/5.cloud-deployment.md )快速访问。 ### 2.1.通过docker快速体验 diff --git a/docs/zh-CN/source/4.user-guide/1.tugraph-browser.md b/docs/zh-CN/source/4.user-guide/1.tugraph-browser.md index c8e16b0849..12232c9413 100644 --- a/docs/zh-CN/source/4.user-guide/1.tugraph-browser.md +++ b/docs/zh-CN/source/4.user-guide/1.tugraph-browser.md @@ -127,7 +127,7 @@ Browser的`图构建`功能主要用于图项目的模型定义和数据导入 Browser提供可视化的方式创建和维护图模型。 -- 也可用通过`cypher`工具和`lgraph_import`工具创建和维护图模型,详见[Cypher API](../5.developer-manual/6.interface/1.query/1.cypher.md)和[数据导入](../5.developer-manual/3.server-tools/1.data-import.md)文档。 +- 也可用通过`cypher`工具和`lgraph_import`工具创建和维护图模型,详见[Cypher API](../8.query/1.cypher.md)和[数据导入](../6.utility-tools/1.data-import.md)文档。 ###### a.浏览图模型 @@ -308,7 +308,7 @@ Browser提供可视化方式开发和调试图查询语句,用户可以输入 ![图查询-下载按钮](../../../images/browser/query-download-button.png) -详细Cypher使用指南请参考文档:[Cypher API](../5.developer-manual/6.interface/1.query/1.cypher.md) +详细Cypher使用指南请参考文档:[Cypher API](../8.query/1.cypher.md) ###### b.收藏列表 @@ -636,7 +636,7 @@ CALL dbms.system.info() ##### 2.5.2.2.数据库配置信息 -`数据库配置信息`获取当前系统运行的配置参数,并展示关键信息。调整配置参数或了解详细配置参数请参考[数据库运行-服务配置](../5.developer-manual/2.running/2.tugraph-running.md)。 +`数据库配置信息`获取当前系统运行的配置参数,并展示关键信息。调整配置参数或了解详细配置参数请参考[数据库运行-服务配置](../5.installation&running/7.tugraph-running.md)。 ![数据库信息-数据库配置信息](../../../images/browser/db_configuration.png) diff --git a/docs/zh-CN/source/5.developer-manual/2.running/index.rst b/docs/zh-CN/source/5.developer-manual/2.running/index.rst deleted file mode 100644 index a653bf13ab..0000000000 --- a/docs/zh-CN/source/5.developer-manual/2.running/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -运行 -==== - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md b/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md deleted file mode 100644 index 5e31c46502..0000000000 --- a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md +++ /dev/null @@ -1,3 +0,0 @@ -# TuGraph-Explorer - -> TuGraph Explorer 已经合并到 [TuGraph Browser](../../4.user-guide/1.tugraph-browser.md) diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/index.rst b/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/index.rst deleted file mode 100644 index bf92f16478..0000000000 --- a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -生态工具 -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/index.rst b/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/index.rst deleted file mode 100644 index f509ac8dd3..0000000000 --- a/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -网络协议 -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/index.rst b/docs/zh-CN/source/5.developer-manual/6.interface/index.rst deleted file mode 100644 index 2dbfe16fbd..0000000000 --- a/docs/zh-CN/source/5.developer-manual/6.interface/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -编程接口 -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.query/index.rst - 2.olap/index.rst - 3.procedure/index.rst - 4.protocol/index.rst - 5.learn/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst deleted file mode 100644 index 0a60fbc698..0000000000 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -开发者文档 -============= - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.installation/index.rst - 2.running/index.rst - 3.server-tools/index.rst - 4.client-tools/index.rst - 5.ecosystem-tools/index.rst - 6.interface/index.rst - 7.quality/index.rst - 8.other/index.rst - diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/1.environment.md b/docs/zh-CN/source/5.installation&running/1.environment.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/1.installation/1.environment.md rename to docs/zh-CN/source/5.installation&running/1.environment.md diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/2.environment-mode.md b/docs/zh-CN/source/5.installation&running/2.environment-mode.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/1.installation/2.environment-mode.md rename to docs/zh-CN/source/5.installation&running/2.environment-mode.md diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/3.docker-deployment.md b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md similarity index 97% rename from docs/zh-CN/source/5.developer-manual/1.installation/3.docker-deployment.md rename to docs/zh-CN/source/5.installation&running/3.docker-deployment.md index f46964b1ed..5f5a3b7232 100644 --- a/docs/zh-CN/source/5.developer-manual/1.installation/3.docker-deployment.md +++ b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ 镜像托管在[DockerHub]( https://hub.docker.com/u/tugraph ),可直接下载使用。 -最新版本的Docker地址参见 [链接](../../1.guide.md#TuGraph最新版本)。 +最新版本的Docker地址参见 [链接](../1.guide.md#TuGraph最新版本)。 ### 2.2.命名规范 diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/1.installation/4.local-package-deployment.md rename to docs/zh-CN/source/5.installation&running/4.local-package-deployment.md diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/5.cloud-deployment.md b/docs/zh-CN/source/5.installation&running/5.cloud-deployment.md similarity index 91% rename from docs/zh-CN/source/5.developer-manual/1.installation/5.cloud-deployment.md rename to docs/zh-CN/source/5.installation&running/5.cloud-deployment.md index 9d4184acdf..7ac7e1cfc0 100644 --- a/docs/zh-CN/source/5.developer-manual/1.installation/5.cloud-deployment.md +++ b/docs/zh-CN/source/5.installation&running/5.cloud-deployment.md @@ -36,7 +36,7 @@ TuGraph部署的为社区开源版本,源码参考Github Repo,目前可以 | AliyunComputeNestUserFullAccess | 管理计算巢服务(ComputeNest)的用户侧权限 | | AliyunCloudMonitorFullAccess | 管理云监控(CloudMonitor)的权限 | -![同意授权并创建关联角色](../../../../images/cloud-deployment-1.png) +![同意授权并创建关联角色](../../../images/cloud-deployment-1.png) ### 3.2.部署入口 @@ -48,7 +48,7 @@ TuGraph部署的为社区开源版本,源码参考Github Repo,目前可以 在正式试用前,需要申请试用,按照提示填写信息,在审核通过后就可以创建TuGraph服务。 -![申请试用](../../../../images/cloud-deployment-2.png) +![申请试用](../../../images/cloud-deployment-2.png) ### 3.4.创建TuGraph服务 @@ -74,37 +74,37 @@ TuGraph部署的为社区开源版本,源码参考Github Repo,目前可以 - 创建实例名称,如下图中“test” - 选择地域,如下图中“华东1(杭州)” -![创建实例](../../../../images/cloud-deployment-3.png) +![创建实例](../../../images/cloud-deployment-3.png) - 选择实例类型,当前支持ecs.r6.xlarge和ecs.r7a.xlarge规格。如果列表中无机型可选,请尝试选择其他的部署区域 - 选中机型 - 配置实例的密码 - 选择部署区域,如下图中“可用区I” -![选择区域](../../../../images/cloud-deployment-4.png) +![选择区域](../../../images/cloud-deployment-4.png) - 点击下一步,进入订单确认页面 - 勾选“权限确认”和“服务条款”中的复选框 - 点击左下角绿色背景的开始免费试用,即可创建服务实例 -![确认](../../../../images/cloud-deployment-5.png) +![确认](../../../images/cloud-deployment-5.png) ### 3.5.启动TuGraph服务 - 查看服务实例:服务实例创建成功后,部署时间大约需要2分钟。部署完成后,页面上可以看到对应的服务实例,如下图 -![查看实例](../../../../images/cloud-deployment-6.png) +![查看实例](../../../images/cloud-deployment-6.png) - 点击该服务实例访问TuGraph。进入到对应的服务实例后,可以在页面上获取到web、rpc、ssh共3种使用方式,并且页面上展示了admin用户的密码 -![访问方式](../../../../images/cloud-deployment-7.png) +![访问方式](../../../images/cloud-deployment-7.png) - 点击web的链接,即可跳转访问已经部署好的TuGraph Web。建议新手先通过TuGraph Web,快速使用demo上手。 - 首先在TuGraph Web的登录页面上,输入默认用户名admin和页面上展示的admin用户的密码进行登录,参考下图 - 登录完成后,选择任意一个带有官方图标的图项目,其中内置了demo数据,开启图数据的探索和发现! -![登录](../../../../images/cloud-deployment-8.png) -![创建demo](../../../../images/cloud-deployment-9.png) +![登录](../../../images/cloud-deployment-8.png) +![创建demo](../../../images/cloud-deployment-9.png) ## 4.常见FAQ @@ -112,7 +112,7 @@ TuGraph部署的为社区开源版本,源码参考Github Repo,目前可以 有时,所选部署区域(如可用区G)没有所选套餐的可用资源,会报错如下图所示 -![部署区域错误](../../../../images/cloud-deployment-10.png) +![部署区域错误](../../../images/cloud-deployment-10.png) __解决办法__:尝试选择其他区域,如可用区I等 diff --git a/docs/zh-CN/source/5.developer-manual/2.running/1.compile.md b/docs/zh-CN/source/5.installation&running/6.compile.md similarity index 94% rename from docs/zh-CN/source/5.developer-manual/2.running/1.compile.md rename to docs/zh-CN/source/5.installation&running/6.compile.md index 3c643ec5f5..7a460830fa 100644 --- a/docs/zh-CN/source/5.developer-manual/2.running/1.compile.md +++ b/docs/zh-CN/source/5.installation&running/6.compile.md @@ -4,7 +4,7 @@ ## 1.前置条件 -推荐在linux系统下搭建TuGraph。同时docker环境是个不错的选择,如果你想设置一个新的环境,请参考[Dockerfile](../1.installation/3.docker-deployment.md)。 +推荐在linux系统下搭建TuGraph。同时docker环境是个不错的选择,如果你想设置一个新的环境,请参考[Dockerfile](3.docker-deployment.md)。 ## 2.编译介绍 diff --git a/docs/zh-CN/source/5.developer-manual/2.running/2.tugraph-running.md b/docs/zh-CN/source/5.installation&running/7.tugraph-running.md similarity index 99% rename from docs/zh-CN/source/5.developer-manual/2.running/2.tugraph-running.md rename to docs/zh-CN/source/5.installation&running/7.tugraph-running.md index 77b1432a34..648ce6b2a2 100644 --- a/docs/zh-CN/source/5.developer-manual/2.running/2.tugraph-running.md +++ b/docs/zh-CN/source/5.installation&running/7.tugraph-running.md @@ -4,7 +4,7 @@ ## 1.前置条件 -TuGraph 运行的前置条件为 TuGraph 正确安装,参考[安装流程](../1.installation/1.environment.md)。 +TuGraph 运行的前置条件为 TuGraph 正确安装,参考[安装流程](1.environment.md)。 TuGraph 运行需要保证库文件 liblgraph.so 的文件位置在环境变量 LD_LIBRARY_PATH。 diff --git a/docs/zh-CN/source/5.developer-manual/2.running/3.high-availability-mode.md b/docs/zh-CN/source/5.installation&running/8.high-availability-mode.md similarity index 99% rename from docs/zh-CN/source/5.developer-manual/2.running/3.high-availability-mode.md rename to docs/zh-CN/source/5.installation&running/8.high-availability-mode.md index f9abf18093..1d38b39017 100644 --- a/docs/zh-CN/source/5.developer-manual/2.running/3.high-availability-mode.md +++ b/docs/zh-CN/source/5.installation&running/8.high-availability-mode.md @@ -39,7 +39,7 @@ v3.6及以上版本支持此功能。 ## 3.启动初始备份组 -安装好TuGraph之后,可以使用`lgraph_server`命令在不同的机器上启动高可用集群。本节主要讲解高可用集群的启动方式,启动之后的集群状态管理参见[lgraph_peer工具](../3.server-tools/5.ha-cluster-management.md) +安装好TuGraph之后,可以使用`lgraph_server`命令在不同的机器上启动高可用集群。本节主要讲解高可用集群的启动方式,启动之后的集群状态管理参见[lgraph_peer工具](../6.utility-tools/5.ha-cluster-management.md) ### 3.1.初始数据一致 diff --git a/docs/zh-CN/source/5.developer-manual/1.installation/index.rst b/docs/zh-CN/source/5.installation&running/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/1.installation/index.rst rename to docs/zh-CN/source/5.installation&running/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/1.data-import.md b/docs/zh-CN/source/6.utility-tools/1.data-import.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/1.data-import.md rename to docs/zh-CN/source/6.utility-tools/1.data-import.md diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/2.data-export.md b/docs/zh-CN/source/6.utility-tools/2.data-export.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/2.data-export.md rename to docs/zh-CN/source/6.utility-tools/2.data-export.md diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/3.backup-and-restore.md b/docs/zh-CN/source/6.utility-tools/3.backup-and-restore.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/3.backup-and-restore.md rename to docs/zh-CN/source/6.utility-tools/3.backup-and-restore.md diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/4.data-warmup.md b/docs/zh-CN/source/6.utility-tools/4.data-warmup.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/4.data-warmup.md rename to docs/zh-CN/source/6.utility-tools/4.data-warmup.md diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/5.ha-cluster-management.md b/docs/zh-CN/source/6.utility-tools/5.ha-cluster-management.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/5.ha-cluster-management.md rename to docs/zh-CN/source/6.utility-tools/5.ha-cluster-management.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/5.tugraph-cli.md b/docs/zh-CN/source/6.utility-tools/6.tugraph-cli.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/5.tugraph-cli.md rename to docs/zh-CN/source/6.utility-tools/6.tugraph-cli.md diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md b/docs/zh-CN/source/6.utility-tools/7.tugraph-datax.md similarity index 99% rename from docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md rename to docs/zh-CN/source/6.utility-tools/7.tugraph-datax.md index 7e51e52b7e..643597f2bc 100644 --- a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md +++ b/docs/zh-CN/source/6.utility-tools/7.tugraph-datax.md @@ -10,7 +10,7 @@ TuGraph DataX 介绍 [https://github.com/TuGraph-family/DataX](https://github.co - 从 MySQL、SQL Server、Oracle、PostgreSQL、HDFS、Hive、HBase、OTS、ODPS、Kafka 等各种异构数据源导入 TuGraph - 将 TuGraph 导入相应的目标源 (待开发) -![导入导出](../../../../images/tugraph-datax.png) +![导入导出](../../../images/tugraph-datax.png) DataX 原始项目介绍参考 [https://github.com/alibaba/DataX](https://github.com/alibaba/DataX) diff --git a/docs/zh-CN/source/6.utility-tools/8.tugraph-explorer.md b/docs/zh-CN/source/6.utility-tools/8.tugraph-explorer.md new file mode 100644 index 0000000000..ea866abf5d --- /dev/null +++ b/docs/zh-CN/source/6.utility-tools/8.tugraph-explorer.md @@ -0,0 +1,3 @@ +# TuGraph-Explorer + +> TuGraph Explorer 已经合并到 [TuGraph Browser](../4.user-guide/1.tugraph-browser.md) diff --git a/docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/5.restful.md b/docs/zh-CN/source/6.utility-tools/9.restful.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/5.ecosystem-tools/5.restful.md rename to docs/zh-CN/source/6.utility-tools/9.restful.md diff --git a/docs/zh-CN/source/5.developer-manual/3.server-tools/index.rst b/docs/zh-CN/source/6.utility-tools/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/3.server-tools/index.rst rename to docs/zh-CN/source/6.utility-tools/index.rst diff --git a/docs/zh-CN/source/7.best-practices/1.rdbms-to-tugraph.md b/docs/zh-CN/source/7.best-practices/1.rdbms-to-tugraph.md deleted file mode 100644 index b6d52c3592..0000000000 --- a/docs/zh-CN/source/7.best-practices/1.rdbms-to-tugraph.md +++ /dev/null @@ -1,3 +0,0 @@ -# 从关系型数据库导入TuGraph - -> 使用 [DataX](../5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md),待完善 \ No newline at end of file diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/1.python-client.md b/docs/zh-CN/source/7.client-tools/1.python-client.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/1.python-client.md rename to docs/zh-CN/source/7.client-tools/1.python-client.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md b/docs/zh-CN/source/7.client-tools/10.restful-api-legacy.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md rename to docs/zh-CN/source/7.client-tools/10.restful-api-legacy.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/2.cpp-client.md b/docs/zh-CN/source/7.client-tools/2.cpp-client.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/2.cpp-client.md rename to docs/zh-CN/source/7.client-tools/2.cpp-client.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/3.java-client.md b/docs/zh-CN/source/7.client-tools/3.java-client.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/3.java-client.md rename to docs/zh-CN/source/7.client-tools/3.java-client.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/4.tugraph-ogm.md b/docs/zh-CN/source/7.client-tools/4.tugraph-ogm.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/4.tugraph-ogm.md rename to docs/zh-CN/source/7.client-tools/4.tugraph-ogm.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/6.bolt-client.md b/docs/zh-CN/source/7.client-tools/6.bolt-client.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/6.bolt-client.md rename to docs/zh-CN/source/7.client-tools/6.bolt-client.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/7.bolt-console-client.md b/docs/zh-CN/source/7.client-tools/7.bolt-console-client.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/7.bolt-console-client.md rename to docs/zh-CN/source/7.client-tools/7.bolt-console-client.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/3.restful-api.md b/docs/zh-CN/source/7.client-tools/8.restful-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/3.restful-api.md rename to docs/zh-CN/source/7.client-tools/8.restful-api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/2.rpc-api.md b/docs/zh-CN/source/7.client-tools/9.rpc-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/4.protocol/2.rpc-api.md rename to docs/zh-CN/source/7.client-tools/9.rpc-api.md diff --git a/docs/zh-CN/source/5.developer-manual/4.client-tools/index.rst b/docs/zh-CN/source/7.client-tools/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/4.client-tools/index.rst rename to docs/zh-CN/source/7.client-tools/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/1.cypher.md b/docs/zh-CN/source/8.query/1.cypher.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/1.cypher.md rename to docs/zh-CN/source/8.query/1.cypher.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md b/docs/zh-CN/source/8.query/2.gql/1.intro.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md rename to docs/zh-CN/source/8.query/2.gql/1.intro.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md rename to docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst b/docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst rename to docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/index.rst b/docs/zh-CN/source/8.query/2.gql/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/2.gql/index.rst rename to docs/zh-CN/source/8.query/2.gql/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/1.query/index.rst b/docs/zh-CN/source/8.query/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/1.query/index.rst rename to docs/zh-CN/source/8.query/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/1.procedure.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/1.procedure.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/1.procedure.md rename to docs/zh-CN/source/9.olap&procedure/1.procedure/1.procedure.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/2.traversal.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/2.traversal.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/2.traversal.md rename to docs/zh-CN/source/9.olap&procedure/1.procedure/2.traversal.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/4.Python-procedure.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/4.Python-procedure.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/5.Rust-procedure.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/5.Rust-procedure.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/5.Rust-procedure.md rename to docs/zh-CN/source/9.olap&procedure/1.procedure/5.Rust-procedure.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/Doxyfile b/docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/Doxyfile rename to docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/index.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/index.rst.aci b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst.aci similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/3.procedure/index.rst.aci rename to docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst.aci diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/1.tutorial.md b/docs/zh-CN/source/9.olap&procedure/2.olap/1.tutorial.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/1.tutorial.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/1.tutorial.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/2.olap-base-api.md b/docs/zh-CN/source/9.olap&procedure/2.olap/2.olap-base-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/2.olap-base-api.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/2.olap-base-api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/3.olap-on-db-api.md b/docs/zh-CN/source/9.olap&procedure/2.olap/3.olap-on-db-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/3.olap-on-db-api.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/3.olap-on-db-api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/4.olap-on-disk-api.md b/docs/zh-CN/source/9.olap&procedure/2.olap/4.olap-on-disk-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/4.olap-on-disk-api.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/4.olap-on-disk-api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/5.python-api.md b/docs/zh-CN/source/9.olap&procedure/2.olap/5.python-api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/5.python-api.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/5.python-api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/6.algorithms.md b/docs/zh-CN/source/9.olap&procedure/2.olap/6.algorithms.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/6.algorithms.md rename to docs/zh-CN/source/9.olap&procedure/2.olap/6.algorithms.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/2.olap/index.rst b/docs/zh-CN/source/9.olap&procedure/2.olap/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/2.olap/index.rst rename to docs/zh-CN/source/9.olap&procedure/2.olap/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/1.tutorial.md b/docs/zh-CN/source/9.olap&procedure/3.learn/1.tutorial.md similarity index 95% rename from docs/zh-CN/source/5.developer-manual/6.interface/5.learn/1.tutorial.md rename to docs/zh-CN/source/9.olap&procedure/3.learn/1.tutorial.md index 8f3fe0316f..46813c7cca 100644 --- a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/1.tutorial.md +++ b/docs/zh-CN/source/9.olap&procedure/3.learn/1.tutorial.md @@ -11,10 +11,10 @@ ## 2. 运行流程 TuGraph 图学习模块将TuGraph中的图数据采样,采样后的顶点和边作为图学习的特征,进行学习训练。运行流程如下图所示: -![Alt text](../../../../../images/learn_flow_chart_zh.png) +![Alt text](../../../../images/learn_flow_chart_zh.png) ## 3.TuGraph编译及数据准备 -TuGraph编译请参考:[编译](../../../5.developer-manual/2.running/1.compile.md) +TuGraph编译请参考:[编译](../../5.installation&running/6.compile.md) 在build/output目录下执行: ```bash cp -r ../../test/integration/data/ ./ && cp -r ../../learn/examples/* ./ @@ -23,7 +23,7 @@ cp -r ../../test/integration/data/ ./ && cp -r ../../learn/examples/* ./ 该指令将数据集相关文件拷贝到build/output目录下。 ## 4. 数据导入 -数据导入请参考[数据导入](../../../5.developer-manual/3.server-tools/1.data-import.md) +数据导入请参考[数据导入](../../6.utility-tools/1.data-import.md) 导入过程以cora数据集为例: diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/2.sampling_api.md b/docs/zh-CN/source/9.olap&procedure/3.learn/2.sampling_api.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/5.learn/2.sampling_api.md rename to docs/zh-CN/source/9.olap&procedure/3.learn/2.sampling_api.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/3.training.md b/docs/zh-CN/source/9.olap&procedure/3.learn/3.training.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/5.learn/3.training.md rename to docs/zh-CN/source/9.olap&procedure/3.learn/3.training.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/4.heterogeneous_graph.md b/docs/zh-CN/source/9.olap&procedure/3.learn/4.heterogeneous_graph.md similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/5.learn/4.heterogeneous_graph.md rename to docs/zh-CN/source/9.olap&procedure/3.learn/4.heterogeneous_graph.md diff --git a/docs/zh-CN/source/5.developer-manual/6.interface/5.learn/index.rst b/docs/zh-CN/source/9.olap&procedure/3.learn/index.rst similarity index 100% rename from docs/zh-CN/source/5.developer-manual/6.interface/5.learn/index.rst rename to docs/zh-CN/source/9.olap&procedure/3.learn/index.rst diff --git a/docs/zh-CN/source/9.olap&procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/index.rst new file mode 100644 index 0000000000..7432d19b52 --- /dev/null +++ b/docs/zh-CN/source/9.olap&procedure/index.rst @@ -0,0 +1,10 @@ +编程接口 +======== + +.. toctree:: + :maxdepth: 2 + :glob: + + 1.procedure/index.rst + 2.olap/index.rst + 3.learn/index.rst \ No newline at end of file diff --git a/docs/zh-CN/source/index.rst b/docs/zh-CN/source/index.rst index 1e1f1abfa5..6834fd569c 100644 --- a/docs/zh-CN/source/index.rst +++ b/docs/zh-CN/source/index.rst @@ -10,8 +10,14 @@ TuGraph高性能图数据库 2.introduction/index.rst 3.quick-start/index.rst 4.user-guide/index.rst - 5.developer-manual/index.rst - 6.contributor-manual/index.rst - 7.best-practices/index.rst - 8.faq.md - 9.contacts.md + 5.installation&running/index.rst + 6.utility-tools/index.rst + 7.client-tools/index.rst + 8.query/index.rst + 9.olap&procedure/index.rst + 10.permission/index.rst + 11.quality/index.rst + 12.contributor-manual/index.rst + 13.best-practices/index.rst + 14.faq.md + 15.contacts.md From e48cd78516462fcf06d8dceb31cdbc66421999c1 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Wed, 20 Mar 2024 13:28:58 +0800 Subject: [PATCH 06/28] =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4=E3=80=82=E8=B0=83=E6=95=B44=EF=BC=8C5?= =?UTF-8?q?=E7=BA=A7=E7=9B=AE=E5=BD=95=E4=B8=BA2=EF=BC=8C3=E7=BA=A7?= =?UTF-8?q?=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/5.developer-manual/index.rst | 15 --------------- 1 file changed, 15 deletions(-) delete mode 100644 docs/zh-CN/source/5.developer-manual/index.rst diff --git a/docs/zh-CN/source/5.developer-manual/index.rst b/docs/zh-CN/source/5.developer-manual/index.rst deleted file mode 100644 index 5c99dbcd7e..0000000000 --- a/docs/zh-CN/source/5.developer-manual/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -开发者文档 -============= - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.installation/index.rst - 2.running/index.rst - 3.server-tools/index.rst - 4.client-tools/index.rst - 5.ecosystem-tools/index.rst - 6.interface/index.rst - 7.quality/index.rst - 8.other/index.rst From f17750c447cf88a3e15df3741aa93dc8263c14ff Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 20 Mar 2024 13:51:28 +0800 Subject: [PATCH 07/28] Update conf.py --- docs/zh-CN/source/conf.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/zh-CN/source/conf.py b/docs/zh-CN/source/conf.py index 8bcf4b9ebe..98dd5105a9 100644 --- a/docs/zh-CN/source/conf.py +++ b/docs/zh-CN/source/conf.py @@ -34,16 +34,16 @@ subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/liblgraph_python_api.so")) subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/liblgraph.so")) subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/libjvm.so")) - sys.path.insert(0, os.path.abspath('5.developer-manual/6.interface/3.procedure/')) + sys.path.insert(0, os.path.abspath('9.olap&procedure/1.procedure/')) # doxygen & breathe extensions.append("breathe") - subprocess.run(shlex.split("doxygen"), cwd="5.developer-manual/6.interface/3.procedure/") - breathe_projects = {"cpp_procedure": "5.developer-manual/6.interface/3.procedure/build/xml"} + subprocess.run(shlex.split("doxygen"), cwd="9.olap&procedure/1.procedure/") + breathe_projects = {"cpp_procedure": "9.olap&procedure/1.procedure/build/xml"} breathe_default_project = "cpp_procedure" else: - if os.path.exists("5.developer-manual/6.interface/3.procedure/3.C++-procedure") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/index.rst") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/index.rst.aci"): - subprocess.run(shlex.split("rm -rf 3.C++-procedure 4.Python-procedure.rst index.rst"), cwd="5.developer-manual/6.interface/3.procedure/") - subprocess.run(shlex.split("mv index.rst.aci index.rst"), cwd="5.developer-manual/6.interface/3.procedure/") + if os.path.exists("9.olap&procedure/1.procedure/3.C++-procedure") and \ + os.path.exists("9.olap&procedure/1.procedure/4.Python-procedure.rst") and \ + os.path.exists("9.olap&procedure/1.procedure/index.rst") and \ + os.path.exists("9.olap&procedure/1.procedure/index.rst.aci"): + subprocess.run(shlex.split("rm -rf 3.C++-procedure 4.Python-procedure.rst index.rst"), cwd="9.olap&procedure/1.procedure/") + subprocess.run(shlex.split("mv index.rst.aci index.rst"), cwd="9.olap&procedure/1.procedure/") From 4fedc9867af9dbb5a854d30c767f8abf90bc72cd Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Wed, 20 Mar 2024 19:11:45 +0800 Subject: [PATCH 08/28] =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4=E3=80=82=E8=B0=83=E6=95=B44=EF=BC=8C5?= =?UTF-8?q?=E7=BA=A7=E7=9B=AE=E5=BD=95=E4=B8=BA2=EF=BC=8C3=E7=BA=A7?= =?UTF-8?q?=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1.privilege.md | 0 .../{10. permission => 10.permission}/2.token.md | 0 .../3.reset_admin_password.md | 0 .../4.monitoring.md | 0 .../{10. permission => 10.permission}/5.log.md | 0 .../{10. permission => 10.permission}/index.rst | 14 +++++++------- docs/zh-CN/source/5.installation&running/index.rst | 2 +- docs/zh-CN/source/6.utility-tools/index.rst | 2 +- .../source/9.olap&procedure/1.procedure/Doxyfile | 2 +- docs/zh-CN/source/9.olap&procedure/index.rst | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) rename docs/zh-CN/source/{10. permission => 10.permission}/1.privilege.md (100%) rename docs/zh-CN/source/{10. permission => 10.permission}/2.token.md (100%) rename docs/zh-CN/source/{10. permission => 10.permission}/3.reset_admin_password.md (100%) rename docs/zh-CN/source/{10. permission => 10.permission}/4.monitoring.md (100%) rename docs/zh-CN/source/{10. permission => 10.permission}/5.log.md (100%) rename docs/zh-CN/source/{10. permission => 10.permission}/index.rst (71%) diff --git a/docs/zh-CN/source/10. permission/1.privilege.md b/docs/zh-CN/source/10.permission/1.privilege.md similarity index 100% rename from docs/zh-CN/source/10. permission/1.privilege.md rename to docs/zh-CN/source/10.permission/1.privilege.md diff --git a/docs/zh-CN/source/10. permission/2.token.md b/docs/zh-CN/source/10.permission/2.token.md similarity index 100% rename from docs/zh-CN/source/10. permission/2.token.md rename to docs/zh-CN/source/10.permission/2.token.md diff --git a/docs/zh-CN/source/10. permission/3.reset_admin_password.md b/docs/zh-CN/source/10.permission/3.reset_admin_password.md similarity index 100% rename from docs/zh-CN/source/10. permission/3.reset_admin_password.md rename to docs/zh-CN/source/10.permission/3.reset_admin_password.md diff --git a/docs/zh-CN/source/10. permission/4.monitoring.md b/docs/zh-CN/source/10.permission/4.monitoring.md similarity index 100% rename from docs/zh-CN/source/10. permission/4.monitoring.md rename to docs/zh-CN/source/10.permission/4.monitoring.md diff --git a/docs/zh-CN/source/10. permission/5.log.md b/docs/zh-CN/source/10.permission/5.log.md similarity index 100% rename from docs/zh-CN/source/10. permission/5.log.md rename to docs/zh-CN/source/10.permission/5.log.md diff --git a/docs/zh-CN/source/10. permission/index.rst b/docs/zh-CN/source/10.permission/index.rst similarity index 71% rename from docs/zh-CN/source/10. permission/index.rst rename to docs/zh-CN/source/10.permission/index.rst index e23467ac4c..9282406541 100644 --- a/docs/zh-CN/source/10. permission/index.rst +++ b/docs/zh-CN/source/10.permission/index.rst @@ -1,8 +1,8 @@ -权限管理 -======== - -.. toctree:: - :maxdepth: 2 - :glob: - +运维与权限管理 +======== + +.. toctree:: + :maxdepth: 2 + :glob: + * \ No newline at end of file diff --git a/docs/zh-CN/source/5.installation&running/index.rst b/docs/zh-CN/source/5.installation&running/index.rst index 16187666e3..f9adc8f706 100644 --- a/docs/zh-CN/source/5.installation&running/index.rst +++ b/docs/zh-CN/source/5.installation&running/index.rst @@ -1,4 +1,4 @@ -安装 +安装和运行 ==== .. toctree:: diff --git a/docs/zh-CN/source/6.utility-tools/index.rst b/docs/zh-CN/source/6.utility-tools/index.rst index 3b01353109..2e0d2c811d 100644 --- a/docs/zh-CN/source/6.utility-tools/index.rst +++ b/docs/zh-CN/source/6.utility-tools/index.rst @@ -1,4 +1,4 @@ -服务端工具 +实用工具 ========== .. toctree:: diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile b/docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile index e5e5a28405..25263de7f1 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/Doxyfile @@ -771,7 +771,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../../../../../include/lgraph +INPUT = ../../../../../include/lgraph # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/zh-CN/source/9.olap&procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/index.rst index 7432d19b52..68c4ddf1ef 100644 --- a/docs/zh-CN/source/9.olap&procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/index.rst @@ -1,4 +1,4 @@ -编程接口 +存储过程和分析接口 ======== .. toctree:: From f4ed142d6dea1585b583ca1ac36b443dad3d4105 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 11:08:33 +0800 Subject: [PATCH 09/28] =?UTF-8?q?=E6=96=87=E6=A1=A3=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4=E3=80=82=E8=B0=83=E6=95=B44=EF=BC=8C5?= =?UTF-8?q?=E7=BA=A7=E7=9B=AE=E5=BD=95=E4=B8=BA2=EF=BC=8C3=E7=BA=A7?= =?UTF-8?q?=E7=9B=AE=E5=BD=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/1.guide.md | 2 +- .../2.introduction/3.what-is-tugraph.md | 87 +--- docs/zh-CN/source/2.introduction/4.schema.md | 85 ++++ .../1.performance-oriented.md | 0 .../2.multi-level-Interfaces.md | 0 .../3.htap.md | 0 .../index.rst | 10 +- .../{5.architecture.md => 6.architecture.md} | 0 ...{6.functionality.md => 7.functionality.md} | 0 .../{7.scenarios.md => 8.scenarios.md} | 0 .../{8.glossary.md => 9.glossary.md} | 0 docs/zh-CN/source/2.introduction/index.rst | 11 +- docs/zh-CN/source/8.query/2.gql.md | 403 ++++++++++++++++++ docs/zh-CN/source/8.query/2.gql/1.intro.md | 18 - .../source/8.query/2.gql/2.clauses/1.match.md | 100 ----- .../2.gql/2.clauses/2.optional_match.md | 30 -- .../8.query/2.gql/2.clauses/3.return.md | 110 ----- .../source/8.query/2.gql/2.clauses/4.next.md | 20 - .../source/8.query/2.gql/2.clauses/5.where.md | 49 --- .../8.query/2.gql/2.clauses/6.orderby.md | 19 - .../source/8.query/2.gql/2.clauses/7.skip.md | 30 -- .../source/8.query/2.gql/2.clauses/8.limit.md | 17 - .../source/8.query/2.gql/2.clauses/index.rst | 8 - docs/zh-CN/source/8.query/2.gql/index.rst | 9 - docs/zh-CN/source/8.query/index.rst | 6 +- 25 files changed, 504 insertions(+), 510 deletions(-) create mode 100644 docs/zh-CN/source/2.introduction/4.schema.md rename docs/zh-CN/source/2.introduction/{4.characteristics => 5.characteristics}/1.performance-oriented.md (100%) rename docs/zh-CN/source/2.introduction/{4.characteristics => 5.characteristics}/2.multi-level-Interfaces.md (100%) rename docs/zh-CN/source/2.introduction/{4.characteristics => 5.characteristics}/3.htap.md (100%) rename docs/zh-CN/source/2.introduction/{4.characteristics => 5.characteristics}/index.rst (95%) rename docs/zh-CN/source/2.introduction/{5.architecture.md => 6.architecture.md} (100%) rename docs/zh-CN/source/2.introduction/{6.functionality.md => 7.functionality.md} (100%) rename docs/zh-CN/source/2.introduction/{7.scenarios.md => 8.scenarios.md} (100%) rename docs/zh-CN/source/2.introduction/{8.glossary.md => 9.glossary.md} (100%) create mode 100644 docs/zh-CN/source/8.query/2.gql.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/1.intro.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md delete mode 100644 docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst delete mode 100644 docs/zh-CN/source/8.query/2.gql/index.rst diff --git a/docs/zh-CN/source/1.guide.md b/docs/zh-CN/source/1.guide.md index ab1b0d7b0c..ae7d32b372 100644 --- a/docs/zh-CN/source/1.guide.md +++ b/docs/zh-CN/source/1.guide.md @@ -4,7 +4,7 @@ ## 快速上手 -> 可以先了解[什么是图](./2.introduction/1.what-is-graph.md)、图[可以做什么](./2.introduction/7.scenarios.md)、以及[什么是TuGraph](./2.introduction/3.what-is-tugraph.md)。 +> 可以先了解[什么是图](./2.introduction/1.what-is-graph.md)、图[可以做什么](./2.introduction/8.scenarios.md)、以及[什么是TuGraph](./2.introduction/3.what-is-tugraph.md)。 > 基于[阿里云计算巢](5.installation&running/5.cloud-deployment.md)或[Docker方式](5.installation&running/3.docker-deployment.md)快速部署TuGraph。 diff --git a/docs/zh-CN/source/2.introduction/3.what-is-tugraph.md b/docs/zh-CN/source/2.introduction/3.what-is-tugraph.md index d241082fde..967549eb4d 100644 --- a/docs/zh-CN/source/2.introduction/3.what-is-tugraph.md +++ b/docs/zh-CN/source/2.introduction/3.what-is-tugraph.md @@ -38,92 +38,7 @@ TuGraph是支持大数据量、低延迟查找和快速图分析功能的高效 - 高性能批量导入 - 在线/离线的备份恢复 -## 4. 数据模型 - -### 4.1. 图模型 - -TuGraph是一个具备多图能力的强类型、有向属性图数据库。 - -- 图项目:每个数据库服务可以承载多个图项目(多图),每个图项目可以有自己的访问控制配置,数据库管理员可以创建或删除指定图项目。 -- 点:指实体,一般用于表达现实中的实体对象,如一部电影、一个演员。 - - 主键:用户自定义的点数据主键,默认唯一索引,在对应的点类型中唯一。 - - VID:点在存储层自动分配图项目中的唯一ID,用户不可修改。 - - 上限:每个图项目存储最多2^(40)个点数据。 -- 边:用于表达点与点之间的关系,如演员出演电影。 - - 有向边:边为有向边。若要模拟无向边,用户可以创建两个方向相反的边。 - - 多条边:两个点数据之间可以有多条边数据。当前TuGraph支持重复边,如要确保边边唯一,需要通过业务策略实现。 - - 上限:两个点数据之间存储最多2^(32)条边数据。 -- 属性图:点和边可以具有与其关联的属性,每个属性可以有不同的类型。 -- 强类型:每个点和边有且仅有一个标签,创建标签后,修改属性数量及类型有代价。 - - 指定边的起/终点类型:可限制边的起点和终点点类型,支持同类型边的起点和终点的点类型不同,如个人转账给公司、公司转账给公司;当指定边的起/终点类型后,可增加多组起/终点类型,不可删除已限制的起/终点类型。 - - 无限制模式:支持不指定边的起点和终点的点类型,任意两个点类型间均可创建该类型的边数据。注:当指定边的起/终点类型后无法再采用无限制模式。 - -### 4.2. 数据类型 - -TuGraph支持多种可用于属性的数据类型。具体支持的数据类型如下: - -| **数据类型** | **最小值** | **最大值** | **描述** | -| ------------ | ------------------- | ------------------- | ----------------------------------- | -| BOOL | false | true | 布尔值 | -| INT8 | -128 | 127 | 8位整型 | -| INT16 | -32768 | 32767 | 16位整型 | -| INT32 | - 2^31 | 2^31 - 1 | 32位整型 | -| INT64 | - 2^63 | 2^63 - 1 | 64位整型 | -| DATE | 0000-00-00 | 9999-12-31 | "YYYY-MM-DD" 格式的日期 | -| DATETIME | 0000-00-00 00:00:00.000000 | 9999-12-31 23:59:59.999999 | "YYYY-MM-DD HH:mm:ss[.ffffff]" 格式的日期时间 | -| FLOAT | | | 32位浮点数 | -| DOUBLE | | | 64位浮点数 | -| STRING | | | 不定长度的字符串 | -| BLOB | | | 二进制数据(在输入输出时使用Base64编码) | - -### 4.3. 索引 - -TuGraph支持对点或边的属性创建索引,以提升查询效率。 -- 索引可以是唯一或非唯一索引。 -- 如果为点标签创建了唯一索引,在修改该标签的点时,会先执行数据完整性检查,以确保该索引的唯一性。 -- 每个索引都基于一个点或边的一个属性创建,可以对同一点或边的多个属性创建索引。 -- BLOB类型的属性不能建立索引。 - -## 5. 图项目、点、边、属性命名规则和建议 - -### 5.1 命名规则 -图项目、点、边和属性是识别符。该节描述了在TuGraph中识别符的允许的语法。 -下面的表描述了每类识别符的最大长度和允许的字符。 - -|**识别符** |**长度** |**允许的字符**| -|--------- |--------- |--------- | -|用户、角色、图项目 |1-64字符 |允许中文、字母、数字、下划线,且首字符不为数字| -|点类型、边类型、属性 |1~256字符 |允许中文、字母、数字、下划线,且首字符不为数字| - -### 5.2 使用限制 - -|**描述**| **最大个数**| -|-------- |--------- | -|用户数、角色数 |65536| -|图项目的个数 |4096| -|每个图项目的点和边类型数量之和 |4096| -|每个点或边类型的属性数量 |1024| - -注: -1、特殊字符和关键字说明:使用特殊字符或非保留关键字时,需要使用反单引号/backquote(``)进行引用; - -示例: ```match (`match`:match) return `match`.id limit 1``` - -2、大小写敏感性:TuGraph大小写敏感; - -3、图项目、点/边、属性名称之间可以重复使用,同一点或边下的属性名称不可以重复; - -4、属性名字保留关键字:SRC_ID / DST_ID / SKIP - - -### 5.3 命名建议 -|**识别符**|**描述**|**建议**| -|-------|-------|--------| -|图项目 |字母或中文开头 |如graph123、project123等| -|点/边类型 |字母或中文开头,使用下划线区分单词 |如person、act_in等| -|属性 |字母或中文 |如name、age等| - -## 6. TuGraph企业版 +## 4. TuGraph企业版 企业版对商业化功能支持更加完善,包括分布式集群架构,覆盖探索、研发、服务、运维管理全生命周期的一站式图平台,在线、近线、离线的图计算引擎,支持流式、大数据类数据源,多地多中心的部署形态,以及专家支持服务等。企业版是商业化解决方案的理想选择。 diff --git a/docs/zh-CN/source/2.introduction/4.schema.md b/docs/zh-CN/source/2.introduction/4.schema.md new file mode 100644 index 0000000000..dd63e22d44 --- /dev/null +++ b/docs/zh-CN/source/2.introduction/4.schema.md @@ -0,0 +1,85 @@ +# TuGraph图模型说明 +## 1. 数据模型 + +### 1.1. 图模型 + +TuGraph是一个具备多图能力的强类型、有向属性图数据库。 + +- 图项目:每个数据库服务可以承载多个图项目(多图),每个图项目可以有自己的访问控制配置,数据库管理员可以创建或删除指定图项目。 +- 点:指实体,一般用于表达现实中的实体对象,如一部电影、一个演员。 + - 主键:用户自定义的点数据主键,默认唯一索引,在对应的点类型中唯一。 + - VID:点在存储层自动分配图项目中的唯一ID,用户不可修改。 + - 上限:每个图项目存储最多2^(40)个点数据。 +- 边:用于表达点与点之间的关系,如演员出演电影。 + - 有向边:边为有向边。若要模拟无向边,用户可以创建两个方向相反的边。 + - 多条边:两个点数据之间可以有多条边数据。当前TuGraph支持重复边,如要确保边边唯一,需要通过业务策略实现。 + - 上限:两个点数据之间存储最多2^(32)条边数据。 +- 属性图:点和边可以具有与其关联的属性,每个属性可以有不同的类型。 +- 强类型:每个点和边有且仅有一个标签,创建标签后,修改属性数量及类型有代价。 + - 指定边的起/终点类型:可限制边的起点和终点点类型,支持同类型边的起点和终点的点类型不同,如个人转账给公司、公司转账给公司;当指定边的起/终点类型后,可增加多组起/终点类型,不可删除已限制的起/终点类型。 + - 无限制模式:支持不指定边的起点和终点的点类型,任意两个点类型间均可创建该类型的边数据。注:当指定边的起/终点类型后无法再采用无限制模式。 + +### 1.2. 数据类型 + +TuGraph支持多种可用于属性的数据类型。具体支持的数据类型如下: + +| **数据类型** | **最小值** | **最大值** | **描述** | +| ------------ | ------------------- | ------------------- | ----------------------------------- | +| BOOL | false | true | 布尔值 | +| INT8 | -128 | 127 | 8位整型 | +| INT16 | -32768 | 32767 | 16位整型 | +| INT32 | - 2^31 | 2^31 - 1 | 32位整型 | +| INT64 | - 2^63 | 2^63 - 1 | 64位整型 | +| DATE | 0000-00-00 | 9999-12-31 | "YYYY-MM-DD" 格式的日期 | +| DATETIME | 0000-00-00 00:00:00.000000 | 9999-12-31 23:59:59.999999 | "YYYY-MM-DD HH:mm:ss[.ffffff]" 格式的日期时间 | +| FLOAT | | | 32位浮点数 | +| DOUBLE | | | 64位浮点数 | +| STRING | | | 不定长度的字符串 | +| BLOB | | | 二进制数据(在输入输出时使用Base64编码) | + +### 1.3. 索引 + +TuGraph支持对点或边的属性创建索引,以提升查询效率。 +- 索引可以是唯一或非唯一索引。 +- 如果为点标签创建了唯一索引,在修改该标签的点时,会先执行数据完整性检查,以确保该索引的唯一性。 +- 每个索引都基于一个点或边的一个属性创建,可以对同一点或边的多个属性创建索引。 +- BLOB类型的属性不能建立索引。 + +## 2. 图项目、点、边、属性命名规则和建议 + +### 2.1 命名规则 +图项目、点、边和属性是识别符。该节描述了在TuGraph中识别符的允许的语法。 +下面的表描述了每类识别符的最大长度和允许的字符。 + +|**识别符** |**长度** |**允许的字符**| +|--------- |--------- |--------- | +|用户、角色、图项目 |1-64字符 |允许中文、字母、数字、下划线,且首字符不为数字| +|点类型、边类型、属性 |1~256字符 |允许中文、字母、数字、下划线,且首字符不为数字| + +### 2.2 使用限制 + +|**描述**| **最大个数**| +|-------- |--------- | +|用户数、角色数 |65536| +|图项目的个数 |4096| +|每个图项目的点和边类型数量之和 |4096| +|每个点或边类型的属性数量 |1024| + +注: +1、特殊字符和关键字说明:使用特殊字符或非保留关键字时,需要使用反单引号/backquote(``)进行引用; + +示例: ```match (`match`:match) return `match`.id limit 1``` + +2、大小写敏感性:TuGraph大小写敏感; + +3、图项目、点/边、属性名称之间可以重复使用,同一点或边下的属性名称不可以重复; + +4、属性名字保留关键字:SRC_ID / DST_ID / SKIP + + +### 2.3 命名建议 +|**识别符**|**描述**|**建议**| +|-------|-------|--------| +|图项目 |字母或中文开头 |如graph123、project123等| +|点/边类型 |字母或中文开头,使用下划线区分单词 |如person、act_in等| +|属性 |字母或中文 |如name、age等| \ No newline at end of file diff --git a/docs/zh-CN/source/2.introduction/4.characteristics/1.performance-oriented.md b/docs/zh-CN/source/2.introduction/5.characteristics/1.performance-oriented.md similarity index 100% rename from docs/zh-CN/source/2.introduction/4.characteristics/1.performance-oriented.md rename to docs/zh-CN/source/2.introduction/5.characteristics/1.performance-oriented.md diff --git a/docs/zh-CN/source/2.introduction/4.characteristics/2.multi-level-Interfaces.md b/docs/zh-CN/source/2.introduction/5.characteristics/2.multi-level-Interfaces.md similarity index 100% rename from docs/zh-CN/source/2.introduction/4.characteristics/2.multi-level-Interfaces.md rename to docs/zh-CN/source/2.introduction/5.characteristics/2.multi-level-Interfaces.md diff --git a/docs/zh-CN/source/2.introduction/4.characteristics/3.htap.md b/docs/zh-CN/source/2.introduction/5.characteristics/3.htap.md similarity index 100% rename from docs/zh-CN/source/2.introduction/4.characteristics/3.htap.md rename to docs/zh-CN/source/2.introduction/5.characteristics/3.htap.md diff --git a/docs/zh-CN/source/2.introduction/4.characteristics/index.rst b/docs/zh-CN/source/2.introduction/5.characteristics/index.rst similarity index 95% rename from docs/zh-CN/source/2.introduction/4.characteristics/index.rst rename to docs/zh-CN/source/2.introduction/5.characteristics/index.rst index 853243ed8c..c055f3df01 100644 --- a/docs/zh-CN/source/2.introduction/4.characteristics/index.rst +++ b/docs/zh-CN/source/2.introduction/5.characteristics/index.rst @@ -2,9 +2,9 @@ ======== .. toctree:: - :maxdepth: 2 - :caption: Contents: - :glob: - - * + :maxdepth: 2 + :caption: Contents: + :glob: + + * \ No newline at end of file diff --git a/docs/zh-CN/source/2.introduction/5.architecture.md b/docs/zh-CN/source/2.introduction/6.architecture.md similarity index 100% rename from docs/zh-CN/source/2.introduction/5.architecture.md rename to docs/zh-CN/source/2.introduction/6.architecture.md diff --git a/docs/zh-CN/source/2.introduction/6.functionality.md b/docs/zh-CN/source/2.introduction/7.functionality.md similarity index 100% rename from docs/zh-CN/source/2.introduction/6.functionality.md rename to docs/zh-CN/source/2.introduction/7.functionality.md diff --git a/docs/zh-CN/source/2.introduction/7.scenarios.md b/docs/zh-CN/source/2.introduction/8.scenarios.md similarity index 100% rename from docs/zh-CN/source/2.introduction/7.scenarios.md rename to docs/zh-CN/source/2.introduction/8.scenarios.md diff --git a/docs/zh-CN/source/2.introduction/8.glossary.md b/docs/zh-CN/source/2.introduction/9.glossary.md similarity index 100% rename from docs/zh-CN/source/2.introduction/8.glossary.md rename to docs/zh-CN/source/2.introduction/9.glossary.md diff --git a/docs/zh-CN/source/2.introduction/index.rst b/docs/zh-CN/source/2.introduction/index.rst index 3346808f92..efe03a5128 100644 --- a/docs/zh-CN/source/2.introduction/index.rst +++ b/docs/zh-CN/source/2.introduction/index.rst @@ -9,8 +9,9 @@ TuGraph入门 1.what-is-graph 2.what-is-gdbms 3.what-is-tugraph - 4.characteristics/index.rst - 5.architecture - 6.functionality - 7.scenarios - 8.glossary + 4.schema + 5.characteristics/index.rst + 6.architecture + 7.functionality + 8.scenarios + 9.glossary diff --git a/docs/zh-CN/source/8.query/2.gql.md b/docs/zh-CN/source/8.query/2.gql.md new file mode 100644 index 0000000000..6200506f06 --- /dev/null +++ b/docs/zh-CN/source/8.query/2.gql.md @@ -0,0 +1,403 @@ +# ISO GQL + +## GQL简介和子句列表 +Graph Query Language(GQL, 图查询语言)是一种国际标准语言,用于属性图查询,该语言建立在SQL的基础上,并整合了现有的[openCypher、PGQL、GSQL和G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/)语言的成熟思想。目前该标准仍然处于草稿阶段。 + +TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/TuGraph-family/gql-grammar)实现了GQL,并做了一些扩展与改造。目前并未完全支持所有的GQL语法,我们会在未来逐步完善。 + +ISO GQL子句列表: + +| 类别 | 子句 | +| ------------------- | -------------- | +| Reading clauses | MATCH | +| | OPTIONAL MATCH | +| Projecting clauses | RETURN | +| | NEXT | +| Reading sub-clauses | WHERE | +| | ORDER BY | +| | SKIP | +| | LIMIT | + +## MATCH + +`MATCH`子句式是GQL最基础的子句,几乎所有查询都是通过 `MATCH`展开。 + +`MATCH`子句用于指定在图中搜索的匹配模式,用来匹配满足一定条件的点或者路径。 + +### 基本用法 + +#### 点查询 + +##### 查询所有点 + +``` +MATCH (n) +RETURN n +``` + +##### 查询特定标签的点 + +``` +MATCH (n:Person) +RETURN n +``` + +##### 通过属性匹配点 + +``` +MATCH (n:Person{name:'Michael Redgrave'}) +RETURN n.birthyear +``` + +返回结果 +```JSON +[{"n.birthyear":1908}] +``` + +##### 通过过滤条件匹配点 + + +``` +MATCH (n:Person WHERE n.birthyear > 1910) +RETURN n.name LIMIT 2 +``` + +返回结果 +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` + +#### 边查询 + +##### 出边匹配 + +``` +MATCH (n:Person WHERE n.birthyear = 1970)-[e]->(m) +RETURN n.name, label(e), m.name +``` + +返回结果 +```JSON +[{"label(e)":"BORN_IN","m.name":"London","n.name":"Christopher Nolan"},{"label(e)":"DIRECTED","m.name":null,"n.name":"Christopher Nolan"}] +``` + +##### 入边匹配 + +``` +MATCH (n:Person WHERE n.birthyear = 1939)<-[e]-(m) +RETURN n.name, label(e), m.name +``` + +返回结果 +```JSON +[{"label(e)":"HAS_CHILD","m.name":"Rachel Kempson","n.name":"Corin Redgrave"},{"label(e)":"HAS_CHILD","m.name":"Michael Redgrave","n.name":"Corin Redgrave"}] +``` + +##### 带过滤条件的边匹配 + +``` +MATCH (n:Person)-[e:BORN_IN WHERE e.weight > 20]->(m) +RETURN n.name, e.weight, m.name +``` + +返回结果 +```JSON +[{"e.weight":20.549999237060547,"m.name":"New York","n.name":"John Williams"},{"e.weight":20.6200008392334,"m.name":"New York","n.name":"Lindsay Lohan"}] +``` + +#### 路径匹配 + +##### 不定跳查询 + +``` +MATCH (n:Person)-[e]->{2,3}(m:Person) +RETURN m.name LIMIT 2 +``` + +返回结果 +```JSON +[{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] +``` + +## OPTIONAL MATCH + +`OPTIONAL MATCH`匹配图模式,如果未命中,则返回`null`。 + +### 基本用法 + +#### 查询命中 + +``` +OPTIONAL MATCH (n:Person{name:'Michael Redgrave'}) +RETURN n.birthyear +``` + +返回结果 +```JSON +[{"n.birthyear":1908}] +``` + +#### 查询未命中 + +``` +OPTIONAL MATCH (n:Person{name:'Redgrave Michael'}) +RETURN n.birthyear +``` + +返回结果 + +```JSON +[{"n.birthyear":null}] +``` + +## RETURN + +`RETURN`子句指定返回结果,包括返回点、边、路径、属性等。 + +### 基本用法 + +#### 返回点 + +``` +MATCH (n) +RETURN n LIMIT 2 +``` + +返回结果 +```JSON +[{"n":{"identity":0,"label":"Person","properties":{"birthyear":1910,"name":"Rachel Kempson"}}},{"n":{"identity":1,"label":"Person","properties":{"birthyear":1908,"name":"Michael Redgrave"}}}] +``` + +#### 返回边 + +``` +MATCH (n)-[e]->(m) +RETURN e LIMIT 2 +``` + +返回结果 + +```JSON +[{"e":{"dst":2,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}},{"e":{"dst":3,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}}] +``` + +#### 返回属性 + +``` +MATCH (n:Person) +RETURN n.name LIMIT 2 +``` + +返回结果 + +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` + +#### 不常见字符串作为变量名 + +``` +MATCH (`/uncommon variable`:Person) +RETURN `/uncommon variable`.name LIMIT 3 +``` + +返回结果 + +```JSON +[{"`/uncommon variable`.name":"Christopher Nolan"},{"`/uncommon variable`.name":"Corin Redgrave"},{"`/uncommon variable`.name":"Dennis Quaid"}] +``` + +#### 列别名 + +``` +MATCH (n:Person) +RETURN n.name AS nname LIMIT 2 +``` + +返回结果 + +```JSON +[{"nname":"Christopher Nolan"},{"nname":"Corin Redgrave"}] +``` + +#### 可选属性 + +``` +MATCH (n:Person) +RETURN n.age LIMIT 2 +``` + +返回结果 + +```JSON +[{"n.age":null},{"n.age":null}] +``` + +#### 其它表达式 + +``` +MATCH (n:Person) +RETURN n.birthyear > 1970, "I'm a literal", 1 + 2, abs(-2) +LIMIT 2 +``` + +返回结果 + +```JSON +[{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false},{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false}] +``` + +#### 结果唯一性 + + +``` +MATCH (n) +RETURN DISTINCT label(n) AS label +``` + +返回结果 + +```JSON +[{"label":"Person"},{"label":"City"},{"label":"Film"}] +``` + +## NEXT + +`NEXT`子句用于连接多个子句。 + +### 基本用法 + +#### 连接MATCH + +``` +MATCH (n:Person) WHERE n.birthyear = 1970 +RETURN n +NEXT +MATCH (m:Person) WHERE m.birthyear < 1968 +RETURN n.name, n.birthyear, m.name LIMIT 2 +``` + +返回结果 +```JSON +[{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] +``` + +## WHERE + +`WHERE`子句用于过滤记录。 + +### 基本用法 + +#### 过滤点 + +``` +MATCH (n:Person WHERE n.birthyear > 1965) +RETURN n.name +``` + +返回结果 + +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Lindsay Lohan"}] +``` + +#### 过滤边 + +``` +MATCH (n:Person WHERE n.birthyear > 1965)-[e:ACTED_IN]->(m:Film) +WHERE e.charactername = 'Halle/Annie' +RETURN m.title +``` + +返回结果 + +```JSON +[{"m.title":"The Parent Trap"}] +``` + +#### 布尔表达式 + +`AND`, `OR`, `XOR`和 `NOT`布尔表达式可以用在 `WHERE`中用来过滤数据。 + +``` +MATCH (n:Person) +WHERE + n.birthyear > 1930 AND (n.birthyear < 1950 OR n.name = 'Corin Redgrave') +RETURN n LIMIT 2 +``` + +返回结果 + +```JSON +[{"n":{"identity":3,"label":"Person","properties":{"birthyear":1939,"name":"Corin Redgrave"}}},{"n":{"identity":11,"label":"Person","properties":{"birthyear":1932,"name":"John Williams"}}}] +``` + + +## ORDER BY + +`ORDER BY`是`RETURN`的子句,对输出的结果进行排序。 + +### 基本用法 + +#### 对结果排序 + +``` +MATCH (n:Person WHERE n.birthyear < 1970) +RETURN n.birthyear AS q +ORDER BY q ASC +LIMIT 5 +``` + +返回结果 +```JSON +[{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] +``` + +## SKIP + +`SKIP`指定结果偏移行数。 + +### 基本用法 + +#### 未使用SKIP + +``` +MATCH (n:Person) +RETURN n.name LIMIT 3 +``` + +返回结果 + +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] +``` + +#### 使用SKIP + +``` +MATCH (n:Person) +RETURN n.name SKIP 1 LIMIT 2 +``` + +返回结果 +```JSON +[{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] +``` + +## LIMIT + +`LIMIT`限制结果行数。 + +### 基本用法 + +#### 使用LIMIT + +``` +MATCH (n:Person) +RETURN n.name LIMIT 2; +``` + +返回结果 +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` \ No newline at end of file diff --git a/docs/zh-CN/source/8.query/2.gql/1.intro.md b/docs/zh-CN/source/8.query/2.gql/1.intro.md deleted file mode 100644 index 6e4cc06827..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/1.intro.md +++ /dev/null @@ -1,18 +0,0 @@ -# ISO GQL 简介 - -Graph Query Language(GQL, 图查询语言)是一种国际标准语言,用于属性图查询,该语言建立在SQL的基础上,并整合了现有的[openCypher、PGQL、GSQL和G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/)语言的成熟思想。目前该标准仍然处于草稿阶段。 - -TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/TuGraph-family/gql-grammar)实现了GQL,并做了一些扩展与改造。目前并未完全支持所有的GQL语法,我们会在未来逐步完善。 - -## 子句列表 - -| 类别 | 子句 | -| ------------------- | -------------- | -| Reading clauses | MATCH | -| | OPTIONAL MATCH | -| Projecting clauses | RETURN | -| | NEXT | -| Reading sub-clauses | WHERE | -| | ORDER BY | -| | SKIP | -| | LIMIT | diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md deleted file mode 100644 index 3798f5661d..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/1.match.md +++ /dev/null @@ -1,100 +0,0 @@ -# MATCH - -`MATCH`子句式是GQL最基础的子句,几乎所有查询都是通过 `MATCH`展开。 - -`MATCH`子句用于指定在图中搜索的匹配模式,用来匹配满足一定条件的点或者路径。 - -## 基本用法 - -### 点查询 - -#### 查询所有点 - -``` -MATCH (n) -RETURN n -``` - -#### 查询特定标签的点 - -``` -MATCH (n:Person) -RETURN n -``` - -#### 通过属性匹配点 - -``` -MATCH (n:Person{name:'Michael Redgrave'}) -RETURN n.birthyear -``` - -返回结果 -```JSON -[{"n.birthyear":1908}] -``` - -#### 通过过滤条件匹配点 - - -``` -MATCH (n:Person WHERE n.birthyear > 1910) -RETURN n.name LIMIT 2 -``` - -返回结果 -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` - -### 边查询 - -#### 出边匹配 - -``` -MATCH (n:Person WHERE n.birthyear = 1970)-[e]->(m) -RETURN n.name, label(e), m.name -``` - -返回结果 -```JSON -[{"label(e)":"BORN_IN","m.name":"London","n.name":"Christopher Nolan"},{"label(e)":"DIRECTED","m.name":null,"n.name":"Christopher Nolan"}] -``` - -#### 入边匹配 - -``` -MATCH (n:Person WHERE n.birthyear = 1939)<-[e]-(m) -RETURN n.name, label(e), m.name -``` - -返回结果 -```JSON -[{"label(e)":"HAS_CHILD","m.name":"Rachel Kempson","n.name":"Corin Redgrave"},{"label(e)":"HAS_CHILD","m.name":"Michael Redgrave","n.name":"Corin Redgrave"}] -``` - -#### 带过滤条件的边匹配 - -``` -MATCH (n:Person)-[e:BORN_IN WHERE e.weight > 20]->(m) -RETURN n.name, e.weight, m.name -``` - -返回结果 -```JSON -[{"e.weight":20.549999237060547,"m.name":"New York","n.name":"John Williams"},{"e.weight":20.6200008392334,"m.name":"New York","n.name":"Lindsay Lohan"}] -``` - -### 路径匹配 - -#### 不定跳查询 - -``` -MATCH (n:Person)-[e]->{2,3}(m:Person) -RETURN m.name LIMIT 2 -``` - -返回结果 -```JSON -[{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md deleted file mode 100644 index 246e87fda9..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/2.optional_match.md +++ /dev/null @@ -1,30 +0,0 @@ -# OPTIONAL MATCH - -`OPTIONAL MATCH`匹配图模式,如果未命中,则返回`null`。 - -## 基本用法 - -### 查询命中 - -``` -OPTIONAL MATCH (n:Person{name:'Michael Redgrave'}) -RETURN n.birthyear -``` - -返回结果 -```JSON -[{"n.birthyear":1908}] -``` - -### 查询未命中 - -``` -OPTIONAL MATCH (n:Person{name:'Redgrave Michael'}) -RETURN n.birthyear -``` - -返回结果 - -```JSON -[{"n.birthyear":null}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md deleted file mode 100644 index 3775b5e2fb..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/3.return.md +++ /dev/null @@ -1,110 +0,0 @@ -# RETURN - -`RETURN`子句指定返回结果,包括返回点、边、路径、属性等。 - -## 基本用法 - -### 返回点 - -``` -MATCH (n) -RETURN n LIMIT 2 -``` - -返回结果 -```JSON -[{"n":{"identity":0,"label":"Person","properties":{"birthyear":1910,"name":"Rachel Kempson"}}},{"n":{"identity":1,"label":"Person","properties":{"birthyear":1908,"name":"Michael Redgrave"}}}] -``` - -### 返回边 - -``` -MATCH (n)-[e]->(m) -RETURN e LIMIT 2 -``` - -返回结果 - -```JSON -[{"e":{"dst":2,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}},{"e":{"dst":3,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}}] -``` - -### 返回属性 - -``` -MATCH (n:Person) -RETURN n.name LIMIT 2 -``` - -返回结果 - -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` - -### 不常见字符串作为变量名 - -``` -MATCH (`/uncommon variable`:Person) -RETURN `/uncommon variable`.name LIMIT 3 -``` - -返回结果 - -```JSON -[{"`/uncommon variable`.name":"Christopher Nolan"},{"`/uncommon variable`.name":"Corin Redgrave"},{"`/uncommon variable`.name":"Dennis Quaid"}] -``` - -### 列别名 - -``` -MATCH (n:Person) -RETURN n.name AS nname LIMIT 2 -``` - -返回结果 - -```JSON -[{"nname":"Christopher Nolan"},{"nname":"Corin Redgrave"}] -``` - -### 可选属性 - -``` -MATCH (n:Person) -RETURN n.age LIMIT 2 -``` - -返回结果 - -```JSON -[{"n.age":null},{"n.age":null}] -``` - -### 其它表达式 - -``` -MATCH (n:Person) -RETURN n.birthyear > 1970, "I'm a literal", 1 + 2, abs(-2) -LIMIT 2 -``` - -返回结果 - -```JSON -[{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false},{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false}] -``` - -### 结果唯一性 - - -``` -MATCH (n) -RETURN DISTINCT label(n) AS label -``` - -返回结果 - -```JSON -[{"label":"Person"},{"label":"City"},{"label":"Film"}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md deleted file mode 100644 index 87612e184f..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/4.next.md +++ /dev/null @@ -1,20 +0,0 @@ -# NEXT - -`NEXT`子句用于连接多个子句。 - -## 基本用法 - -### 连接MATCH - -``` -MATCH (n:Person) WHERE n.birthyear = 1970 -RETURN n -NEXT -MATCH (m:Person) WHERE m.birthyear < 1968 -RETURN n.name, n.birthyear, m.name LIMIT 2 -``` - -返回结果 -```JSON -[{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md deleted file mode 100644 index 44817da5dd..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/5.where.md +++ /dev/null @@ -1,49 +0,0 @@ -# WHERE - -`WHERE`子句用于过滤记录。 - -## 基本用法 - -### 过滤点 - -``` -MATCH (n:Person WHERE n.birthyear > 1965) -RETURN n.name -``` - -返回结果 - -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Lindsay Lohan"}] -``` - -### 过滤边 - -``` -MATCH (n:Person WHERE n.birthyear > 1965)-[e:ACTED_IN]->(m:Film) -WHERE e.charactername = 'Halle/Annie' -RETURN m.title -``` - -返回结果 - -```JSON -[{"m.title":"The Parent Trap"}] -``` - -### 布尔表达式 - -`AND`, `OR`, `XOR`和 `NOT`布尔表达式可以用在 `WHERE`中用来过滤数据。 - -``` -MATCH (n:Person) -WHERE - n.birthyear > 1930 AND (n.birthyear < 1950 OR n.name = 'Corin Redgrave') -RETURN n LIMIT 2 -``` - -返回结果 - -```JSON -[{"n":{"identity":3,"label":"Person","properties":{"birthyear":1939,"name":"Corin Redgrave"}}},{"n":{"identity":11,"label":"Person","properties":{"birthyear":1932,"name":"John Williams"}}}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md deleted file mode 100644 index 56d0566a67..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/6.orderby.md +++ /dev/null @@ -1,19 +0,0 @@ -# ORDER BY - -`ORDER BY`是`RETURN`的子句,对输出的结果进行排序。 - -## 基本用法 - -### 对结果排序 - -``` -MATCH (n:Person WHERE n.birthyear < 1970) -RETURN n.birthyear AS q -ORDER BY q ASC -LIMIT 5 -``` - -返回结果 -```JSON -[{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md deleted file mode 100644 index 398429d355..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/7.skip.md +++ /dev/null @@ -1,30 +0,0 @@ -# SKIP - -`SKIP`指定结果偏移行数。 - -## 基本用法 - -### 未使用SKIP - -``` -MATCH (n:Person) -RETURN n.name LIMIT 3 -``` - -返回结果 - -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] -``` - -### 使用SKIP - -``` -MATCH (n:Person) -RETURN n.name SKIP 1 LIMIT 2 -``` - -返回结果 -```JSON -[{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md b/docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md deleted file mode 100644 index f47733baaa..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/8.limit.md +++ /dev/null @@ -1,17 +0,0 @@ -# LIMIT - -`LIMIT`限制结果行数。 - -## 基本用法 - -### 使用LIMIT - -``` -MATCH (n:Person) -RETURN n.name LIMIT 2; -``` - -返回结果 -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` diff --git a/docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst b/docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst deleted file mode 100644 index 770aa58ee2..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/2.clauses/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -GQL子句 -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/docs/zh-CN/source/8.query/2.gql/index.rst b/docs/zh-CN/source/8.query/2.gql/index.rst deleted file mode 100644 index e39c0a8e24..0000000000 --- a/docs/zh-CN/source/8.query/2.gql/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -GQL -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.intro.md - 2.clauses/index.rst diff --git a/docs/zh-CN/source/8.query/index.rst b/docs/zh-CN/source/8.query/index.rst index 027d7cc49a..0571c71701 100644 --- a/docs/zh-CN/source/8.query/index.rst +++ b/docs/zh-CN/source/8.query/index.rst @@ -1,9 +1,9 @@ 查询语言 -======== +=============== .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: - 1.cypher.md - 2.gql/index.rst + * From c1b946473e701e1d4467c244759d37becbad937d Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 11:26:55 +0800 Subject: [PATCH 10/28] =?UTF-8?q?=E8=B0=83=E6=95=B4Gql=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E7=BB=93=E6=9E=84=E4=B8=8Ecypher=E4=BF=9D=E6=8C=81=E4=B8=80?= =?UTF-8?q?=E8=87=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/8.query/2.gql.md | 36 +++++++++--------------------- 1 file changed, 10 insertions(+), 26 deletions(-) diff --git a/docs/zh-CN/source/8.query/2.gql.md b/docs/zh-CN/source/8.query/2.gql.md index 6200506f06..8f51d11bcf 100644 --- a/docs/zh-CN/source/8.query/2.gql.md +++ b/docs/zh-CN/source/8.query/2.gql.md @@ -1,11 +1,11 @@ # ISO GQL -## GQL简介和子句列表 +## 1.GQL简介 Graph Query Language(GQL, 图查询语言)是一种国际标准语言,用于属性图查询,该语言建立在SQL的基础上,并整合了现有的[openCypher、PGQL、GSQL和G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/)语言的成熟思想。目前该标准仍然处于草稿阶段。 TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/TuGraph-family/gql-grammar)实现了GQL,并做了一些扩展与改造。目前并未完全支持所有的GQL语法,我们会在未来逐步完善。 -ISO GQL子句列表: +## 2.Clauses | 类别 | 子句 | | ------------------- | -------------- | @@ -18,14 +18,12 @@ ISO GQL子句列表: | | SKIP | | | LIMIT | -## MATCH +### 2.1.MATCH `MATCH`子句式是GQL最基础的子句,几乎所有查询都是通过 `MATCH`展开。 `MATCH`子句用于指定在图中搜索的匹配模式,用来匹配满足一定条件的点或者路径。 -### 基本用法 - #### 点查询 ##### 查询所有点 @@ -119,12 +117,10 @@ RETURN m.name LIMIT 2 [{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] ``` -## OPTIONAL MATCH +### 2.2.OPTIONAL MATCH `OPTIONAL MATCH`匹配图模式,如果未命中,则返回`null`。 -### 基本用法 - #### 查询命中 ``` @@ -150,12 +146,10 @@ RETURN n.birthyear [{"n.birthyear":null}] ``` -## RETURN +### 2.3.RETURN `RETURN`子句指定返回结果,包括返回点、边、路径、属性等。 -### 基本用法 - #### 返回点 ``` @@ -261,12 +255,10 @@ RETURN DISTINCT label(n) AS label [{"label":"Person"},{"label":"City"},{"label":"Film"}] ``` -## NEXT +### 2.4.NEXT `NEXT`子句用于连接多个子句。 -### 基本用法 - #### 连接MATCH ``` @@ -282,12 +274,10 @@ RETURN n.name, n.birthyear, m.name LIMIT 2 [{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] ``` -## WHERE +### 2.5.WHERE `WHERE`子句用于过滤记录。 -### 基本用法 - #### 过滤点 ``` @@ -333,12 +323,10 @@ RETURN n LIMIT 2 ``` -## ORDER BY +### 2.6.ORDER BY `ORDER BY`是`RETURN`的子句,对输出的结果进行排序。 -### 基本用法 - #### 对结果排序 ``` @@ -353,12 +341,10 @@ LIMIT 5 [{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] ``` -## SKIP +### 2.7.SKIP `SKIP`指定结果偏移行数。 -### 基本用法 - #### 未使用SKIP ``` @@ -384,12 +370,10 @@ RETURN n.name SKIP 1 LIMIT 2 [{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] ``` -## LIMIT +### 2.8.LIMIT `LIMIT`限制结果行数。 -### 基本用法 - #### 使用LIMIT ``` From 770a6346b57610c29dbdd13e59344df47e4e3c9c Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 14:18:39 +0800 Subject: [PATCH 11/28] =?UTF-8?q?=E5=A2=9E=E5=8A=A0GQL=E6=9F=A5=E8=AF=A2?= =?UTF-8?q?=E9=A1=B5=E9=9D=A2=E7=9B=AE=E5=BD=95=EF=BC=8C=E5=B0=9D=E8=AF=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4C++API=E7=9B=AE=E5=BD=95=E7=AD=89=E7=BA=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/8.query/2.gql.md | 28 ++++++--- .../3.C++-procedure/1.base64_encode.rst | 56 +++++++++++++++++- .../1.procedure/6.base64_encode.rst | 59 +++++++++++++++++++ .../9.olap&procedure/1.procedure/cpp.md | 59 +++++++++++++++++++ 4 files changed, 193 insertions(+), 9 deletions(-) create mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst create mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md diff --git a/docs/zh-CN/source/8.query/2.gql.md b/docs/zh-CN/source/8.query/2.gql.md index 8f51d11bcf..01c6c60753 100644 --- a/docs/zh-CN/source/8.query/2.gql.md +++ b/docs/zh-CN/source/8.query/2.gql.md @@ -1,5 +1,6 @@ # ISO GQL + ## 1.GQL简介 Graph Query Language(GQL, 图查询语言)是一种国际标准语言,用于属性图查询,该语言建立在SQL的基础上,并整合了现有的[openCypher、PGQL、GSQL和G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/)语言的成熟思想。目前该标准仍然处于草稿阶段。 @@ -7,6 +8,17 @@ TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/Tu ## 2.Clauses +contents: +- [MATCH](#heading-1) +- [OPTIONAL MATCH](#heading-2) +- [RETURN](#heading-3) +- [NEXT](#heading-4) +- [WHERE](#heading-5) +- [ORDER BY](#heading-6) +- [SKIP](#heading-7) +- [LIMIT](#heading-8) + + | 类别 | 子句 | | ------------------- | -------------- | | Reading clauses | MATCH | @@ -18,7 +30,7 @@ TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/Tu | | SKIP | | | LIMIT | -### 2.1.MATCH +### 2.1.MATCH `MATCH`子句式是GQL最基础的子句,几乎所有查询都是通过 `MATCH`展开。 @@ -117,7 +129,7 @@ RETURN m.name LIMIT 2 [{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] ``` -### 2.2.OPTIONAL MATCH +### 2.2.OPTIONAL MATCH `OPTIONAL MATCH`匹配图模式,如果未命中,则返回`null`。 @@ -146,7 +158,7 @@ RETURN n.birthyear [{"n.birthyear":null}] ``` -### 2.3.RETURN +### 2.3.RETURN `RETURN`子句指定返回结果,包括返回点、边、路径、属性等。 @@ -255,7 +267,7 @@ RETURN DISTINCT label(n) AS label [{"label":"Person"},{"label":"City"},{"label":"Film"}] ``` -### 2.4.NEXT +### 2.4.NEXT `NEXT`子句用于连接多个子句。 @@ -274,7 +286,7 @@ RETURN n.name, n.birthyear, m.name LIMIT 2 [{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] ``` -### 2.5.WHERE +### 2.5.WHERE `WHERE`子句用于过滤记录。 @@ -323,7 +335,7 @@ RETURN n LIMIT 2 ``` -### 2.6.ORDER BY +### 2.6.ORDER BY `ORDER BY`是`RETURN`的子句,对输出的结果进行排序。 @@ -341,7 +353,7 @@ LIMIT 5 [{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] ``` -### 2.7.SKIP +### 2.7.SKIP `SKIP`指定结果偏移行数。 @@ -370,7 +382,7 @@ RETURN n.name SKIP 1 LIMIT 2 [{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] ``` -### 2.8.LIMIT +### 2.8.LIMIT `LIMIT`限制结果行数。 diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst index abc5ce2ccd..bf7f823bfc 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst @@ -2,4 +2,58 @@ base64_encode =================================== .. doxygenfile:: base64_encode.h - :project: cpp_procedure \ No newline at end of file + :project: cpp_procedure + +lgraph +=================================== + +.. doxygenfile:: lgraph.h + :project: cpp_procedure + +lgraph_atomic +=================================== + +.. doxygenfile:: lgraph_atomic.h + :project: cpp_procedure + +lgraph_date_time +=================================== + +.. doxygenfile:: lgraph_date_time.h + :project: cpp_procedure + +lgraph_db +=================================== + +.. doxygenfile:: lgraph_db.h + :project: cpp_procedure + +lgraph_edge_index_iterator +=================================== + +.. doxygenfile:: lgraph_edge_index_iterator.h + :project: cpp_procedure + +lgraph_edge_iterator +=================================== + +.. doxygenfile:: lgraph_edge_iterator.h + :project: cpp_procedure + +lgraph_exceptions +=================================== + +.. doxygenfile:: lgraph_exceptions.h + :project: cpp_procedure + +lgraph_galaxy +=================================== + +.. doxygenfile:: lgraph_galaxy.h + :project: cpp_procedure + +lgraph_result +=================================== + +.. doxygenfile:: lgraph_result.h + :project: cpp_procedure diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst new file mode 100644 index 0000000000..bf7f823bfc --- /dev/null +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst @@ -0,0 +1,59 @@ +base64_encode +=================================== + +.. doxygenfile:: base64_encode.h + :project: cpp_procedure + +lgraph +=================================== + +.. doxygenfile:: lgraph.h + :project: cpp_procedure + +lgraph_atomic +=================================== + +.. doxygenfile:: lgraph_atomic.h + :project: cpp_procedure + +lgraph_date_time +=================================== + +.. doxygenfile:: lgraph_date_time.h + :project: cpp_procedure + +lgraph_db +=================================== + +.. doxygenfile:: lgraph_db.h + :project: cpp_procedure + +lgraph_edge_index_iterator +=================================== + +.. doxygenfile:: lgraph_edge_index_iterator.h + :project: cpp_procedure + +lgraph_edge_iterator +=================================== + +.. doxygenfile:: lgraph_edge_iterator.h + :project: cpp_procedure + +lgraph_exceptions +=================================== + +.. doxygenfile:: lgraph_exceptions.h + :project: cpp_procedure + +lgraph_galaxy +=================================== + +.. doxygenfile:: lgraph_galaxy.h + :project: cpp_procedure + +lgraph_result +=================================== + +.. doxygenfile:: lgraph_result.h + :project: cpp_procedure diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md new file mode 100644 index 0000000000..c76f89d91f --- /dev/null +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md @@ -0,0 +1,59 @@ +# base64_encode +=================================== + +.. doxygenfile:: base64_encode.h +:project: cpp_procedure + +# lgraph +=================================== + +.. doxygenfile:: lgraph.h +:project: cpp_procedure + +# lgraph_atomic +=================================== + +.. doxygenfile:: lgraph_atomic.h +:project: cpp_procedure + +# lgraph_date_time +=================================== + +.. doxygenfile:: lgraph_date_time.h +:project: cpp_procedure + +# lgraph_db +=================================== + +.. doxygenfile:: lgraph_db.h +:project: cpp_procedure + +# lgraph_edge_index_iterator +=================================== + +.. doxygenfile:: lgraph_edge_index_iterator.h +:project: cpp_procedure + +# lgraph_edge_iterator +=================================== + +.. doxygenfile:: lgraph_edge_iterator.h +:project: cpp_procedure + +# lgraph_exceptions +=================================== + +.. doxygenfile:: lgraph_exceptions.h +:project: cpp_procedure + +# lgraph_galaxy +=================================== + +.. doxygenfile:: lgraph_galaxy.h +:project: cpp_procedure + +# lgraph_result +=================================== + +.. doxygenfile:: lgraph_result.h +:project: cpp_procedure From d319d46afc704edd0a75cffcd166f7848284339d Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 14:22:07 +0800 Subject: [PATCH 12/28] =?UTF-8?q?=E5=A2=9E=E5=8A=A0GQL=E6=9F=A5=E8=AF=A2?= =?UTF-8?q?=E9=A1=B5=E9=9D=A2=E7=9B=AE=E5=BD=95=EF=BC=8C=E5=B0=9D=E8=AF=95?= =?UTF-8?q?=E8=B0=83=E6=95=B4C++API=E7=9B=AE=E5=BD=95=E7=AD=89=E7=BA=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../3.C++-procedure/1.base64_encode.rst | 56 +------------------ .../1.procedure/{cpp.md => 7.cpp.md} | 0 .../9.olap&procedure/1.procedure/index.rst | 2 + 3 files changed, 3 insertions(+), 55 deletions(-) rename docs/zh-CN/source/9.olap&procedure/1.procedure/{cpp.md => 7.cpp.md} (100%) diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst index bf7f823bfc..abc5ce2ccd 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst @@ -2,58 +2,4 @@ base64_encode =================================== .. doxygenfile:: base64_encode.h - :project: cpp_procedure - -lgraph -=================================== - -.. doxygenfile:: lgraph.h - :project: cpp_procedure - -lgraph_atomic -=================================== - -.. doxygenfile:: lgraph_atomic.h - :project: cpp_procedure - -lgraph_date_time -=================================== - -.. doxygenfile:: lgraph_date_time.h - :project: cpp_procedure - -lgraph_db -=================================== - -.. doxygenfile:: lgraph_db.h - :project: cpp_procedure - -lgraph_edge_index_iterator -=================================== - -.. doxygenfile:: lgraph_edge_index_iterator.h - :project: cpp_procedure - -lgraph_edge_iterator -=================================== - -.. doxygenfile:: lgraph_edge_iterator.h - :project: cpp_procedure - -lgraph_exceptions -=================================== - -.. doxygenfile:: lgraph_exceptions.h - :project: cpp_procedure - -lgraph_galaxy -=================================== - -.. doxygenfile:: lgraph_galaxy.h - :project: cpp_procedure - -lgraph_result -=================================== - -.. doxygenfile:: lgraph_result.h - :project: cpp_procedure + :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md similarity index 100% rename from docs/zh-CN/source/9.olap&procedure/1.procedure/cpp.md rename to docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst index 1fbd71dffb..96b16d4edf 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst @@ -10,3 +10,5 @@ 3.C++-procedure/index.rst 4.Python-procedure.rst 5.Rust-procedure.md + 6.base64_encode.rst + 7.cpp.md \ No newline at end of file From 69f56cf14dbc392ede3d6ae60d9e42c74d0079a5 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 14:51:01 +0800 Subject: [PATCH 13/28] =?UTF-8?q?=E8=B0=83=E6=95=B4C++API=E7=9B=AE?= =?UTF-8?q?=E5=BD=95=E7=AD=89=E7=BA=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1.procedure/6.base64_encode.rst | 89 ++++++++++++++++--- .../9.olap&procedure/1.procedure/7.cpp.md | 59 ------------ .../9.olap&procedure/1.procedure/index.rst | 3 +- 3 files changed, 80 insertions(+), 71 deletions(-) delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst index bf7f823bfc..6126e7e573 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst @@ -1,59 +1,128 @@ +C++-procedure +==================================== + +.. toctree:: + :maxdepth: 2 + + + + base64_encode -=================================== +------------------ .. doxygenfile:: base64_encode.h :project: cpp_procedure lgraph -=================================== +------------------ .. doxygenfile:: lgraph.h :project: cpp_procedure lgraph_atomic -=================================== +------------------ .. doxygenfile:: lgraph_atomic.h :project: cpp_procedure lgraph_date_time -=================================== +------------------ .. doxygenfile:: lgraph_date_time.h :project: cpp_procedure lgraph_db -=================================== +------------------ .. doxygenfile:: lgraph_db.h :project: cpp_procedure lgraph_edge_index_iterator -=================================== +------------------ .. doxygenfile:: lgraph_edge_index_iterator.h :project: cpp_procedure lgraph_edge_iterator -=================================== +------------------ .. doxygenfile:: lgraph_edge_iterator.h :project: cpp_procedure lgraph_exceptions -=================================== +------------------ .. doxygenfile:: lgraph_exceptions.h :project: cpp_procedure lgraph_galaxy -=================================== +------------------ .. doxygenfile:: lgraph_galaxy.h :project: cpp_procedure lgraph_result -=================================== +------------------ .. doxygenfile:: lgraph_result.h :project: cpp_procedure + +lgraph_rpc_client +------------------ + +.. doxygenfile:: lgraph_rpc_client.h + :project: cpp_procedure + +lgraph_traversal +------------------ + +.. doxygenfile:: lgraph_traversal.h + :project: cpp_procedure + +lgraph_txn +------------------ + +.. doxygenfile:: lgraph_txn.h + :project: cpp_procedure + +lgraph_types +------------------ + +.. doxygenfile:: lgraph_types.h + :project: cpp_procedure + +lgraph_utils +------------------ + +.. doxygenfile:: lgraph_utils.h + :project: cpp_procedure + +lgraph_vertex_index_iterator +------------------ + +.. doxygenfile:: lgraph_vertex_index_iterator.h + :project: cpp_procedure + +lgraph_vertex_iterator +------------------ + +.. doxygenfile:: lgraph_vertex_iterator.h + :project: cpp_procedure + +olap_base +------------------ + +.. doxygenfile:: olap_base.h + :project: cpp_procedure + +olap_on_db +------------------ + +.. doxygenfile:: olap_on_db.h + :project: cpp_procedure + +olap_profile +------------------ + +.. doxygenfile:: olap_profile.h + :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md b/docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md deleted file mode 100644 index c76f89d91f..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/7.cpp.md +++ /dev/null @@ -1,59 +0,0 @@ -# base64_encode -=================================== - -.. doxygenfile:: base64_encode.h -:project: cpp_procedure - -# lgraph -=================================== - -.. doxygenfile:: lgraph.h -:project: cpp_procedure - -# lgraph_atomic -=================================== - -.. doxygenfile:: lgraph_atomic.h -:project: cpp_procedure - -# lgraph_date_time -=================================== - -.. doxygenfile:: lgraph_date_time.h -:project: cpp_procedure - -# lgraph_db -=================================== - -.. doxygenfile:: lgraph_db.h -:project: cpp_procedure - -# lgraph_edge_index_iterator -=================================== - -.. doxygenfile:: lgraph_edge_index_iterator.h -:project: cpp_procedure - -# lgraph_edge_iterator -=================================== - -.. doxygenfile:: lgraph_edge_iterator.h -:project: cpp_procedure - -# lgraph_exceptions -=================================== - -.. doxygenfile:: lgraph_exceptions.h -:project: cpp_procedure - -# lgraph_galaxy -=================================== - -.. doxygenfile:: lgraph_galaxy.h -:project: cpp_procedure - -# lgraph_result -=================================== - -.. doxygenfile:: lgraph_result.h -:project: cpp_procedure diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst index 96b16d4edf..e6e0cf4d90 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst @@ -10,5 +10,4 @@ 3.C++-procedure/index.rst 4.Python-procedure.rst 5.Rust-procedure.md - 6.base64_encode.rst - 7.cpp.md \ No newline at end of file + 6.base64_encode.rst \ No newline at end of file From d057a23415df76a2ffcbbadd5e2b239881adfe8e Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 15:06:21 +0800 Subject: [PATCH 14/28] =?UTF-8?q?=E8=B0=83=E6=95=B4C++API=E7=9B=AE?= =?UTF-8?q?=E5=BD=95=E7=AD=89=E7=BA=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/8.query/2.gql.md | 27 ++++++------------- ....base64_encode.rst => 3.C++-procedure.rst} | 2 +- .../3.C++-procedure/1.base64_encode.rst | 5 ---- .../3.C++-procedure/10.lgraph_result.rst | 5 ---- .../3.C++-procedure/11.lgraph_rpc_client.rst | 5 ---- .../3.C++-procedure/12.lgraph_traversal.rst | 5 ---- .../3.C++-procedure/13.lgraph_txn.rst | 5 ---- .../3.C++-procedure/14.lgraph_types.rst | 5 ---- .../3.C++-procedure/15.lgraph_utils.rst | 5 ---- .../16.lgraph_vertex_index_iterator.rst | 5 ---- .../17.lgraph_vertex_iterator.rst | 5 ---- .../3.C++-procedure/18.olap_base.rst | 5 ---- .../3.C++-procedure/19.olap_on_db.rst | 5 ---- .../1.procedure/3.C++-procedure/2.lgraph.rst | 5 ---- .../3.C++-procedure/20.olap_profile.rst | 5 ---- .../3.C++-procedure/3.lgraph_atomic.rst | 5 ---- .../3.C++-procedure/4.lgraph_date_time.rst | 5 ---- .../3.C++-procedure/5.lgraph_db.rst | 5 ---- .../6.lgraph_edge_index_iterator.rst | 5 ---- .../7.lgraph_edge_iterator.rst | 5 ---- .../3.C++-procedure/8.lgraph_exceptions.rst | 5 ---- .../3.C++-procedure/9.lgraph_galaxy.rst | 5 ---- .../1.procedure/3.C++-procedure/index.rst | 8 ------ .../9.olap&procedure/1.procedure/index.rst | 5 ++-- 24 files changed, 11 insertions(+), 131 deletions(-) rename docs/zh-CN/source/9.olap&procedure/1.procedure/{6.base64_encode.rst => 3.C++-procedure.rst} (98%) delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst delete mode 100644 docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst diff --git a/docs/zh-CN/source/8.query/2.gql.md b/docs/zh-CN/source/8.query/2.gql.md index 01c6c60753..a5234f46aa 100644 --- a/docs/zh-CN/source/8.query/2.gql.md +++ b/docs/zh-CN/source/8.query/2.gql.md @@ -8,17 +8,6 @@ TuGraph基于[ISO GQL (ISO/IEC 39075) Antlr4 语法文件](https://github.com/Tu ## 2.Clauses -contents: -- [MATCH](#heading-1) -- [OPTIONAL MATCH](#heading-2) -- [RETURN](#heading-3) -- [NEXT](#heading-4) -- [WHERE](#heading-5) -- [ORDER BY](#heading-6) -- [SKIP](#heading-7) -- [LIMIT](#heading-8) - - | 类别 | 子句 | | ------------------- | -------------- | | Reading clauses | MATCH | @@ -30,7 +19,7 @@ contents: | | SKIP | | | LIMIT | -### 2.1.MATCH +### 2.1.MATCH `MATCH`子句式是GQL最基础的子句,几乎所有查询都是通过 `MATCH`展开。 @@ -129,7 +118,7 @@ RETURN m.name LIMIT 2 [{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] ``` -### 2.2.OPTIONAL MATCH +### 2.2.OPTIONAL MATCH `OPTIONAL MATCH`匹配图模式,如果未命中,则返回`null`。 @@ -158,7 +147,7 @@ RETURN n.birthyear [{"n.birthyear":null}] ``` -### 2.3.RETURN +### 2.3.RETURN `RETURN`子句指定返回结果,包括返回点、边、路径、属性等。 @@ -267,7 +256,7 @@ RETURN DISTINCT label(n) AS label [{"label":"Person"},{"label":"City"},{"label":"Film"}] ``` -### 2.4.NEXT +### 2.4.NEXT `NEXT`子句用于连接多个子句。 @@ -286,7 +275,7 @@ RETURN n.name, n.birthyear, m.name LIMIT 2 [{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] ``` -### 2.5.WHERE +### 2.5.WHERE `WHERE`子句用于过滤记录。 @@ -335,7 +324,7 @@ RETURN n LIMIT 2 ``` -### 2.6.ORDER BY +### 2.6.ORDER BY `ORDER BY`是`RETURN`的子句,对输出的结果进行排序。 @@ -353,7 +342,7 @@ LIMIT 5 [{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] ``` -### 2.7.SKIP +### 2.7.SKIP `SKIP`指定结果偏移行数。 @@ -382,7 +371,7 @@ RETURN n.name SKIP 1 LIMIT 2 [{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] ``` -### 2.8.LIMIT +### 2.8.LIMIT `LIMIT`限制结果行数。 diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure.rst similarity index 98% rename from docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst rename to docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure.rst index 6126e7e573..7773487052 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/6.base64_encode.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure.rst @@ -1,4 +1,4 @@ -C++-procedure +C++存储过程接口 ==================================== .. toctree:: diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst deleted file mode 100644 index abc5ce2ccd..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/1.base64_encode.rst +++ /dev/null @@ -1,5 +0,0 @@ -base64_encode -=================================== - -.. doxygenfile:: base64_encode.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst deleted file mode 100644 index b321c843d6..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/10.lgraph_result.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_result -=================================== - -.. doxygenfile:: lgraph_result.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst deleted file mode 100644 index 0f53077dbc..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/11.lgraph_rpc_client.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_rpc_client -=================================== - -.. doxygenfile:: lgraph_rpc_client.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst deleted file mode 100644 index d7a9d7b97c..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/12.lgraph_traversal.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_traversal -=================================== - -.. doxygenfile:: lgraph_traversal.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst deleted file mode 100644 index 4b0be46a21..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/13.lgraph_txn.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_txn -=================================== - -.. doxygenfile:: lgraph_txn.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst deleted file mode 100644 index 4047340ef0..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/14.lgraph_types.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_types -=================================== - -.. doxygenfile:: lgraph_types.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst deleted file mode 100644 index 12814e7618..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/15.lgraph_utils.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_utils -=================================== - -.. doxygenfile:: lgraph_utils.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst deleted file mode 100644 index 572f9ae7c0..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_vertex_index_iterator -=================================== - -.. doxygenfile:: lgraph_vertex_index_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst deleted file mode 100644 index 5bfa8a1dd3..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_vertex_iterator -=================================== - -.. doxygenfile:: lgraph_vertex_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst deleted file mode 100644 index 8680a93ee9..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/18.olap_base.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_base -=================================== - -.. doxygenfile:: olap_base.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst deleted file mode 100644 index 9ce3afba80..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/19.olap_on_db.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_on_db -=================================== - -.. doxygenfile:: olap_on_db.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst deleted file mode 100644 index 5bed2e061c..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/2.lgraph.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph -=================================== - -.. doxygenfile:: lgraph.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst deleted file mode 100644 index 82bf0941c8..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/20.olap_profile.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_profile -=================================== - -.. doxygenfile:: olap_profile.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst deleted file mode 100644 index 8723e9f1d0..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/3.lgraph_atomic.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_atomic -=================================== - -.. doxygenfile:: lgraph_atomic.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst deleted file mode 100644 index ec8af7bb8f..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/4.lgraph_date_time.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_date_time -=================================== - -.. doxygenfile:: lgraph_date_time.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst deleted file mode 100644 index 07d6076327..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/5.lgraph_db.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_db -=================================== - -.. doxygenfile:: lgraph_db.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst deleted file mode 100644 index 07f4be3f67..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_edge_index_iterator -=================================== - -.. doxygenfile:: lgraph_edge_index_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst deleted file mode 100644 index 5be9e6547e..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_edge_iterator -=================================== - -.. doxygenfile:: lgraph_edge_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst deleted file mode 100644 index 70a0bd4cbf..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/8.lgraph_exceptions.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_exceptions -=================================== - -.. doxygenfile:: lgraph_exceptions.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst deleted file mode 100644 index a4f9af0582..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/9.lgraph_galaxy.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_galaxy -=================================== - -.. doxygenfile:: lgraph_galaxy.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst deleted file mode 100644 index 445ef76484..0000000000 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/3.C++-procedure/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -C++存储过程接口 -=================================== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst index e6e0cf4d90..3e34ded819 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst @@ -7,7 +7,6 @@ 1.procedure.md 2.traversal.md - 3.C++-procedure/index.rst + 3.3.C++-procedure.rst 4.Python-procedure.rst - 5.Rust-procedure.md - 6.base64_encode.rst \ No newline at end of file + 5.Rust-procedure.md \ No newline at end of file From b0d0ccff2bb70b3e7ef39fe0f71f953c2d1d99c8 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 21 Mar 2024 15:34:11 +0800 Subject: [PATCH 15/28] =?UTF-8?q?=E8=B0=83=E6=95=B4C++API=E7=9B=AE?= =?UTF-8?q?=E5=BD=95=E7=AD=89=E7=BA=A7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst index 3e34ded819..27a86697ca 100644 --- a/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/1.procedure/index.rst @@ -7,6 +7,6 @@ 1.procedure.md 2.traversal.md - 3.3.C++-procedure.rst + 3.C++-procedure.rst 4.Python-procedure.rst 5.Rust-procedure.md \ No newline at end of file From 69a2670e83df4a0dd8219d23c95a4fcb2fc5b4d5 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Fri, 22 Mar 2024 18:31:31 +0800 Subject: [PATCH 16/28] =?UTF-8?q?=E8=B0=83=E6=95=B4=E8=8B=B1=E6=96=87?= =?UTF-8?q?=E7=9B=AE=E5=BD=95=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 +- docs/en-US/source/1.guide.md | 18 +- .../8.other => 10.permission}/1.privilege.md | 0 .../8.other => 10.permission}/2.token.md | 4 +- .../3.reset_admin_password.md | 0 .../4.monitoring.md} | 0 .../4.log.md => 10.permission/5.log.md} | 2 +- .../8.other => 10.permission}/index.rst | 3 +- .../1.unit-testing.md | 0 .../2.integration-testing.md | 0 .../7.quality => 11.quality}/index.rst | 1 + .../1.contributing.md | 2 +- .../2.community-roles.md | 0 .../3.individual-cla.md | 0 .../4.corporate-cla.md | 0 .../5.roadmap.md | 0 .../index.rst | 0 .../13.best-practices/1.rdbms-to-tugraph.md | 3 + .../2.learn_practices.md | 2 +- .../3.data_migration.md | 2 +- .../4.selection.md | 8 +- .../index.rst | 0 docs/en-US/source/{8.faq.md => 14.faq.md} | 0 .../source/{9.contacts.md => 15.contacts.md} | 0 .../2.introduction/3.what-is-tugraph.md | 97 +---- docs/en-US/source/2.introduction/4.schema.md | 95 +++++ .../1.performance-oriented.md | 0 .../2.multi-level-Interfaces.md | 0 .../3.htap.md | 0 .../index.rst | 0 .../{5.architecture.md => 6.architecture.md} | 0 ...{6.functionality.md => 7.functionality.md} | 0 .../{7.scenarios.md => 8.scenarios.md} | 0 .../{8.glossary.md => 9.glossary.md} | 0 docs/en-US/source/2.introduction/index.rst | 11 +- .../source/4.user-guide/1.tugraph-browser.md | 6 +- .../5.developer-manual/2.running/index.rst | 8 - .../5.ecosystem-tools/3.tugraph-explorer.md | 3 - .../5.ecosystem-tools/index.rst | 8 - .../6.interface/1.query/2.gql/1.intro.md | 18 - .../1.query/2.gql/2.clauses/1.match.md | 100 ----- .../2.gql/2.clauses/2.optional_match.md | 30 -- .../1.query/2.gql/2.clauses/3.return.md | 110 ----- .../1.query/2.gql/2.clauses/4.next.md | 21 - .../1.query/2.gql/2.clauses/5.where.md | 48 --- .../1.query/2.gql/2.clauses/6.orderby.md | 19 - .../1.query/2.gql/2.clauses/7.skip.md | 30 -- .../1.query/2.gql/2.clauses/8.limit.md | 17 - .../1.query/2.gql/2.clauses/index.rst | 8 - .../6.interface/1.query/2.gql/index.rst | 9 - .../3.C++-procedure/1.base64_encode.rst | 5 - .../3.C++-procedure/10.lgraph_result.rst | 5 - .../3.C++-procedure/11.lgraph_rpc_client.rst | 5 - .../3.C++-procedure/12.lgraph_traversal.rst | 5 - .../3.C++-procedure/13.lgraph_txn.rst | 5 - .../3.C++-procedure/14.lgraph_types.rst | 5 - .../3.C++-procedure/15.lgraph_utils.rst | 5 - .../16.lgraph_vertex_index_iterator.rst | 5 - .../17.lgraph_vertex_iterator.rst | 5 - .../3.C++-procedure/18.olap_base.rst | 5 - .../3.C++-procedure/19.olap_on_db.rst | 5 - .../3.procedure/3.C++-procedure/2.lgraph.rst | 5 - .../3.C++-procedure/20.olap_profile.rst | 5 - .../3.C++-procedure/3.lgraph_atomic.rst | 5 - .../3.C++-procedure/4.lgraph_date_time.rst | 5 - .../3.C++-procedure/5.lgraph_db.rst | 5 - .../6.lgraph_edge_index_iterator.rst | 5 - .../7.lgraph_edge_iterator.rst | 5 - .../3.C++-procedure/8.lgraph_exceptions.rst | 5 - .../3.C++-procedure/9.lgraph_galaxy.rst | 5 - .../3.procedure/3.C++-procedure/index.rst | 8 - .../1.environment.md | 0 .../2.environment-mode.md | 0 .../3.docker-deployment.md | 2 +- .../4.local-package-deployment.md | 0 .../5.cloud-deployment.md | 20 +- .../6.compile.md} | 2 +- .../7.tugraph-running.md} | 2 +- .../8.high-availability-mode.md} | 2 +- .../index.rst | 3 +- .../1.data-import.md | 0 .../2.data-export.md | 0 .../3.backup-and-restore.md | 0 .../4.data-warmup.md | 0 .../5.ha-cluster-management.md | 0 .../6.tugraph-cli.md} | 0 .../7.tugraph-datax.md} | 0 .../6.utility-tools/8.tugraph-explorer.md | 3 + .../index.rst | 7 +- .../7.best-practices/1.rdbms-to-tugraph.md | 3 - .../1.python-client.md | 0 .../2.cpp-client.md | 0 .../3.java-client.md | 0 .../4.tugraph-ogm.md | 0 .../5.bolt-client.md} | 0 .../6.bolt-console-client.md} | 0 .../7.restful-api.md} | 0 .../8.rpc-api.md} | 0 .../9.restful-api-legacy.md} | 4 +- .../index.rst | 1 + .../1.query => 8.query}/1.cypher.md | 0 docs/en-US/source/8.query/2.gql.md | 400 ++++++++++++++++++ .../6.interface/1.query => 8.query}/index.rst | 6 +- .../1.procedure}/1.procedure.md | 0 .../1.procedure}/2.traversal.md | 0 .../1.procedure/3.C++-procedure.rst | 128 ++++++ .../1.procedure}/4.Python-procedure.rst | 0 .../1.procedure}/5.Rust-procedure.md | 0 .../1.procedure}/Doxyfile | 2 +- .../1.procedure}/index.rst | 2 +- .../1.procedure}/index.rst.aci | 0 .../2.olap/1.tutorial.md | 0 .../2.olap/2.olap-base-api.md | 0 .../2.olap/3.olap-on-db-api.md | 0 .../2.olap/4.olap-on-disk-api.md | 0 .../2.olap/5.python-api.md | 0 .../2.olap/6.algorithms.md | 0 .../2.olap/index.rst | 0 .../3.learn}/1.tutorial.md | 6 +- .../3.learn}/2.sampling_api.md | 0 .../3.learn}/3.training.md | 0 .../3.learn}/4.heterogeneous_graph.md | 0 .../3.learn}/index.rst | 0 docs/en-US/source/9.olap&procedure/index.rst | 11 + docs/en-US/source/conf.py | 18 +- docs/en-US/source/index.rst | 16 +- docs/zh-CN/source/10.permission/2.token.md | 2 +- docs/zh-CN/source/10.permission/index.rst | 1 + docs/zh-CN/source/11.quality/index.rst | 1 + .../3.docker-deployment.md | 2 +- .../source/5.installation&running/index.rst | 1 + docs/zh-CN/source/6.utility-tools/index.rst | 1 + .../{6.bolt-client.md => 5.bolt-client.md} | 0 ...ole-client.md => 6.bolt-console-client.md} | 0 .../{8.restful-api.md => 7.restful-api.md} | 0 .../{9.rpc-api.md => 8.rpc-api.md} | 0 ...-api-legacy.md => 9.restful-api-legacy.md} | 2 +- docs/zh-CN/source/7.client-tools/index.rst | 1 + docs/zh-CN/source/9.olap&procedure/index.rst | 1 + 139 files changed, 734 insertions(+), 711 deletions(-) rename docs/en-US/source/{5.developer-manual/8.other => 10.permission}/1.privilege.md (100%) rename docs/en-US/source/{5.developer-manual/8.other => 10.permission}/2.token.md (95%) rename docs/en-US/source/{5.developer-manual/8.other => 10.permission}/3.reset_admin_password.md (100%) rename docs/en-US/source/{5.developer-manual/5.ecosystem-tools/1.monitoring.md => 10.permission/4.monitoring.md} (100%) rename docs/en-US/source/{5.developer-manual/5.ecosystem-tools/4.log.md => 10.permission/5.log.md} (97%) rename docs/en-US/source/{5.developer-manual/8.other => 10.permission}/index.rst (54%) rename docs/en-US/source/{5.developer-manual/7.quality => 11.quality}/1.unit-testing.md (100%) rename docs/en-US/source/{5.developer-manual/7.quality => 11.quality}/2.integration-testing.md (100%) rename docs/en-US/source/{5.developer-manual/7.quality => 11.quality}/index.rst (80%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/1.contributing.md (97%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/2.community-roles.md (100%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/3.individual-cla.md (100%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/4.corporate-cla.md (100%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/5.roadmap.md (100%) rename docs/en-US/source/{6.contributor-manual => 12.contributor-manual}/index.rst (100%) create mode 100644 docs/en-US/source/13.best-practices/1.rdbms-to-tugraph.md rename docs/en-US/source/{7.best-practices => 13.best-practices}/2.learn_practices.md (99%) rename docs/en-US/source/{7.best-practices => 13.best-practices}/3.data_migration.md (97%) rename docs/en-US/source/{7.best-practices => 13.best-practices}/4.selection.md (83%) rename docs/en-US/source/{7.best-practices => 13.best-practices}/index.rst (100%) rename docs/en-US/source/{8.faq.md => 14.faq.md} (100%) rename docs/en-US/source/{9.contacts.md => 15.contacts.md} (100%) create mode 100644 docs/en-US/source/2.introduction/4.schema.md rename docs/en-US/source/2.introduction/{4.characteristics => 5.characteristics}/1.performance-oriented.md (100%) rename docs/en-US/source/2.introduction/{4.characteristics => 5.characteristics}/2.multi-level-Interfaces.md (100%) rename docs/en-US/source/2.introduction/{4.characteristics => 5.characteristics}/3.htap.md (100%) rename docs/en-US/source/2.introduction/{4.characteristics => 5.characteristics}/index.rst (100%) rename docs/en-US/source/2.introduction/{5.architecture.md => 6.architecture.md} (100%) rename docs/en-US/source/2.introduction/{6.functionality.md => 7.functionality.md} (100%) rename docs/en-US/source/2.introduction/{7.scenarios.md => 8.scenarios.md} (100%) rename docs/en-US/source/2.introduction/{8.glossary.md => 9.glossary.md} (100%) delete mode 100644 docs/en-US/source/5.developer-manual/2.running/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md delete mode 100644 docs/en-US/source/5.developer-manual/5.ecosystem-tools/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/1.environment.md (100%) rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/2.environment-mode.md (100%) rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/3.docker-deployment.md (97%) rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/4.local-package-deployment.md (100%) rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/5.cloud-deployment.md (93%) rename docs/en-US/source/{5.developer-manual/2.running/1.compile.md => 5.installation&running/6.compile.md} (92%) rename docs/en-US/source/{5.developer-manual/2.running/2.tugraph-running.md => 5.installation&running/7.tugraph-running.md} (99%) rename docs/en-US/source/{5.developer-manual/2.running/3.high-availability-mode.md => 5.installation&running/8.high-availability-mode.md} (99%) rename docs/en-US/source/{5.developer-manual/1.installation => 5.installation&running}/index.rst (61%) rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/1.data-import.md (100%) rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/2.data-export.md (100%) rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/3.backup-and-restore.md (100%) rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/4.data-warmup.md (100%) rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/5.ha-cluster-management.md (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools/5.tugraph-cli.md => 6.utility-tools/6.tugraph-cli.md} (100%) rename docs/en-US/source/{5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md => 6.utility-tools/7.tugraph-datax.md} (100%) create mode 100644 docs/en-US/source/6.utility-tools/8.tugraph-explorer.md rename docs/en-US/source/{5.developer-manual/3.server-tools => 6.utility-tools}/index.rst (64%) delete mode 100644 docs/en-US/source/7.best-practices/1.rdbms-to-tugraph.md rename docs/en-US/source/{5.developer-manual/4.client-tools => 7.client-tools}/1.python-client.md (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools => 7.client-tools}/2.cpp-client.md (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools => 7.client-tools}/3.java-client.md (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools => 7.client-tools}/4.tugraph-ogm.md (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools/6.bolt-client.md => 7.client-tools/5.bolt-client.md} (100%) rename docs/en-US/source/{5.developer-manual/4.client-tools/7.bolt-console-client.md => 7.client-tools/6.bolt-console-client.md} (100%) rename docs/en-US/source/{5.developer-manual/6.interface/4.protocol/3.restful-api.md => 7.client-tools/7.restful-api.md} (100%) rename docs/en-US/source/{5.developer-manual/6.interface/4.protocol/2.rpc-api.md => 7.client-tools/8.rpc-api.md} (100%) rename docs/en-US/source/{5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md => 7.client-tools/9.restful-api-legacy.md} (99%) rename docs/en-US/source/{5.developer-manual/4.client-tools => 7.client-tools}/index.rst (82%) rename docs/en-US/source/{5.developer-manual/6.interface/1.query => 8.query}/1.cypher.md (100%) create mode 100644 docs/en-US/source/8.query/2.gql.md rename docs/en-US/source/{5.developer-manual/6.interface/1.query => 8.query}/index.rst (52%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/1.procedure.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/2.traversal.md (100%) create mode 100644 docs/en-US/source/9.olap&procedure/1.procedure/3.C++-procedure.rst rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/4.Python-procedure.rst (100%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/5.Rust-procedure.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/Doxyfile (99%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/index.rst (85%) rename docs/en-US/source/{5.developer-manual/6.interface/3.procedure => 9.olap&procedure/1.procedure}/index.rst.aci (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/1.tutorial.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/2.olap-base-api.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/3.olap-on-db-api.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/4.olap-on-disk-api.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/5.python-api.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/6.algorithms.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface => 9.olap&procedure}/2.olap/index.rst (100%) rename docs/en-US/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/1.tutorial.md (95%) rename docs/en-US/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/2.sampling_api.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/3.training.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/4.heterogeneous_graph.md (100%) rename docs/en-US/source/{5.developer-manual/6.interface/5.learn => 9.olap&procedure/3.learn}/index.rst (100%) create mode 100644 docs/en-US/source/9.olap&procedure/index.rst rename docs/zh-CN/source/7.client-tools/{6.bolt-client.md => 5.bolt-client.md} (100%) rename docs/zh-CN/source/7.client-tools/{7.bolt-console-client.md => 6.bolt-console-client.md} (100%) rename docs/zh-CN/source/7.client-tools/{8.restful-api.md => 7.restful-api.md} (100%) rename docs/zh-CN/source/7.client-tools/{9.rpc-api.md => 8.rpc-api.md} (100%) rename docs/zh-CN/source/7.client-tools/{10.restful-api-legacy.md => 9.restful-api-legacy.md} (99%) diff --git a/README.md b/README.md index a9bdd87509..11f544f71f 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/en-US/source/1.guide.md b/docs/en-US/source/1.guide.md index 0531cac912..36ac31afad 100644 --- a/docs/en-US/source/1.guide.md +++ b/docs/en-US/source/1.guide.md @@ -4,9 +4,9 @@ ## 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). @@ -14,19 +14,19 @@ ## 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 @@ -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/8.other/1.privilege.md b/docs/en-US/source/10.permission/1.privilege.md similarity index 100% rename from docs/en-US/source/5.developer-manual/8.other/1.privilege.md rename to docs/en-US/source/10.permission/1.privilege.md diff --git a/docs/en-US/source/5.developer-manual/8.other/2.token.md b/docs/en-US/source/10.permission/2.token.md similarity index 95% rename from docs/en-US/source/5.developer-manual/8.other/2.token.md rename to docs/en-US/source/10.permission/2.token.md index 28d037abc2..dd4ac2e2e5 100644 --- a/docs/en-US/source/5.developer-manual/8.other/2.token.md +++ b/docs/en-US/source/10.permission/2.token.md @@ -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. diff --git a/docs/en-US/source/5.developer-manual/8.other/3.reset_admin_password.md b/docs/en-US/source/10.permission/3.reset_admin_password.md similarity index 100% rename from docs/en-US/source/5.developer-manual/8.other/3.reset_admin_password.md rename to docs/en-US/source/10.permission/3.reset_admin_password.md diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/1.monitoring.md b/docs/en-US/source/10.permission/4.monitoring.md similarity index 100% rename from docs/en-US/source/5.developer-manual/5.ecosystem-tools/1.monitoring.md rename to docs/en-US/source/10.permission/4.monitoring.md diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md b/docs/en-US/source/10.permission/5.log.md similarity index 97% rename from docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md rename to docs/en-US/source/10.permission/5.log.md index df1fd8dfb1..ae799bacda 100644 --- a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/4.log.md +++ b/docs/en-US/source/10.permission/5.log.md @@ -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) diff --git a/docs/en-US/source/5.developer-manual/8.other/index.rst b/docs/en-US/source/10.permission/index.rst similarity index 54% rename from docs/en-US/source/5.developer-manual/8.other/index.rst rename to docs/en-US/source/10.permission/index.rst index d2e81f6ec7..d402f7e2b7 100644 --- a/docs/en-US/source/5.developer-manual/8.other/index.rst +++ b/docs/en-US/source/10.permission/index.rst @@ -1,8 +1,9 @@ -TuGraph DB Other +TuGraph DB Privilege And Operations ======================== .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/7.quality/1.unit-testing.md b/docs/en-US/source/11.quality/1.unit-testing.md similarity index 100% rename from docs/en-US/source/5.developer-manual/7.quality/1.unit-testing.md rename to docs/en-US/source/11.quality/1.unit-testing.md diff --git a/docs/en-US/source/5.developer-manual/7.quality/2.integration-testing.md b/docs/en-US/source/11.quality/2.integration-testing.md similarity index 100% rename from docs/en-US/source/5.developer-manual/7.quality/2.integration-testing.md rename to docs/en-US/source/11.quality/2.integration-testing.md diff --git a/docs/en-US/source/5.developer-manual/7.quality/index.rst b/docs/en-US/source/11.quality/index.rst similarity index 80% rename from docs/en-US/source/5.developer-manual/7.quality/index.rst rename to docs/en-US/source/11.quality/index.rst index c6be070cb8..f3b6e0e061 100644 --- a/docs/en-US/source/5.developer-manual/7.quality/index.rst +++ b/docs/en-US/source/11.quality/index.rst @@ -3,6 +3,7 @@ TuGraph DB Quality .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/en-US/source/6.contributor-manual/1.contributing.md b/docs/en-US/source/12.contributor-manual/1.contributing.md similarity index 97% rename from docs/en-US/source/6.contributor-manual/1.contributing.md rename to docs/en-US/source/12.contributor-manual/1.contributing.md index c73d0e0624..bf465539f2 100644 --- a/docs/en-US/source/6.contributor-manual/1.contributing.md +++ b/docs/en-US/source/12.contributor-manual/1.contributing.md @@ -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 diff --git a/docs/en-US/source/6.contributor-manual/2.community-roles.md b/docs/en-US/source/12.contributor-manual/2.community-roles.md similarity index 100% rename from docs/en-US/source/6.contributor-manual/2.community-roles.md rename to docs/en-US/source/12.contributor-manual/2.community-roles.md diff --git a/docs/en-US/source/6.contributor-manual/3.individual-cla.md b/docs/en-US/source/12.contributor-manual/3.individual-cla.md similarity index 100% rename from docs/en-US/source/6.contributor-manual/3.individual-cla.md rename to docs/en-US/source/12.contributor-manual/3.individual-cla.md diff --git a/docs/en-US/source/6.contributor-manual/4.corporate-cla.md b/docs/en-US/source/12.contributor-manual/4.corporate-cla.md similarity index 100% rename from docs/en-US/source/6.contributor-manual/4.corporate-cla.md rename to docs/en-US/source/12.contributor-manual/4.corporate-cla.md diff --git a/docs/en-US/source/6.contributor-manual/5.roadmap.md b/docs/en-US/source/12.contributor-manual/5.roadmap.md similarity index 100% rename from docs/en-US/source/6.contributor-manual/5.roadmap.md rename to docs/en-US/source/12.contributor-manual/5.roadmap.md diff --git a/docs/en-US/source/6.contributor-manual/index.rst b/docs/en-US/source/12.contributor-manual/index.rst similarity index 100% rename from docs/en-US/source/6.contributor-manual/index.rst rename to docs/en-US/source/12.contributor-manual/index.rst diff --git a/docs/en-US/source/13.best-practices/1.rdbms-to-tugraph.md b/docs/en-US/source/13.best-practices/1.rdbms-to-tugraph.md new file mode 100644 index 0000000000..baef5017a6 --- /dev/null +++ b/docs/en-US/source/13.best-practices/1.rdbms-to-tugraph.md @@ -0,0 +1,3 @@ +# Importing Data from Relational Databases to TuGraph + +> Using [DataX](../6.utility-tools/7.tugraph-datax.md),to be completed. \ No newline at end of file diff --git a/docs/en-US/source/7.best-practices/2.learn_practices.md b/docs/en-US/source/13.best-practices/2.learn_practices.md similarity index 99% rename from docs/en-US/source/7.best-practices/2.learn_practices.md rename to docs/en-US/source/13.best-practices/2.learn_practices.md index f8b19f86be..c7b094b1b7 100644 --- a/docs/en-US/source/7.best-practices/2.learn_practices.md +++ b/docs/en-US/source/13.best-practices/2.learn_practices.md @@ -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 diff --git a/docs/en-US/source/7.best-practices/3.data_migration.md b/docs/en-US/source/13.best-practices/3.data_migration.md similarity index 97% rename from docs/en-US/source/7.best-practices/3.data_migration.md rename to docs/en-US/source/13.best-practices/3.data_migration.md index 5eac1fdd6a..f769293858 100644 --- a/docs/en-US/source/7.best-practices/3.data_migration.md +++ b/docs/en-US/source/13.best-practices/3.data_migration.md @@ -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 ``` diff --git a/docs/en-US/source/7.best-practices/4.selection.md b/docs/en-US/source/13.best-practices/4.selection.md similarity index 83% rename from docs/en-US/source/7.best-practices/4.selection.md rename to docs/en-US/source/13.best-practices/4.selection.md index 159c9d3b35..62f7a61957 100644 --- a/docs/en-US/source/7.best-practices/4.selection.md +++ b/docs/en-US/source/13.best-practices/4.selection.md @@ -16,7 +16,7 @@ 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 @@ -24,10 +24,10 @@ TuGraph deployment only requires one server (high availability mode requires mul | 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). \ No newline at end of file +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). \ No newline at end of file diff --git a/docs/en-US/source/7.best-practices/index.rst b/docs/en-US/source/13.best-practices/index.rst similarity index 100% rename from docs/en-US/source/7.best-practices/index.rst rename to docs/en-US/source/13.best-practices/index.rst diff --git a/docs/en-US/source/8.faq.md b/docs/en-US/source/14.faq.md similarity index 100% rename from docs/en-US/source/8.faq.md rename to docs/en-US/source/14.faq.md diff --git a/docs/en-US/source/9.contacts.md b/docs/en-US/source/15.contacts.md similarity index 100% rename from docs/en-US/source/9.contacts.md rename to docs/en-US/source/15.contacts.md diff --git a/docs/en-US/source/2.introduction/3.what-is-tugraph.md b/docs/en-US/source/2.introduction/3.what-is-tugraph.md index a94a71b91c..da6cbf6318 100644 --- a/docs/en-US/source/2.introduction/3.what-is-tugraph.md +++ b/docs/en-US/source/2.introduction/3.what-is-tugraph.md @@ -35,102 +35,7 @@ Performance and scalability features include: - High-performance Batch Import - Online/offline backup -## 4.The data model - -### 4.1.Graph model -TuGraph is a strong schema, directed property graph database with multi-graph capability. - -- Graph Project: Each database service can host multiple graph projects (multi-graphs), and each graph project can have its own access control configuration. The database administrator can create or delete specified graph projects. -- Vertex: Refers to entity, generally used to express real-world entities, such as a movie or an actor. - - Primary Key: User-defined vertex data primary key, unique in the corresponding graph project and vertex type. - - VID: Refers to the auto-generated unique ID of the vertex, which cannot be modified by the user. - - Upper Limit: Each graph project can store up to 2^(40) vertex data. -- Edge: Used to express the relationship between vertexs, such as an actor appears in a movie. - - Directed Edge: The edge is a directed edge. If you want to simulate an undirected edge, the user can create two edges with opposite directions. - - Duplicate Edge: TuGraph currently supports duplicate edges. If you want to ensure the uniqueness of the edge, you need to implement it through business policies. - - Upper Limit: Up to 2^(32) edge data can be stored between two vertex data. -- Property Graph: vertexs and edges can have properties associated with them, and each property can have a different type. -- Strong-typed: Each vertex and edge has only one label, and after creating a label, there is a cost to modify the number and type of attributes. - - Specify the starting/ending vertex type of the edge: You can limit the starting and ending vertex types of the edge, and support different vertex types of the starting and ending vertexs of the same type of edge, such as individuals transferring money to companies, companies transferring money to companies. After specifying the starting/ending vertex type of the edge, you can add multiple sets of starting/ending vertex types, but you cannot delete the restricted starting/ending vertex types. - - Unrestricted Mode: Supports creating edge data of this type between any two vertex types without specifying the starting and ending vertex types of the edge. Note: After specifying the starting/ending vertex type of the edge, the unrestricted mode cannot be used again. - -### 4.2.The data type - -TuGraph Supports a variety of data types that can be used as attributes, the specific supported data types are as follows: - -Table 1. TuGraph supported data types - -| **Type** | **Min** | **Max** | **Description** | -|----------|---------------------|---------------------|--------------------------------------------------| -| BOOL | false | true | Boolean | -| INT8 | -128 | 127 | 8-bit int | -| INT16 | -32768 | 32767 | 16-bit int | -| INT32 | - 2^31 | 2^31 - 1 | 32-bit int | -| INT64 | - 2^63 | 2^63 - 1 | 64-bit int | -| DATE | 0000-00-00 | 9999-12-31 | "YYYY-MM-DD" Date of format | -| DATETIME | 0000-00-00 00:00:00.000000 | 9999-12-31 23:59:59.999999 | "YYYY-MM-DD hh:mm:ss[.ffffff]"Format of the date and time | -| FLOAT | | | 32-bit float | -| DOUBLE | | | 64-bit float | -| STRING | | | A string of variable length | -| BLOB | | | Binary data | - -_BLOB data is BASE64 encoded in input and output_ - -### 4.3.Index - -TuGraph supports indexing vertex fields. - -Indexes can be unique or non-unique. If a unique index is created for a vertex label, TuGraph will perform a data integrity check to ensure the uniqueness of the index before modifying the vertex of the label. - -Each index built on a single field of a label, and multiple fields can be indexed using the same label. - -BLOB fields cannot be indexed. - -TuGraph supports creating indexes on properties of vertexs or edges to improve query efficiency. -- The index can be a unique or non-unique index. -- If a unique index is created for a vertex label, when modifying the vertex of the label, data integrity check will be performed first to ensure the uniqueness of the index. -- Each index is created based on a property of a vertex or edge, and indexes can be created on multiple properties of the same vertex or edge. -- An index cannot be created on a BLOB-type property. - -## 5. Graph Project, Vertex, Edge, and Attribute Naming Conventions and suggestions - -### 5.1 Naming Rules -Graph projects, vertices, edges, and attributes are identifiers. This section describes the allowed syntax for identifiers in TuGraph. -The table below describes the maximum length and allowed characters for each type of identifier. - -|**Identifier** |**Length** |**Allowed Characters**| -|--------- |--------- |--------- | -|User, role, graph project |1-64 characters |Chinese, letters, numbers, underscore, and the first character cannot be a number| -|Vertex type, edge type, attribute |1-256 characters |Chinese, letters, numbers, underscore, and the first character cannot be a number| - -### 5.2 Usage Restrictions - -|**Description**| **Maximum number**| -|-------- |--------- | -|Number of users, number of roles |65536| -|Number of graphs |4096| -|Number of vertex and edge types per graph |4096| -|Number of attributes per type |1024| - -Note: -1.Special characters and keywords: When using special characters or keywords, they need to be enclosed in backquotes (``) for reference; - -Example: ```match (`match`:match) return `match`.id limit 1``` - -2.Case sensitivity: TuGraph is case-sensitive; - -3.Graph project, vertex/edge, and attribute names can be reused, but attribute names under the same vertex or edge cannot be duplicated; - -4.Reserved keywords for attribute names: SRC_ID / DST_ID / SKIP. - -### 5.3 Naming Suggestions -|**Identifier**|**Description**|**Suggestions**| -|-------|-------|--------| -|Graph project |Start with a letter or Chinese character |Examples: graph123, project123, etc.| -|Vertex/edge type |Start with a letter or Chinese character and use underscores to separate words |Examples: person, act_in, etc.| -|Attribute |Letters or Chinese characters |Examples: name, age, etc.| - -## 6.TuGraph Enterprise Edition +## 4.TuGraph Enterprise Edition The Enterprise Edition has more comprehensive support for commercial features, including distributed cluster architecture, a one-stop graph platform covering exploration, research and development, service and operation and maintenance throughout the lifecycle, online, near-line, and offline graph computing engines, support for streaming and big data data sources, multi-site and multi-center deployment, making it an ideal choice for commercial solutions. diff --git a/docs/en-US/source/2.introduction/4.schema.md b/docs/en-US/source/2.introduction/4.schema.md new file mode 100644 index 0000000000..422d96b675 --- /dev/null +++ b/docs/en-US/source/2.introduction/4.schema.md @@ -0,0 +1,95 @@ +# TuGraph schema Instructions +## 1.The data model + +### 1.1.Graph model +TuGraph is a strong schema, directed property graph database with multi-graph capability. + +- Graph Project: Each database service can host multiple graph projects (multi-graphs), and each graph project can have its own access control configuration. The database administrator can create or delete specified graph projects. +- Vertex: Refers to entity, generally used to express real-world entities, such as a movie or an actor. + - Primary Key: User-defined vertex data primary key, unique in the corresponding graph project and vertex type. + - VID: Refers to the auto-generated unique ID of the vertex, which cannot be modified by the user. + - Upper Limit: Each graph project can store up to 2^(40) vertex data. +- Edge: Used to express the relationship between vertexs, such as an actor appears in a movie. + - Directed Edge: The edge is a directed edge. If you want to simulate an undirected edge, the user can create two edges with opposite directions. + - Duplicate Edge: TuGraph currently supports duplicate edges. If you want to ensure the uniqueness of the edge, you need to implement it through business policies. + - Upper Limit: Up to 2^(32) edge data can be stored between two vertex data. +- Property Graph: vertexs and edges can have properties associated with them, and each property can have a different type. +- Strong-typed: Each vertex and edge has only one label, and after creating a label, there is a cost to modify the number and type of attributes. + - Specify the starting/ending vertex type of the edge: You can limit the starting and ending vertex types of the edge, and support different vertex types of the starting and ending vertexs of the same type of edge, such as individuals transferring money to companies, companies transferring money to companies. After specifying the starting/ending vertex type of the edge, you can add multiple sets of starting/ending vertex types, but you cannot delete the restricted starting/ending vertex types. + - Unrestricted Mode: Supports creating edge data of this type between any two vertex types without specifying the starting and ending vertex types of the edge. Note: After specifying the starting/ending vertex type of the edge, the unrestricted mode cannot be used again. + +### 1.2.The data type + +TuGraph Supports a variety of data types that can be used as attributes, the specific supported data types are as follows: + +Table 1. TuGraph supported data types + +| **Type** | **Min** | **Max** | **Description** | +|----------|---------------------|---------------------|--------------------------------------------------| +| BOOL | false | true | Boolean | +| INT8 | -128 | 127 | 8-bit int | +| INT16 | -32768 | 32767 | 16-bit int | +| INT32 | - 2^31 | 2^31 - 1 | 32-bit int | +| INT64 | - 2^63 | 2^63 - 1 | 64-bit int | +| DATE | 0000-00-00 | 9999-12-31 | "YYYY-MM-DD" Date of format | +| DATETIME | 0000-00-00 00:00:00.000000 | 9999-12-31 23:59:59.999999 | "YYYY-MM-DD hh:mm:ss[.ffffff]"Format of the date and time | +| FLOAT | | | 32-bit float | +| DOUBLE | | | 64-bit float | +| STRING | | | A string of variable length | +| BLOB | | | Binary data | + +_BLOB data is BASE64 encoded in input and output_ + +### 1.3.Index + +TuGraph supports indexing vertex fields. + +Indexes can be unique or non-unique. If a unique index is created for a vertex label, TuGraph will perform a data integrity check to ensure the uniqueness of the index before modifying the vertex of the label. + +Each index built on a single field of a label, and multiple fields can be indexed using the same label. + +BLOB fields cannot be indexed. + +TuGraph supports creating indexes on properties of vertexs or edges to improve query efficiency. +- The index can be a unique or non-unique index. +- If a unique index is created for a vertex label, when modifying the vertex of the label, data integrity check will be performed first to ensure the uniqueness of the index. +- Each index is created based on a property of a vertex or edge, and indexes can be created on multiple properties of the same vertex or edge. +- An index cannot be created on a BLOB-type property. + +## 2. Graph Project, Vertex, Edge, and Attribute Naming Conventions and suggestions + +### 2.1 Naming Rules +Graph projects, vertices, edges, and attributes are identifiers. This section describes the allowed syntax for identifiers in TuGraph. +The table below describes the maximum length and allowed characters for each type of identifier. + +|**Identifier** |**Length** |**Allowed Characters**| +|--------- |--------- |--------- | +|User, role, graph project |1-64 characters |Chinese, letters, numbers, underscore, and the first character cannot be a number| +|Vertex type, edge type, attribute |1-256 characters |Chinese, letters, numbers, underscore, and the first character cannot be a number| + +### 2.2 Usage Restrictions + +|**Description**| **Maximum number**| +|-------- |--------- | +|Number of users, number of roles |65536| +|Number of graphs |4096| +|Number of vertex and edge types per graph |4096| +|Number of attributes per type |1024| + +Note: +1.Special characters and keywords: When using special characters or keywords, they need to be enclosed in backquotes (``) for reference; + +Example: ```match (`match`:match) return `match`.id limit 1``` + +2.Case sensitivity: TuGraph is case-sensitive; + +3.Graph project, vertex/edge, and attribute names can be reused, but attribute names under the same vertex or edge cannot be duplicated; + +4.Reserved keywords for attribute names: SRC_ID / DST_ID / SKIP. + +### 2.3 Naming Suggestions +|**Identifier**|**Description**|**Suggestions**| +|-------|-------|--------| +|Graph project |Start with a letter or Chinese character |Examples: graph123, project123, etc.| +|Vertex/edge type |Start with a letter or Chinese character and use underscores to separate words |Examples: person, act_in, etc.| +|Attribute |Letters or Chinese characters |Examples: name, age, etc.| \ No newline at end of file diff --git a/docs/en-US/source/2.introduction/4.characteristics/1.performance-oriented.md b/docs/en-US/source/2.introduction/5.characteristics/1.performance-oriented.md similarity index 100% rename from docs/en-US/source/2.introduction/4.characteristics/1.performance-oriented.md rename to docs/en-US/source/2.introduction/5.characteristics/1.performance-oriented.md diff --git a/docs/en-US/source/2.introduction/4.characteristics/2.multi-level-Interfaces.md b/docs/en-US/source/2.introduction/5.characteristics/2.multi-level-Interfaces.md similarity index 100% rename from docs/en-US/source/2.introduction/4.characteristics/2.multi-level-Interfaces.md rename to docs/en-US/source/2.introduction/5.characteristics/2.multi-level-Interfaces.md diff --git a/docs/en-US/source/2.introduction/4.characteristics/3.htap.md b/docs/en-US/source/2.introduction/5.characteristics/3.htap.md similarity index 100% rename from docs/en-US/source/2.introduction/4.characteristics/3.htap.md rename to docs/en-US/source/2.introduction/5.characteristics/3.htap.md diff --git a/docs/en-US/source/2.introduction/4.characteristics/index.rst b/docs/en-US/source/2.introduction/5.characteristics/index.rst similarity index 100% rename from docs/en-US/source/2.introduction/4.characteristics/index.rst rename to docs/en-US/source/2.introduction/5.characteristics/index.rst diff --git a/docs/en-US/source/2.introduction/5.architecture.md b/docs/en-US/source/2.introduction/6.architecture.md similarity index 100% rename from docs/en-US/source/2.introduction/5.architecture.md rename to docs/en-US/source/2.introduction/6.architecture.md diff --git a/docs/en-US/source/2.introduction/6.functionality.md b/docs/en-US/source/2.introduction/7.functionality.md similarity index 100% rename from docs/en-US/source/2.introduction/6.functionality.md rename to docs/en-US/source/2.introduction/7.functionality.md diff --git a/docs/en-US/source/2.introduction/7.scenarios.md b/docs/en-US/source/2.introduction/8.scenarios.md similarity index 100% rename from docs/en-US/source/2.introduction/7.scenarios.md rename to docs/en-US/source/2.introduction/8.scenarios.md diff --git a/docs/en-US/source/2.introduction/8.glossary.md b/docs/en-US/source/2.introduction/9.glossary.md similarity index 100% rename from docs/en-US/source/2.introduction/8.glossary.md rename to docs/en-US/source/2.introduction/9.glossary.md diff --git a/docs/en-US/source/2.introduction/index.rst b/docs/en-US/source/2.introduction/index.rst index a42b1d7c5a..076b7d0434 100644 --- a/docs/en-US/source/2.introduction/index.rst +++ b/docs/en-US/source/2.introduction/index.rst @@ -9,8 +9,9 @@ TuGraph DB Introduction 1.what-is-graph 2.what-is-gdbms 3.what-is-tugraph - 4.characteristics/index.rst - 5.architecture - 6.functionality - 7.scenarios - 8.glossary + 4.schema + 5.characteristics/index.rst + 6.architecture + 7.functionality + 8.scenarios + 9.glossary \ No newline at end of file diff --git a/docs/en-US/source/4.user-guide/1.tugraph-browser.md b/docs/en-US/source/4.user-guide/1.tugraph-browser.md index 8c10946a50..4f44d307fb 100644 --- a/docs/en-US/source/4.user-guide/1.tugraph-browser.md +++ b/docs/en-US/source/4.user-guide/1.tugraph-browser.md @@ -127,7 +127,7 @@ The `Graph Building` function in Browser is mainly used for graph project model Browser provides a visualization way to create and maintain graph models. -- Graph models can also be created and maintained through the `Cypher` tool and the `lgraph_import` tool. For details, please refer to the [Cypher API Document](../5.developer-manual/6.interface/1.query/1.cypher.md) and [Data Import Document](../5.developer-manual/3.server-tools/1.data-import.md). +- Graph models can also be created and maintained through the `Cypher` tool and the `lgraph_import` tool. For details, please refer to the [Cypher API Document](../8.query/1.cypher.md) and [Data Import Document](../6.utility-tools/1.data-import.md). ###### a.Browse Graph Models @@ -309,7 +309,7 @@ Users enter graph query statements in the `Statement Query Window`, click the `E ![query-download-button](../../../images/browser/query-download-button.png) -For detailed Cypher usage guidelines, please refer to the document: [Cypher API](../5.developer-manual/6.interface/1.query/1.cypher.md) +For detailed Cypher usage guidelines, please refer to the document: [Cypher API](../8.query/1.cypher.md) ###### b.Bookmark List @@ -636,7 +636,7 @@ CALL dbms.system.info() ##### 2.5.2.2.Database Configuration Information -`Database Configuration Information` obtains the current configuration parameters of the system and displays key information. To adjust the configuration parameters or understand the detailed configuration parameters, please refer to [Database Running-Service Configuration](../5.developer-manual/2.running/2.tugraph-running.md). +`Database Configuration Information` obtains the current configuration parameters of the system and displays key information. To adjust the configuration parameters or understand the detailed configuration parameters, please refer to [Database Running-Service Configuration](../5.installation&running/7.tugraph-running.md). ![db_configuration](../../../images/browser/db_configuration.png) diff --git a/docs/en-US/source/5.developer-manual/2.running/index.rst b/docs/en-US/source/5.developer-manual/2.running/index.rst deleted file mode 100644 index 6d3b240af9..0000000000 --- a/docs/en-US/source/5.developer-manual/2.running/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -TuGraph DB Running -==================================== - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md b/docs/en-US/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md deleted file mode 100644 index 46afb76206..0000000000 --- a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/3.tugraph-explorer.md +++ /dev/null @@ -1,3 +0,0 @@ -# TuGraph Explorer - -> TuGraph Explorer has merged to [TuGraph Browser](../../4.user-guide/1.tugraph-browser.md) \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/index.rst b/docs/en-US/source/5.developer-manual/5.ecosystem-tools/index.rst deleted file mode 100644 index 4be6ec9ad4..0000000000 --- a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -TuGraph DB Ecosystem-Tools -======================================== - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md deleted file mode 100644 index ab5ed72369..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/1.intro.md +++ /dev/null @@ -1,18 +0,0 @@ -# Introduction to ISO GQL - -Graph Query Language (GQL) is an upcoming International Standard language for property graph querying. It builds on the foundations of SQL and integrates proven ideas from the existing [openCypher, PGQL, GSQL, and G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/) languages. The standard is currently in the draft stage. - -TuGraph has implemented GQL based on the [ISO GQL (ISO/IEC 39075) Antlr4 grammar file](https://github.com/TuGraph-family/gql-grammar). It includes some extensions and modifications. Not all GQL syntax is fully supported at the moment, but we will continue to improve and enhance it in the future. - -## List of Clauses - -| Category | Clauses | -| ------------------- | -------------- | -| Reading clauses | MATCH | -| | OPTIONAL MATCH | -| Projecting clauses | RETURN | -| | NEXT | -| Reading sub-clauses | WHERE | -| | ORDER BY | -| | SKIP | -| | LIMIT | diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md deleted file mode 100644 index 99b03a27fd..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/1.match.md +++ /dev/null @@ -1,100 +0,0 @@ -# MATCH - -The `MATCH` clause is the most basic clause in GQL, and almost all queries are expanded through `MATCH`. - -The `MATCH` clause is used to specify the matching pattern to search in the graph, to match vertices or paths that meet certain conditions. - -## Basic Usage - -### Vertex basics - -#### Get all vertices - -``` -MATCH (n) -RETURN n -``` - -#### Get all vertices with a label - -``` -MATCH (n:Person) -RETURN n -``` - -#### Vertex matching with property - -``` -MATCH (n:Person{name:'Michael Redgrave'}) -RETURN n.birthyear -``` - -return -```JSON -[{"n.birthyear":1908}] -``` - -#### Vertex matching with filter - - -``` -MATCH (n:Person WHERE n.birthyear > 1910) -RETURN n.name LIMIT 2 -``` - -return -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` - -### Edge basics - -#### Edge pointing right - -``` -MATCH (n:Person WHERE n.birthyear = 1970)-[e]->(m) -RETURN n.name, label(e), m.name -``` - -return -```JSON -[{"label(e)":"BORN_IN","m.name":"London","n.name":"Christopher Nolan"},{"label(e)":"DIRECTED","m.name":null,"n.name":"Christopher Nolan"}] -``` - -#### Edge pointing left - -``` -MATCH (n:Person WHERE n.birthyear = 1939)<-[e]-(m) -RETURN n.name, label(e), m.name -``` - -return -```JSON -[{"label(e)":"HAS_CHILD","m.name":"Rachel Kempson","n.name":"Corin Redgrave"},{"label(e)":"HAS_CHILD","m.name":"Michael Redgrave","n.name":"Corin Redgrave"}] -``` - -#### Edge matching with filter - -``` -MATCH (n:Person)-[e:BORN_IN WHERE e.weight > 20]->(m) -RETURN n.name, e.weight, m.name -``` - -return -```JSON -[{"e.weight":20.549999237060547,"m.name":"New York","n.name":"John Williams"},{"e.weight":20.6200008392334,"m.name":"New York","n.name":"Lindsay Lohan"}] -``` - -### Path matching - -#### Variable length - -``` -MATCH (n:Person)-[e]->{2,3}(m:Person) -RETURN m.name LIMIT 2 -``` - -return -```JSON -[{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md deleted file mode 100644 index 586676ea16..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/2.optional_match.md +++ /dev/null @@ -1,30 +0,0 @@ -# OPTIONAL MATCH - -The `OPTIONAL MATCH` clause matches a graph pattern and returns `null` if there is no match. - -## Basic Usage - -### Match found - -``` -OPTIONAL MATCH (n:Person{name:'Michael Redgrave'}) -RETURN n.birthyear -``` - -return -```JSON -[{"n.birthyear":1908}] -``` - -### Match Not Found - -``` -OPTIONAL MATCH (n:Person{name:'Redgrave Michael'}) -RETURN n.birthyear -``` - -return - -```JSON -[{"n.birthyear":null}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md deleted file mode 100644 index 3ba96e8a95..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/3.return.md +++ /dev/null @@ -1,110 +0,0 @@ -# RETURN - -The `RETURN` clause specifies the results to be returned, including vertices, edges, paths, properties, etc. - -## Basic Usage - -### Return vertices - -``` -MATCH (n) -RETURN n LIMIT 2 -``` - -return -```JSON -[{"n":{"identity":0,"label":"Person","properties":{"birthyear":1910,"name":"Rachel Kempson"}}},{"n":{"identity":1,"label":"Person","properties":{"birthyear":1908,"name":"Michael Redgrave"}}}] -``` - -### Return edges - -``` -MATCH (n)-[e]->(m) -RETURN e LIMIT 2 -``` - -return - -```JSON -[{"e":{"dst":2,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}},{"e":{"dst":3,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}}] -``` - -### Return property - -``` -MATCH (n:Person) -RETURN n.name LIMIT 2 -``` - -return - -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` - -### Uncommon string used as variable name - -``` -MATCH (`/uncommon variable`:Person) -RETURN `/uncommon variable`.name LIMIT 3 -``` - -return - -```JSON -[{"`/uncommon variable`.name":"Christopher Nolan"},{"`/uncommon variable`.name":"Corin Redgrave"},{"`/uncommon variable`.name":"Dennis Quaid"}] -``` - -### Alias - -``` -MATCH (n:Person) -RETURN n.name AS nname LIMIT 2 -``` - -return - -```JSON -[{"nname":"Christopher Nolan"},{"nname":"Corin Redgrave"}] -``` - -### Optional property - -``` -MATCH (n:Person) -RETURN n.age LIMIT 2 -``` - -return - -```JSON -[{"n.age":null},{"n.age":null}] -``` - -### Other expressions - -``` -MATCH (n:Person) -RETURN n.birthyear > 1970, "I'm a literal", 1 + 2, abs(-2) -LIMIT 2 -``` - -return - -```JSON -[{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false},{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false}] -``` - -### Distinct - - -``` -MATCH (n) -RETURN DISTINCT label(n) AS label -``` - -return - -```JSON -[{"label":"Person"},{"label":"City"},{"label":"Film"}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md deleted file mode 100644 index e6222e5a5f..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/4.next.md +++ /dev/null @@ -1,21 +0,0 @@ -# NEXT - -The `NEXT` clause is used to connect multiple clauses. - -## Basic Usage - -### Connecting MATCH clauses - -``` -MATCH (n:Person) WHERE n.birthyear = 1970 -RETURN n -NEXT -MATCH (m:Person) WHERE m.birthyear < 1968 -RETURN n.name, n.birthyear, m.name LIMIT 2 -``` - -return - -```JSON -[{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md deleted file mode 100644 index 6cd6c67fe5..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/5.where.md +++ /dev/null @@ -1,48 +0,0 @@ -# WHERE - -`WHERE` clause is used to filter records. - -## Baisc Usage - -### Filter vertex - -``` -MATCH (n:Person WHERE n.birthyear > 1965) -RETURN n.name -``` - -returns -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Lindsay Lohan"}] -``` - -### Filter edge - -``` -MATCH (n:Person WHERE n.birthyear > 1965)-[e:ACTED_IN]->(m:Film) -WHERE e.charactername = 'Halle/Annie' -RETURN m.title -``` - -returns - -```JSON -[{"m.title":"The Parent Trap"}] -``` - -### Boolean expressions - -`AND`, `OR`, `XOR`, and `NOT` Boolean expressions can be used in the `WHERE` clause to filter data. - -``` -MATCH (n:Person) -WHERE - n.birthyear > 1930 AND (n.birthyear < 1950 OR n.name = 'Corin Redgrave') -RETURN n LIMIT 2 -``` - -returns - -```JSON -[{"n":{"identity":3,"label":"Person","properties":{"birthyear":1939,"name":"Corin Redgrave"}}},{"n":{"identity":11,"label":"Person","properties":{"birthyear":1932,"name":"John Williams"}}}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md deleted file mode 100644 index 543270a624..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/6.orderby.md +++ /dev/null @@ -1,19 +0,0 @@ -# ORDER BY - -`ORDER BY` is a clause of `RETURN` that sorts the output result. - -## Basic Usage - -### Sorting the Result - -``` -MATCH (n:Person WHERE n.birthyear < 1970) -RETURN n.birthyear AS q -ORDER BY q ASC -LIMIT 5 -``` - -return -```JSON -[{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md deleted file mode 100644 index 16d6dbb2b7..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/7.skip.md +++ /dev/null @@ -1,30 +0,0 @@ -# SKIP - -`SKIP` specifies the offset of the result rows. - -## Baisc Usage - -### Without SKIP - -``` -MATCH (n:Person) -RETURN n.name LIMIT 3 -``` - -return - -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] -``` - -### Using SKIP - -``` -MATCH (n:Person) -RETURN n.name SKIP 1 LIMIT 2 -``` - -return -```JSON -[{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md deleted file mode 100644 index 87a9e6f734..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/8.limit.md +++ /dev/null @@ -1,17 +0,0 @@ -# LIMIT - -The `LIMIT` clause is used to limit the number of rows in the result. - -## Basic Usage - -### Using LIMIT - -``` -MATCH (n:Person) -RETURN n.name LIMIT 2; -``` - -return -```JSON -[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] -``` diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst deleted file mode 100644 index e2cf9d0346..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/2.clauses/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -GQL Clauses -=========== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/index.rst b/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/index.rst deleted file mode 100644 index e39c0a8e24..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/2.gql/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -GQL -======== - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.intro.md - 2.clauses/index.rst diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst deleted file mode 100644 index abc5ce2ccd..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/1.base64_encode.rst +++ /dev/null @@ -1,5 +0,0 @@ -base64_encode -=================================== - -.. doxygenfile:: base64_encode.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst deleted file mode 100644 index b321c843d6..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/10.lgraph_result.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_result -=================================== - -.. doxygenfile:: lgraph_result.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst deleted file mode 100644 index 0f53077dbc..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/11.lgraph_rpc_client.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_rpc_client -=================================== - -.. doxygenfile:: lgraph_rpc_client.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst deleted file mode 100644 index d7a9d7b97c..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/12.lgraph_traversal.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_traversal -=================================== - -.. doxygenfile:: lgraph_traversal.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst deleted file mode 100644 index 4b0be46a21..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/13.lgraph_txn.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_txn -=================================== - -.. doxygenfile:: lgraph_txn.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst deleted file mode 100644 index 4047340ef0..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/14.lgraph_types.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_types -=================================== - -.. doxygenfile:: lgraph_types.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst deleted file mode 100644 index 12814e7618..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/15.lgraph_utils.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_utils -=================================== - -.. doxygenfile:: lgraph_utils.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst deleted file mode 100644 index 572f9ae7c0..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/16.lgraph_vertex_index_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_vertex_index_iterator -=================================== - -.. doxygenfile:: lgraph_vertex_index_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst deleted file mode 100644 index 5bfa8a1dd3..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/17.lgraph_vertex_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_vertex_iterator -=================================== - -.. doxygenfile:: lgraph_vertex_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst deleted file mode 100644 index 8680a93ee9..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/18.olap_base.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_base -=================================== - -.. doxygenfile:: olap_base.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst deleted file mode 100644 index 9ce3afba80..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/19.olap_on_db.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_on_db -=================================== - -.. doxygenfile:: olap_on_db.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst deleted file mode 100644 index 5bed2e061c..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/2.lgraph.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph -=================================== - -.. doxygenfile:: lgraph.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst deleted file mode 100644 index 82bf0941c8..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/20.olap_profile.rst +++ /dev/null @@ -1,5 +0,0 @@ -olap_profile -=================================== - -.. doxygenfile:: olap_profile.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst deleted file mode 100644 index 8723e9f1d0..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/3.lgraph_atomic.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_atomic -=================================== - -.. doxygenfile:: lgraph_atomic.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst deleted file mode 100644 index ec8af7bb8f..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/4.lgraph_date_time.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_date_time -=================================== - -.. doxygenfile:: lgraph_date_time.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst deleted file mode 100644 index 07d6076327..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/5.lgraph_db.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_db -=================================== - -.. doxygenfile:: lgraph_db.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst deleted file mode 100644 index 07f4be3f67..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/6.lgraph_edge_index_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_edge_index_iterator -=================================== - -.. doxygenfile:: lgraph_edge_index_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst deleted file mode 100644 index 5be9e6547e..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/7.lgraph_edge_iterator.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_edge_iterator -=================================== - -.. doxygenfile:: lgraph_edge_iterator.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst deleted file mode 100644 index 70a0bd4cbf..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/8.lgraph_exceptions.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_exceptions -=================================== - -.. doxygenfile:: lgraph_exceptions.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst deleted file mode 100644 index a4f9af0582..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/9.lgraph_galaxy.rst +++ /dev/null @@ -1,5 +0,0 @@ -lgraph_galaxy -=================================== - -.. doxygenfile:: lgraph_galaxy.h - :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst b/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst deleted file mode 100644 index 1c343152d8..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/3.C++-procedure/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -C++ stored procedure API -=================================== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/docs/en-US/source/5.developer-manual/1.installation/1.environment.md b/docs/en-US/source/5.installation&running/1.environment.md similarity index 100% rename from docs/en-US/source/5.developer-manual/1.installation/1.environment.md rename to docs/en-US/source/5.installation&running/1.environment.md diff --git a/docs/en-US/source/5.developer-manual/1.installation/2.environment-mode.md b/docs/en-US/source/5.installation&running/2.environment-mode.md similarity index 100% rename from docs/en-US/source/5.developer-manual/1.installation/2.environment-mode.md rename to docs/en-US/source/5.installation&running/2.environment-mode.md diff --git a/docs/en-US/source/5.developer-manual/1.installation/3.docker-deployment.md b/docs/en-US/source/5.installation&running/3.docker-deployment.md similarity index 97% rename from docs/en-US/source/5.developer-manual/1.installation/3.docker-deployment.md rename to docs/en-US/source/5.installation&running/3.docker-deployment.md index f90475b285..b664276b7d 100644 --- a/docs/en-US/source/5.developer-manual/1.installation/3.docker-deployment.md +++ b/docs/en-US/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ The images are hosted on [DockerHub]( https://hub.docker.com/u/tugraph ) and can be downloaded and used directly. -For the latest version of Docker address, see [Link](../../1.guide.md#TuGraph-Latest-Version). +For the latest version of Docker address, see [Link](../1.guide.md). ### 2.2.Naming Convention diff --git a/docs/en-US/source/5.developer-manual/1.installation/4.local-package-deployment.md b/docs/en-US/source/5.installation&running/4.local-package-deployment.md similarity index 100% rename from docs/en-US/source/5.developer-manual/1.installation/4.local-package-deployment.md rename to docs/en-US/source/5.installation&running/4.local-package-deployment.md diff --git a/docs/en-US/source/5.developer-manual/1.installation/5.cloud-deployment.md b/docs/en-US/source/5.installation&running/5.cloud-deployment.md similarity index 93% rename from docs/en-US/source/5.developer-manual/1.installation/5.cloud-deployment.md rename to docs/en-US/source/5.installation&running/5.cloud-deployment.md index 9551dc6e32..77bfda5171 100644 --- a/docs/en-US/source/5.developer-manual/1.installation/5.cloud-deployment.md +++ b/docs/en-US/source/5.installation&running/5.cloud-deployment.md @@ -36,7 +36,7 @@ Before starting to use, you need an Alibaba Cloud account to access and create r | AliyunComputeNestUserFullAccess | Permissions for managing ComputeNest services (ComputeNest) on the user side | | AliyunCloudMonitorFullAccess | Permissions for managing Alibaba Cloud Monitor (CloudMonitor) | -![Cloud Deployment](../../../../images/cloud-deployment-1.png) +![Cloud Deployment](../../../images/cloud-deployment-1.png) ### 3.2.Deployment Entrance @@ -48,7 +48,7 @@ You can search in Alibaba Cloud ComputeNest, or quickly access it through the fo Before formal trial use, you need to apply for trial use, fill in the information as prompted, and create the TuGraph service after passing the review. -![Apply for Trial Use](../../../../images/cloud-deployment-2.png) +![Apply for Trial Use](../../../images/cloud-deployment-2.png) ### 3.4.Create TuGraph Service @@ -75,38 +75,38 @@ The creation of the service is carried out according to the following steps, ref - Create an instance name, such as "test" in the figure below - Select the region, such as "China East 1 (Hangzhou)" in the figure below -![Create Instance](../../../../images/cloud-deployment-3.png) +![Create Instance](../../../images/cloud-deployment-3.png) - Select the instance type, currently supports ecs.r6.xlarge and ecs.r7a.xlarge specifications. If there is no model available in the list, try selecting other deployment areas. - Select the model - Configure the password for the instance - Select the deployment area, such as "Availability Zone I" in the figure below -![Select Region](../../../../images/cloud-deployment-4.png) +![Select Region](../../../images/cloud-deployment-4.png) - Click next to enter the order confirmation page - Check the checkboxes for "Permission Confirmation" and "Service Terms" - Click the green "Start Free Trial" button in the lower left corner to create a service instance -![Confirmation](../../../../images/cloud-deployment-5.png) +![Confirmation](../../../images/cloud-deployment-5.png) ### 3.5.Start TuGraph Service - View the service instance: After the service instance is created successfully, it takes about 2 minutes for deployment. After the deployment is complete, you can see the corresponding service instance on the page, as shown in the figure below. -![View Instance](../../../../images/cloud-deployment-6.png) +![View Instance](../../../images/cloud-deployment-6.png) - Click the service instance to access TuGraph. After entering the corresponding service instance, you can get 3 ways to use it on the page: web, rpc, ssh. You can also see the password of user admin on the page. -![Access Method](../../../../images/cloud-deployment-7.png) +![Access Method](../../../images/cloud-deployment-7.png) - Click the link of web to jump to the deployed TuGraph Web. It is recommended that novice users first use the demo to quickly get started with TuGraph. - First, on the TuGraph Web login page, enter the default username (admin) and the password on the page to log in, as shown in the figure below. - After the login is completed, click "New Instance" -> "Create Instance" in sequence, wait for the creation to be completed, and the steps in 3 will change to green in turn, and it will automatically switch to the subgraph MovieDemo1, as shown in the figure below. -![Login](../../../../images/cloud-deployment-8.png) -![Create Demo](../../../../images/cloud-deployment-9.png) +![Login](../../../images/cloud-deployment-8.png) +![Create Demo](../../../images/cloud-deployment-9.png) ## 4.Common FAQs @@ -114,7 +114,7 @@ The creation of the service is carried out according to the following steps, ref Sometimes, the selected deployment area (such as Availability Zone G) does not have available resources for the selected package, and an error will be reported as shown in the figure below. -![Deployment Error](../../../../images/cloud-deployment-10.png) +![Deployment Error](../../../images/cloud-deployment-10.png) __Solution__:Try selecting other regions, such as Availability Zone I diff --git a/docs/en-US/source/5.developer-manual/2.running/1.compile.md b/docs/en-US/source/5.installation&running/6.compile.md similarity index 92% rename from docs/en-US/source/5.developer-manual/2.running/1.compile.md rename to docs/en-US/source/5.installation&running/6.compile.md index eef4998270..2f28bee61e 100644 --- a/docs/en-US/source/5.developer-manual/2.running/1.compile.md +++ b/docs/en-US/source/5.installation&running/6.compile.md @@ -4,7 +4,7 @@ ## 1.Prerequisites -It is recommended to build TuGraph on a Linux system. Meanwhile, Docker is a good choice. If you want to set up a new environment, please refer to [Dockerfile](../1.installation/3.docker-deployment.md)。 +It is recommended to build TuGraph on a Linux system. Meanwhile, Docker is a good choice. If you want to set up a new environment, please refer to [Dockerfile](3.docker-deployment.md)。 ## 2.compile diff --git a/docs/en-US/source/5.developer-manual/2.running/2.tugraph-running.md b/docs/en-US/source/5.installation&running/7.tugraph-running.md similarity index 99% rename from docs/en-US/source/5.developer-manual/2.running/2.tugraph-running.md rename to docs/en-US/source/5.installation&running/7.tugraph-running.md index b852e20570..77709ba0cb 100644 --- a/docs/en-US/source/5.developer-manual/2.running/2.tugraph-running.md +++ b/docs/en-US/source/5.installation&running/7.tugraph-running.md @@ -3,7 +3,7 @@ > This document describes the operation mode of the TuGraph service, starting, stopping, and restarting operations.And TuGraph's service configuration parameters, configuration file format, and command-line configuration parameters. ## 1. Prerequisites -TuGraph has the following prerequisites for its execution: a correct [installation of TuGraph](../1.installation/1.environment.md). +TuGraph has the following prerequisites for its execution: a correct [installation of TuGraph](1.environment.md). TuGraph execution requires ensuring that the library file "liblgraph.so" is located in the environment variable LD_LIBRARY_PATH. diff --git a/docs/en-US/source/5.developer-manual/2.running/3.high-availability-mode.md b/docs/en-US/source/5.installation&running/8.high-availability-mode.md similarity index 99% rename from docs/en-US/source/5.developer-manual/2.running/3.high-availability-mode.md rename to docs/en-US/source/5.installation&running/8.high-availability-mode.md index 5d22c81b36..4f363b5a53 100644 --- a/docs/en-US/source/5.developer-manual/2.running/3.high-availability-mode.md +++ b/docs/en-US/source/5.installation&running/8.high-availability-mode.md @@ -26,7 +26,7 @@ To enable high availability mode, users need to: ## 3.Start the initial backup group -After installing TuGraph, you can use the `lgraph_server` command to start a high-availability cluster on different machines. This section mainly explains how to start a high-availability cluster. For cluster status management after startup, see [lgraph_peer tool](../3.server-tools/5.ha-cluster-management.md) +After installing TuGraph, you can use the `lgraph_server` command to start a high-availability cluster on different machines. This section mainly explains how to start a high-availability cluster. For cluster status management after startup, see [lgraph_peer tool](../6.utility-tools/5.ha-cluster-management.md) ### 3.1.The initial data is consistent diff --git a/docs/en-US/source/5.developer-manual/1.installation/index.rst b/docs/en-US/source/5.installation&running/index.rst similarity index 61% rename from docs/en-US/source/5.developer-manual/1.installation/index.rst rename to docs/en-US/source/5.installation&running/index.rst index 9bf6be2bc6..bf30d63598 100644 --- a/docs/en-US/source/5.developer-manual/1.installation/index.rst +++ b/docs/en-US/source/5.installation&running/index.rst @@ -1,8 +1,9 @@ -TuGraph DB Installation +Installation And Running ================================ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/1.data-import.md b/docs/en-US/source/6.utility-tools/1.data-import.md similarity index 100% rename from docs/en-US/source/5.developer-manual/3.server-tools/1.data-import.md rename to docs/en-US/source/6.utility-tools/1.data-import.md diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/2.data-export.md b/docs/en-US/source/6.utility-tools/2.data-export.md similarity index 100% rename from docs/en-US/source/5.developer-manual/3.server-tools/2.data-export.md rename to docs/en-US/source/6.utility-tools/2.data-export.md diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/3.backup-and-restore.md b/docs/en-US/source/6.utility-tools/3.backup-and-restore.md similarity index 100% rename from docs/en-US/source/5.developer-manual/3.server-tools/3.backup-and-restore.md rename to docs/en-US/source/6.utility-tools/3.backup-and-restore.md diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/4.data-warmup.md b/docs/en-US/source/6.utility-tools/4.data-warmup.md similarity index 100% rename from docs/en-US/source/5.developer-manual/3.server-tools/4.data-warmup.md rename to docs/en-US/source/6.utility-tools/4.data-warmup.md diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/5.ha-cluster-management.md b/docs/en-US/source/6.utility-tools/5.ha-cluster-management.md similarity index 100% rename from docs/en-US/source/5.developer-manual/3.server-tools/5.ha-cluster-management.md rename to docs/en-US/source/6.utility-tools/5.ha-cluster-management.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/5.tugraph-cli.md b/docs/en-US/source/6.utility-tools/6.tugraph-cli.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/5.tugraph-cli.md rename to docs/en-US/source/6.utility-tools/6.tugraph-cli.md diff --git a/docs/en-US/source/5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md b/docs/en-US/source/6.utility-tools/7.tugraph-datax.md similarity index 100% rename from docs/en-US/source/5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md rename to docs/en-US/source/6.utility-tools/7.tugraph-datax.md diff --git a/docs/en-US/source/6.utility-tools/8.tugraph-explorer.md b/docs/en-US/source/6.utility-tools/8.tugraph-explorer.md new file mode 100644 index 0000000000..a01cf32e66 --- /dev/null +++ b/docs/en-US/source/6.utility-tools/8.tugraph-explorer.md @@ -0,0 +1,3 @@ +# TuGraph Explorer + +> TuGraph Explorer has merged to [TuGraph Browser](../4.user-guide/1.tugraph-browser.md) \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/3.server-tools/index.rst b/docs/en-US/source/6.utility-tools/index.rst similarity index 64% rename from docs/en-US/source/5.developer-manual/3.server-tools/index.rst rename to docs/en-US/source/6.utility-tools/index.rst index d2d7ed7240..8519247cc9 100644 --- a/docs/en-US/source/5.developer-manual/3.server-tools/index.rst +++ b/docs/en-US/source/6.utility-tools/index.rst @@ -1,8 +1,9 @@ -TuGraph DB Server Tools +TuGraph DB Utility Tools ========================================== .. toctree:: :maxdepth: 2 - :glob: - + :caption: Contents: + :glob: + * \ No newline at end of file diff --git a/docs/en-US/source/7.best-practices/1.rdbms-to-tugraph.md b/docs/en-US/source/7.best-practices/1.rdbms-to-tugraph.md deleted file mode 100644 index 6d9e4c58a5..0000000000 --- a/docs/en-US/source/7.best-practices/1.rdbms-to-tugraph.md +++ /dev/null @@ -1,3 +0,0 @@ -# Importing Data from Relational Databases to TuGraph - -> Using [DataX](../5.developer-manual/5.ecosystem-tools/2.tugraph-datax.md),to be completed. \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/1.python-client.md b/docs/en-US/source/7.client-tools/1.python-client.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/1.python-client.md rename to docs/en-US/source/7.client-tools/1.python-client.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/2.cpp-client.md b/docs/en-US/source/7.client-tools/2.cpp-client.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/2.cpp-client.md rename to docs/en-US/source/7.client-tools/2.cpp-client.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/3.java-client.md b/docs/en-US/source/7.client-tools/3.java-client.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/3.java-client.md rename to docs/en-US/source/7.client-tools/3.java-client.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/4.tugraph-ogm.md b/docs/en-US/source/7.client-tools/4.tugraph-ogm.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/4.tugraph-ogm.md rename to docs/en-US/source/7.client-tools/4.tugraph-ogm.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/6.bolt-client.md b/docs/en-US/source/7.client-tools/5.bolt-client.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/6.bolt-client.md rename to docs/en-US/source/7.client-tools/5.bolt-client.md diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/7.bolt-console-client.md b/docs/en-US/source/7.client-tools/6.bolt-console-client.md similarity index 100% rename from docs/en-US/source/5.developer-manual/4.client-tools/7.bolt-console-client.md rename to docs/en-US/source/7.client-tools/6.bolt-console-client.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/3.restful-api.md b/docs/en-US/source/7.client-tools/7.restful-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/4.protocol/3.restful-api.md rename to docs/en-US/source/7.client-tools/7.restful-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/2.rpc-api.md b/docs/en-US/source/7.client-tools/8.rpc-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/4.protocol/2.rpc-api.md rename to docs/en-US/source/7.client-tools/8.rpc-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md b/docs/en-US/source/7.client-tools/9.restful-api-legacy.md similarity index 99% rename from docs/en-US/source/5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md rename to docs/en-US/source/7.client-tools/9.restful-api-legacy.md index 3bc8acf78b..3ecfbae4cf 100644 --- a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/1.restful-api-legacy.md +++ b/docs/en-US/source/7.client-tools/9.restful-api-legacy.md @@ -1,4 +1,4 @@ -# TuGraph RESTful API +# TuGraph RESTful API Legacy > This document describes how to call the Rest API of TuGrpah. @@ -2558,7 +2558,7 @@ Create an index on a (label, field) pair. Blocks until the index is successfully | continue_on_error | whether to continue import when an error occurred (optional, default is `false`) | Bool | | delimiter | delimiter used in the data file (optional, default is `“,”`) | String | -The details of the `description` field can be found in [TuGraph Import Tool](../../3.server-tools/1.data-import.md). +The details of the `description` field can be found in [TuGraph Import Tool](../6.utility-tools/1.data-import.md). `delimiter` can be a single character or multi-character string, but must not contain `\r` or `\n`. diff --git a/docs/en-US/source/5.developer-manual/4.client-tools/index.rst b/docs/en-US/source/7.client-tools/index.rst similarity index 82% rename from docs/en-US/source/5.developer-manual/4.client-tools/index.rst rename to docs/en-US/source/7.client-tools/index.rst index f9acd8d9e1..8a5a18add0 100644 --- a/docs/en-US/source/5.developer-manual/4.client-tools/index.rst +++ b/docs/en-US/source/7.client-tools/index.rst @@ -3,6 +3,7 @@ TuGraph DB Client Tools .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/1.cypher.md b/docs/en-US/source/8.query/1.cypher.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/1.query/1.cypher.md rename to docs/en-US/source/8.query/1.cypher.md diff --git a/docs/en-US/source/8.query/2.gql.md b/docs/en-US/source/8.query/2.gql.md new file mode 100644 index 0000000000..cac0752a99 --- /dev/null +++ b/docs/en-US/source/8.query/2.gql.md @@ -0,0 +1,400 @@ +# ISO GQL + + +## 1.Introduction to ISO GQL + +Graph Query Language (GQL) is an upcoming International Standard language for property graph querying. It builds on the foundations of SQL and integrates proven ideas from the existing [openCypher, PGQL, GSQL, and G-CORE](https://gql.today/comparing-cypher-pgql-and-g-core/) languages. The standard is currently in the draft stage. + +TuGraph has implemented GQL based on the [ISO GQL (ISO/IEC 39075) Antlr4 grammar file](https://github.com/TuGraph-family/gql-grammar). It includes some extensions and modifications. Not all GQL syntax is fully supported at the moment, but we will continue to improve and enhance it in the future. + +## 2.List of Clauses +- [2.1.MATCH](#MATCH) +- [2.2.OPTIONAL MATCH](#OPTIONAL) +- [2.3.RETURN](#RETURN) +- [2.4.NEXT](#NEXT) +- [2.5.WHERE](#WHERE) +- [2.6.ORDER BY](#ORDER) +- [2.7.SKIP](#SKIP) +- [2.8.LIMIT](#LIMIT) + +| Category | Clauses | +| ------------------- | -------------- | +| Reading clauses | MATCH | +| | OPTIONAL MATCH | +| Projecting clauses | RETURN | +| | NEXT | +| Reading sub-clauses | WHERE | +| | ORDER BY | +| | SKIP | +| | LIMIT | + + +### 2.1.MATCH + +The `MATCH` clause is the most basic clause in GQL, and almost all queries are expanded through `MATCH`. + +The `MATCH` clause is used to specify the matching pattern to search in the graph, to match vertices or paths that meet certain conditions. + + +#### Vertex basics + +##### Get all vertices + +``` +MATCH (n) +RETURN n +``` + +##### Get all vertices with a label + +``` +MATCH (n:Person) +RETURN n +``` + +##### Vertex matching with property + +``` +MATCH (n:Person{name:'Michael Redgrave'}) +RETURN n.birthyear +``` + +return +```JSON +[{"n.birthyear":1908}] +``` + +##### Vertex matching with filter + + +``` +MATCH (n:Person WHERE n.birthyear > 1910) +RETURN n.name LIMIT 2 +``` + +return +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` + +#### Edge basics + +##### Edge pointing right + +``` +MATCH (n:Person WHERE n.birthyear = 1970)-[e]->(m) +RETURN n.name, label(e), m.name +``` + +return +```JSON +[{"label(e)":"BORN_IN","m.name":"London","n.name":"Christopher Nolan"},{"label(e)":"DIRECTED","m.name":null,"n.name":"Christopher Nolan"}] +``` + +##### Edge pointing left + +``` +MATCH (n:Person WHERE n.birthyear = 1939)<-[e]-(m) +RETURN n.name, label(e), m.name +``` + +return +```JSON +[{"label(e)":"HAS_CHILD","m.name":"Rachel Kempson","n.name":"Corin Redgrave"},{"label(e)":"HAS_CHILD","m.name":"Michael Redgrave","n.name":"Corin Redgrave"}] +``` + +##### Edge matching with filter + +``` +MATCH (n:Person)-[e:BORN_IN WHERE e.weight > 20]->(m) +RETURN n.name, e.weight, m.name +``` + +return +```JSON +[{"e.weight":20.549999237060547,"m.name":"New York","n.name":"John Williams"},{"e.weight":20.6200008392334,"m.name":"New York","n.name":"Lindsay Lohan"}] +``` + +#### Path matching + +##### Variable length + +``` +MATCH (n:Person)-[e]->{2,3}(m:Person) +RETURN m.name LIMIT 2 +``` + +return +```JSON +[{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] +``` + +### 2.2.OPTIONAL MATCH + +The `OPTIONAL MATCH` clause matches a graph pattern and returns `null` if there is no match. + + +#### Match found + +``` +OPTIONAL MATCH (n:Person{name:'Michael Redgrave'}) +RETURN n.birthyear +``` + +return +```JSON +[{"n.birthyear":1908}] +``` + +#### Match Not Found + +``` +OPTIONAL MATCH (n:Person{name:'Redgrave Michael'}) +RETURN n.birthyear +``` + +return + +```JSON +[{"n.birthyear":null}] +``` + +### 2.3.RETURN + +The `RETURN` clause specifies the results to be returned, including vertices, edges, paths, properties, etc. + +#### Return vertices + +``` +MATCH (n) +RETURN n LIMIT 2 +``` + +return +```JSON +[{"n":{"identity":0,"label":"Person","properties":{"birthyear":1910,"name":"Rachel Kempson"}}},{"n":{"identity":1,"label":"Person","properties":{"birthyear":1908,"name":"Michael Redgrave"}}}] +``` + +#### Return edges + +``` +MATCH (n)-[e]->(m) +RETURN e LIMIT 2 +``` + +return + +```JSON +[{"e":{"dst":2,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}},{"e":{"dst":3,"forward":false,"identity":0,"label":"HAS_CHILD","label_id":0,"src":0,"temporal_id":0}}] +``` + +#### Return property + +``` +MATCH (n:Person) +RETURN n.name LIMIT 2 +``` + +return + +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` + +#### Uncommon string used as variable name + +``` +MATCH (`/uncommon variable`:Person) +RETURN `/uncommon variable`.name LIMIT 3 +``` + +return + +```JSON +[{"`/uncommon variable`.name":"Christopher Nolan"},{"`/uncommon variable`.name":"Corin Redgrave"},{"`/uncommon variable`.name":"Dennis Quaid"}] +``` + +#### Alias + +``` +MATCH (n:Person) +RETURN n.name AS nname LIMIT 2 +``` + +return + +```JSON +[{"nname":"Christopher Nolan"},{"nname":"Corin Redgrave"}] +``` + +#### Optional property + +``` +MATCH (n:Person) +RETURN n.age LIMIT 2 +``` + +return + +```JSON +[{"n.age":null},{"n.age":null}] +``` + +#### Other expressions + +``` +MATCH (n:Person) +RETURN n.birthyear > 1970, "I'm a literal", 1 + 2, abs(-2) +LIMIT 2 +``` + +return + +```JSON +[{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false},{"\"I'm a literal\"":"I'm a literal","1 + 2":3,"abs(-2)":2,"n.birthyear > 1970":false}] +``` + +#### Distinct + + +``` +MATCH (n) +RETURN DISTINCT label(n) AS label +``` + +return + +```JSON +[{"label":"Person"},{"label":"City"},{"label":"Film"}] +``` + +### 2.4.NEXT + +The `NEXT` clause is used to connect multiple clauses. + +#### Connecting MATCH clauses + +``` +MATCH (n:Person) WHERE n.birthyear = 1970 +RETURN n +NEXT +MATCH (m:Person) WHERE m.birthyear < 1968 +RETURN n.name, n.birthyear, m.name LIMIT 2 +``` + +return + +```JSON +[{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] +``` + +### 2.5.WHERE + +`WHERE` clause is used to filter records. + +#### Filter vertex + +``` +MATCH (n:Person WHERE n.birthyear > 1965) +RETURN n.name +``` + +returns +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Lindsay Lohan"}] +``` + +#### Filter edge + +``` +MATCH (n:Person WHERE n.birthyear > 1965)-[e:ACTED_IN]->(m:Film) +WHERE e.charactername = 'Halle/Annie' +RETURN m.title +``` + +returns + +```JSON +[{"m.title":"The Parent Trap"}] +``` + +#### Boolean expressions + +`AND`, `OR`, `XOR`, and `NOT` Boolean expressions can be used in the `WHERE` clause to filter data. + +``` +MATCH (n:Person) +WHERE + n.birthyear > 1930 AND (n.birthyear < 1950 OR n.name = 'Corin Redgrave') +RETURN n LIMIT 2 +``` + +returns + +```JSON +[{"n":{"identity":3,"label":"Person","properties":{"birthyear":1939,"name":"Corin Redgrave"}}},{"n":{"identity":11,"label":"Person","properties":{"birthyear":1932,"name":"John Williams"}}}] +``` + +### 2.6.ORDER BY + +`ORDER BY` is a clause of `RETURN` that sorts the output result. + +#### Sorting the Result + +``` +MATCH (n:Person WHERE n.birthyear < 1970) +RETURN n.birthyear AS q +ORDER BY q ASC +LIMIT 5 +``` + +return +```JSON +[{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] +``` + +### 2.7.SKIP + +`SKIP` specifies the offset of the result rows. + +#### Without SKIP + +``` +MATCH (n:Person) +RETURN n.name LIMIT 3 +``` + +return + +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] +``` + +#### Using SKIP + +``` +MATCH (n:Person) +RETURN n.name SKIP 1 LIMIT 2 +``` + +return +```JSON +[{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] +``` + +### 2.8.LIMIT + +The `LIMIT` clause is used to limit the number of rows in the result. + +#### Using LIMIT + +``` +MATCH (n:Person) +RETURN n.name LIMIT 2; +``` + +return +```JSON +[{"n.name":"Christopher Nolan"},{"n.name":"Corin Redgrave"}] +``` + diff --git a/docs/en-US/source/5.developer-manual/6.interface/1.query/index.rst b/docs/en-US/source/8.query/index.rst similarity index 52% rename from docs/en-US/source/5.developer-manual/6.interface/1.query/index.rst rename to docs/en-US/source/8.query/index.rst index c430670454..5e736c4232 100644 --- a/docs/en-US/source/5.developer-manual/6.interface/1.query/index.rst +++ b/docs/en-US/source/8.query/index.rst @@ -1,9 +1,9 @@ Query -======== +=============== .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: - 1.cypher.md - 2.gql/index.rst + * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/1.procedure.md b/docs/en-US/source/9.olap&procedure/1.procedure/1.procedure.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/1.procedure.md rename to docs/en-US/source/9.olap&procedure/1.procedure/1.procedure.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/2.traversal.md b/docs/en-US/source/9.olap&procedure/1.procedure/2.traversal.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/2.traversal.md rename to docs/en-US/source/9.olap&procedure/1.procedure/2.traversal.md diff --git a/docs/en-US/source/9.olap&procedure/1.procedure/3.C++-procedure.rst b/docs/en-US/source/9.olap&procedure/1.procedure/3.C++-procedure.rst new file mode 100644 index 0000000000..8fde487168 --- /dev/null +++ b/docs/en-US/source/9.olap&procedure/1.procedure/3.C++-procedure.rst @@ -0,0 +1,128 @@ +C++ Stored Procedures +==================================== + +.. toctree:: + :maxdepth: 2 + + + + +base64_encode +------------------ + +.. doxygenfile:: base64_encode.h + :project: cpp_procedure + +lgraph +------------------ + +.. doxygenfile:: lgraph.h + :project: cpp_procedure + +lgraph_atomic +------------------ + +.. doxygenfile:: lgraph_atomic.h + :project: cpp_procedure + +lgraph_date_time +------------------ + +.. doxygenfile:: lgraph_date_time.h + :project: cpp_procedure + +lgraph_db +------------------ + +.. doxygenfile:: lgraph_db.h + :project: cpp_procedure + +lgraph_edge_index_iterator +------------------ + +.. doxygenfile:: lgraph_edge_index_iterator.h + :project: cpp_procedure + +lgraph_edge_iterator +------------------ + +.. doxygenfile:: lgraph_edge_iterator.h + :project: cpp_procedure + +lgraph_exceptions +------------------ + +.. doxygenfile:: lgraph_exceptions.h + :project: cpp_procedure + +lgraph_galaxy +------------------ + +.. doxygenfile:: lgraph_galaxy.h + :project: cpp_procedure + +lgraph_result +------------------ + +.. doxygenfile:: lgraph_result.h + :project: cpp_procedure + +lgraph_rpc_client +------------------ + +.. doxygenfile:: lgraph_rpc_client.h + :project: cpp_procedure + +lgraph_traversal +------------------ + +.. doxygenfile:: lgraph_traversal.h + :project: cpp_procedure + +lgraph_txn +------------------ + +.. doxygenfile:: lgraph_txn.h + :project: cpp_procedure + +lgraph_types +------------------ + +.. doxygenfile:: lgraph_types.h + :project: cpp_procedure + +lgraph_utils +------------------ + +.. doxygenfile:: lgraph_utils.h + :project: cpp_procedure + +lgraph_vertex_index_iterator +------------------ + +.. doxygenfile:: lgraph_vertex_index_iterator.h + :project: cpp_procedure + +lgraph_vertex_iterator +------------------ + +.. doxygenfile:: lgraph_vertex_iterator.h + :project: cpp_procedure + +olap_base +------------------ + +.. doxygenfile:: olap_base.h + :project: cpp_procedure + +olap_on_db +------------------ + +.. doxygenfile:: olap_on_db.h + :project: cpp_procedure + +olap_profile +------------------ + +.. doxygenfile:: olap_profile.h + :project: cpp_procedure \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst b/docs/en-US/source/9.olap&procedure/1.procedure/4.Python-procedure.rst similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst rename to docs/en-US/source/9.olap&procedure/1.procedure/4.Python-procedure.rst diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/5.Rust-procedure.md b/docs/en-US/source/9.olap&procedure/1.procedure/5.Rust-procedure.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/5.Rust-procedure.md rename to docs/en-US/source/9.olap&procedure/1.procedure/5.Rust-procedure.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/Doxyfile b/docs/en-US/source/9.olap&procedure/1.procedure/Doxyfile similarity index 99% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/Doxyfile rename to docs/en-US/source/9.olap&procedure/1.procedure/Doxyfile index b8026d7dce..1642b379b5 100644 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/Doxyfile +++ b/docs/en-US/source/9.olap&procedure/1.procedure/Doxyfile @@ -771,7 +771,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../../../../../include/lgraph +INPUT = ../../../../../include/lgraph # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/index.rst b/docs/en-US/source/9.olap&procedure/1.procedure/index.rst similarity index 85% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/index.rst rename to docs/en-US/source/9.olap&procedure/1.procedure/index.rst index 9dee2a39b9..22403ca19e 100644 --- a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/index.rst +++ b/docs/en-US/source/9.olap&procedure/1.procedure/index.rst @@ -7,6 +7,6 @@ Stored Procedures 1.procedure.md 2.traversal.md - 3.C++-procedure/index.rst + 3.C++-procedure.rst 4.Python-procedure.rst 5.Rust-procedure.md \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/3.procedure/index.rst.aci b/docs/en-US/source/9.olap&procedure/1.procedure/index.rst.aci similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/3.procedure/index.rst.aci rename to docs/en-US/source/9.olap&procedure/1.procedure/index.rst.aci diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/1.tutorial.md b/docs/en-US/source/9.olap&procedure/2.olap/1.tutorial.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/1.tutorial.md rename to docs/en-US/source/9.olap&procedure/2.olap/1.tutorial.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/2.olap-base-api.md b/docs/en-US/source/9.olap&procedure/2.olap/2.olap-base-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/2.olap-base-api.md rename to docs/en-US/source/9.olap&procedure/2.olap/2.olap-base-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/3.olap-on-db-api.md b/docs/en-US/source/9.olap&procedure/2.olap/3.olap-on-db-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/3.olap-on-db-api.md rename to docs/en-US/source/9.olap&procedure/2.olap/3.olap-on-db-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/4.olap-on-disk-api.md b/docs/en-US/source/9.olap&procedure/2.olap/4.olap-on-disk-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/4.olap-on-disk-api.md rename to docs/en-US/source/9.olap&procedure/2.olap/4.olap-on-disk-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/5.python-api.md b/docs/en-US/source/9.olap&procedure/2.olap/5.python-api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/5.python-api.md rename to docs/en-US/source/9.olap&procedure/2.olap/5.python-api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/6.algorithms.md b/docs/en-US/source/9.olap&procedure/2.olap/6.algorithms.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/6.algorithms.md rename to docs/en-US/source/9.olap&procedure/2.olap/6.algorithms.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/2.olap/index.rst b/docs/en-US/source/9.olap&procedure/2.olap/index.rst similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/2.olap/index.rst rename to docs/en-US/source/9.olap&procedure/2.olap/index.rst diff --git a/docs/en-US/source/5.developer-manual/6.interface/5.learn/1.tutorial.md b/docs/en-US/source/9.olap&procedure/3.learn/1.tutorial.md similarity index 95% rename from docs/en-US/source/5.developer-manual/6.interface/5.learn/1.tutorial.md rename to docs/en-US/source/9.olap&procedure/3.learn/1.tutorial.md index b1b1474940..689128d8a0 100644 --- a/docs/en-US/source/5.developer-manual/6.interface/5.learn/1.tutorial.md +++ b/docs/en-US/source/9.olap&procedure/3.learn/1.tutorial.md @@ -12,10 +12,10 @@ After sampling, the obtained training data can be used to train a model that can ## 2. Run Process The TuGraph graph learning module samples graph data in TuGraph, and the sampled vertices and edges are used as graph learning features for learning and training. The operation process is shown in the figure below: -![Alt text](../../../../../images/learn_flow_chart_en.png) +![Alt text](../../../../images/learn_flow_chart_en.png) ## 3. TuGraph compilation and data preparation -For TuGraph compilation, please refer to: [Compile](../../../5.developer-manual/2.running/1.compile.md) +For TuGraph compilation, please refer to: [Compile](../../5.installation&running/6.compile.md) Execute in the build/output directory: ```bash cp -r ../../test/integration/data/ ./ && cp -r ../../learn/examples/* ./ @@ -24,7 +24,7 @@ cp -r ../../test/integration/data/ ./ && cp -r ../../learn/examples/* ./ This command copies the relevant files of the dataset to the build/output directory. ## 4. Data Import -Please refer to [Data Import](../../../5.developer-manual/3.server-tools/1.data-import.md) for data import. +Please refer to [Data Import](../../6.utility-tools/1.data-import.md) for data import. Taking the cora dataset as an example for the import process: diff --git a/docs/en-US/source/5.developer-manual/6.interface/5.learn/2.sampling_api.md b/docs/en-US/source/9.olap&procedure/3.learn/2.sampling_api.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/5.learn/2.sampling_api.md rename to docs/en-US/source/9.olap&procedure/3.learn/2.sampling_api.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/5.learn/3.training.md b/docs/en-US/source/9.olap&procedure/3.learn/3.training.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/5.learn/3.training.md rename to docs/en-US/source/9.olap&procedure/3.learn/3.training.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/5.learn/4.heterogeneous_graph.md b/docs/en-US/source/9.olap&procedure/3.learn/4.heterogeneous_graph.md similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/5.learn/4.heterogeneous_graph.md rename to docs/en-US/source/9.olap&procedure/3.learn/4.heterogeneous_graph.md diff --git a/docs/en-US/source/5.developer-manual/6.interface/5.learn/index.rst b/docs/en-US/source/9.olap&procedure/3.learn/index.rst similarity index 100% rename from docs/en-US/source/5.developer-manual/6.interface/5.learn/index.rst rename to docs/en-US/source/9.olap&procedure/3.learn/index.rst diff --git a/docs/en-US/source/9.olap&procedure/index.rst b/docs/en-US/source/9.olap&procedure/index.rst new file mode 100644 index 0000000000..bca6d96c9c --- /dev/null +++ b/docs/en-US/source/9.olap&procedure/index.rst @@ -0,0 +1,11 @@ +Stored Procedures And OLAP +======== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :glob: + + 1.procedure/index.rst + 2.olap/index.rst + 3.learn/index.rst \ No newline at end of file diff --git a/docs/en-US/source/conf.py b/docs/en-US/source/conf.py index 889e5638e5..05950809ea 100644 --- a/docs/en-US/source/conf.py +++ b/docs/en-US/source/conf.py @@ -35,16 +35,16 @@ subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/liblgraph_python_api.so")) subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/liblgraph.so")) subprocess.run(shlex.split("wget https://tugraph-web.oss-cn-beijing.aliyuncs.com/tugraph/doc_deps/libjvm.so")) - sys.path.insert(0, os.path.abspath('5.developer-manual/6.interface/3.procedure/')) + sys.path.insert(0, os.path.abspath('9.olap&procedure/1.procedure/')) # doxygen & breathe extensions.append("breathe") - subprocess.run(shlex.split("doxygen"), cwd="5.developer-manual/6.interface/3.procedure/") - breathe_projects = {"cpp_procedure": "5.developer-manual/6.interface/3.procedure/build/xml"} + subprocess.run(shlex.split("doxygen"), cwd="9.olap&procedure/1.procedure/") + breathe_projects = {"cpp_procedure": "9.olap&procedure/1.procedure/build/xml"} breathe_default_project = "cpp_procedure" else: - if os.path.exists("5.developer-manual/6.interface/3.procedure/3.C++-procedure") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/4.Python-procedure.rst") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/index.rst") and \ - os.path.exists("5.developer-manual/6.interface/3.procedure/index.rst.aci"): - subprocess.run(shlex.split("rm -rf 3.C++-procedure 4.Python-procedure.rst index.rst"), cwd="5.developer-manual/6.interface/3.procedure/") - subprocess.run(shlex.split("mv index.rst.aci index.rst"), cwd="5.developer-manual/6.interface/3.procedure/") + if os.path.exists("9.olap&procedure/1.procedure/3.C++-procedure") and \ + os.path.exists("9.olap&procedure/1.procedure/4.Python-procedure.rst") and \ + os.path.exists("9.olap&procedure/1.procedure/index.rst") and \ + os.path.exists("9.olap&procedure/1.procedure/index.rst.aci"): + subprocess.run(shlex.split("rm -rf 3.C++-procedure 4.Python-procedure.rst index.rst"), cwd="9.olap&procedure/1.procedure/") + subprocess.run(shlex.split("mv index.rst.aci index.rst"), cwd="9.olap&procedure/1.procedure/") diff --git a/docs/en-US/source/index.rst b/docs/en-US/source/index.rst index 25a07bee58..24b08fe10f 100644 --- a/docs/en-US/source/index.rst +++ b/docs/en-US/source/index.rst @@ -10,8 +10,14 @@ TuGraph DB 2.introduction/index.rst 3.quick-start/index.rst 4.user-guide/index.rst - 5.developer-manual/index.rst - 6.contributor-manual/index.rst - 7.best-practices/index.rst - 8.faq.md - 9.contacts.md + 5.installation&running/index.rst + 6.utility-tools/index.rst + 7.client-tools/index.rst + 8.query/index.rst + 9.olap&procedure/index.rst + 10.permission/index.rst + 11.quality/index.rst + 12.contributor-manual/index.rst + 13.best-practices/index.rst + 14.faq.md + 15.contacts.md diff --git a/docs/zh-CN/source/10.permission/2.token.md b/docs/zh-CN/source/10.permission/2.token.md index c8c97b1b04..02e265cf23 100644 --- a/docs/zh-CN/source/10.permission/2.token.md +++ b/docs/zh-CN/source/10.permission/2.token.md @@ -30,7 +30,7 @@ Token有效期存在刷新机制,默认关闭。如果打开后,Token的安 为了方便开发者自行开发,TuGraph提供了两种方式修改有效期,均需要admin权限。 * 通过接口调用设置。涉及有效期修改的接口`update_token_time`和有效期查询接口`get_token_time`。 -具体可查询[REST接口文档](../7.client-tools/10.restful-api-legacy.md)。 +具体可查询[REST接口文档](../7.client-tools/9.restful-api-legacy.md)。 * 通过启动参数设置。server端启动时,添加参数`-unlimited_token 1` 参数可以设置为无期限。可参考[服务运行文档](../5.installation&running/7.tugraph-running.md)。 diff --git a/docs/zh-CN/source/10.permission/index.rst b/docs/zh-CN/source/10.permission/index.rst index 9282406541..e1bbf3066b 100644 --- a/docs/zh-CN/source/10.permission/index.rst +++ b/docs/zh-CN/source/10.permission/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/zh-CN/source/11.quality/index.rst b/docs/zh-CN/source/11.quality/index.rst index 32345a1d33..9b190aa284 100644 --- a/docs/zh-CN/source/11.quality/index.rst +++ b/docs/zh-CN/source/11.quality/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/zh-CN/source/5.installation&running/3.docker-deployment.md b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md index 5f5a3b7232..ab402d7187 100644 --- a/docs/zh-CN/source/5.installation&running/3.docker-deployment.md +++ b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ 镜像托管在[DockerHub]( https://hub.docker.com/u/tugraph ),可直接下载使用。 -最新版本的Docker地址参见 [链接](../1.guide.md#TuGraph最新版本)。 +最新版本的Docker地址参见 [链接](../1.guide.md)。 ### 2.2.命名规范 diff --git a/docs/zh-CN/source/5.installation&running/index.rst b/docs/zh-CN/source/5.installation&running/index.rst index f9adc8f706..5cf35b4240 100644 --- a/docs/zh-CN/source/5.installation&running/index.rst +++ b/docs/zh-CN/source/5.installation&running/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/zh-CN/source/6.utility-tools/index.rst b/docs/zh-CN/source/6.utility-tools/index.rst index 2e0d2c811d..00a7df7efb 100644 --- a/docs/zh-CN/source/6.utility-tools/index.rst +++ b/docs/zh-CN/source/6.utility-tools/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/zh-CN/source/7.client-tools/6.bolt-client.md b/docs/zh-CN/source/7.client-tools/5.bolt-client.md similarity index 100% rename from docs/zh-CN/source/7.client-tools/6.bolt-client.md rename to docs/zh-CN/source/7.client-tools/5.bolt-client.md diff --git a/docs/zh-CN/source/7.client-tools/7.bolt-console-client.md b/docs/zh-CN/source/7.client-tools/6.bolt-console-client.md similarity index 100% rename from docs/zh-CN/source/7.client-tools/7.bolt-console-client.md rename to docs/zh-CN/source/7.client-tools/6.bolt-console-client.md diff --git a/docs/zh-CN/source/7.client-tools/8.restful-api.md b/docs/zh-CN/source/7.client-tools/7.restful-api.md similarity index 100% rename from docs/zh-CN/source/7.client-tools/8.restful-api.md rename to docs/zh-CN/source/7.client-tools/7.restful-api.md diff --git a/docs/zh-CN/source/7.client-tools/9.rpc-api.md b/docs/zh-CN/source/7.client-tools/8.rpc-api.md similarity index 100% rename from docs/zh-CN/source/7.client-tools/9.rpc-api.md rename to docs/zh-CN/source/7.client-tools/8.rpc-api.md diff --git a/docs/zh-CN/source/7.client-tools/10.restful-api-legacy.md b/docs/zh-CN/source/7.client-tools/9.restful-api-legacy.md similarity index 99% rename from docs/zh-CN/source/7.client-tools/10.restful-api-legacy.md rename to docs/zh-CN/source/7.client-tools/9.restful-api-legacy.md index 5568de0cc3..1928d70f07 100644 --- a/docs/zh-CN/source/7.client-tools/10.restful-api-legacy.md +++ b/docs/zh-CN/source/7.client-tools/9.restful-api-legacy.md @@ -1,4 +1,4 @@ -# RESTful API +# RESTful API Legacy > 此文档主要介绍 TuGrpah 的 Rest API 的调用详情。 diff --git a/docs/zh-CN/source/7.client-tools/index.rst b/docs/zh-CN/source/7.client-tools/index.rst index 8d59c09305..f35f8d98d8 100644 --- a/docs/zh-CN/source/7.client-tools/index.rst +++ b/docs/zh-CN/source/7.client-tools/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: * \ No newline at end of file diff --git a/docs/zh-CN/source/9.olap&procedure/index.rst b/docs/zh-CN/source/9.olap&procedure/index.rst index 68c4ddf1ef..ea44ae3734 100644 --- a/docs/zh-CN/source/9.olap&procedure/index.rst +++ b/docs/zh-CN/source/9.olap&procedure/index.rst @@ -3,6 +3,7 @@ .. toctree:: :maxdepth: 2 + :caption: Contents: :glob: 1.procedure/index.rst From 1ac6eec996cd64af5bed83b08e66aa88ad397bba Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Wed, 27 Mar 2024 13:45:55 +0800 Subject: [PATCH 17/28] =?UTF-8?q?=E9=94=9A=E7=82=B9=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../source/5.installation&running/4.local-package-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index ef49670ad5..1f7e4f5b0f 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md/#TuGraph最新版本)。 +最新版本的安装包地址参见 [链接](../../1.guide.md#TuGraph最新版本)。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) From 76a0bdf19bf930c0066f832519d54e62b8a8837b Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 27 Mar 2024 14:25:31 +0800 Subject: [PATCH 18/28] Update 4.local-package-deployment.md --- .../source/5.installation&running/4.local-package-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index 1f7e4f5b0f..66efbc139d 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md#TuGraph最新版本)。 +最新版本的安装包地址参见 ref:`链接 ` 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) From 3573ce46792b585eeec0204d7aca72ab2397fcb0 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 27 Mar 2024 14:29:19 +0800 Subject: [PATCH 19/28] Update 4.local-package-deployment.md --- .../5.installation&running/4.local-package-deployment.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index 66efbc139d..cfd8d6bbde 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,8 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 ref:`链接 ` - +最新版本的安装包地址参见 [链接](../../1.guide.md/#TuGraph最新版本)。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) ## 3. CentOS 下的安装方法 From 7407b7121b0732b0610d73bfc8b95faf8ff25575 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 27 Mar 2024 14:30:28 +0800 Subject: [PATCH 20/28] Update 4.local-package-deployment.md --- .../source/5.installation&running/4.local-package-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index cfd8d6bbde..06caf656b4 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md/#TuGraph最新版本)。 +最新版本的安装包地址参见 [链接](../../1.guide.md)。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) ## 3. CentOS 下的安装方法 From cef8dc0097c7571411b27bd1cb0c39f4f24313d7 Mon Sep 17 00:00:00 2001 From: zhangwh807 <85215001+zhangwh807@users.noreply.github.com> Date: Wed, 27 Mar 2024 14:31:09 +0800 Subject: [PATCH 21/28] Update 4.local-package-deployment.md --- .../source/5.installation&running/4.local-package-deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index 06caf656b4..cfd8d6bbde 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md)。 +最新版本的安装包地址参见 [链接](../../1.guide.md/#TuGraph最新版本)。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) ## 3. CentOS 下的安装方法 From de9dba489f6e9bb5add90f184b9929b805f1447b Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Fri, 29 Mar 2024 16:46:27 +0800 Subject: [PATCH 22/28] =?UTF-8?q?=E4=B8=AD=E8=8B=B1=E6=96=87=E7=9B=AE?= =?UTF-8?q?=E5=BD=95=E7=BB=93=E6=9E=84=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../source/3.quick-start/1.preparation.md | 2 +- .../4.local-package-deployment.md | 2 +- docs/en-US/source/8.query/2.gql.md | 24 +++++++------------ .../source/3.quick-start/1.preparation.md | 2 +- .../4.local-package-deployment.md | 2 +- 5 files changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/en-US/source/3.quick-start/1.preparation.md b/docs/en-US/source/3.quick-start/1.preparation.md index 285a49e2ed..f1cb8eef97 100644 --- a/docs/en-US/source/3.quick-start/1.preparation.md +++ b/docs/en-US/source/3.quick-start/1.preparation.md @@ -45,7 +45,7 @@ _You are advised to use NVMe SSDS with large memory configurations for optimal p TuGraph can be installed quickly via Docker Image or locally via RPM /deb packages.In addition, TuGraph offers community edition services on Alibaba Cloud Computing Nest, which means you don't need to purchase your own cloud host to quickly deploy TuGraph services and achieve operational monitoring, thus building your own graph application. -> Installation package/image download: [Download address](../1.guide.md#TuGraph-Latest-Version). +> Installation package/image download: [Download address](../1.guide.md). > Computing Nest Deployment: You can search for it on Alibaba Cloud Computing Nest, or you can quickly access it through [deployment link] (../5.developer-manual/1.installation/5.cloud-deployment.md). diff --git a/docs/en-US/source/5.installation&running/4.local-package-deployment.md b/docs/en-US/source/5.installation&running/4.local-package-deployment.md index eed64b83e7..ddf4d56f75 100644 --- a/docs/en-US/source/5.installation&running/4.local-package-deployment.md +++ b/docs/en-US/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ If you need to use the complete TuGraph function, please refer to the tugraph-db ## 2. Download the installation package -For the latest version of the installation package address, see [Link](../../1.guide.md/#TuGraphLatest Version). +For the latest version of the installation package address, see [Link](../../1.guide.md). You can also visit Github to download: [TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) diff --git a/docs/en-US/source/8.query/2.gql.md b/docs/en-US/source/8.query/2.gql.md index cac0752a99..ea00f3ceb1 100644 --- a/docs/en-US/source/8.query/2.gql.md +++ b/docs/en-US/source/8.query/2.gql.md @@ -8,14 +8,6 @@ Graph Query Language (GQL) is an upcoming International Standard language for pr TuGraph has implemented GQL based on the [ISO GQL (ISO/IEC 39075) Antlr4 grammar file](https://github.com/TuGraph-family/gql-grammar). It includes some extensions and modifications. Not all GQL syntax is fully supported at the moment, but we will continue to improve and enhance it in the future. ## 2.List of Clauses -- [2.1.MATCH](#MATCH) -- [2.2.OPTIONAL MATCH](#OPTIONAL) -- [2.3.RETURN](#RETURN) -- [2.4.NEXT](#NEXT) -- [2.5.WHERE](#WHERE) -- [2.6.ORDER BY](#ORDER) -- [2.7.SKIP](#SKIP) -- [2.8.LIMIT](#LIMIT) | Category | Clauses | | ------------------- | -------------- | @@ -29,7 +21,7 @@ TuGraph has implemented GQL based on the [ISO GQL (ISO/IEC 39075) Antlr4 grammar | | LIMIT | -### 2.1.MATCH +### 2.1.MATCH The `MATCH` clause is the most basic clause in GQL, and almost all queries are expanded through `MATCH`. @@ -129,7 +121,7 @@ return [{"m.name":"Liam Neeson"},{"m.name":"Natasha Richardson"}] ``` -### 2.2.OPTIONAL MATCH +### 2.2.OPTIONAL MATCH The `OPTIONAL MATCH` clause matches a graph pattern and returns `null` if there is no match. @@ -159,7 +151,7 @@ return [{"n.birthyear":null}] ``` -### 2.3.RETURN +### 2.3.RETURN The `RETURN` clause specifies the results to be returned, including vertices, edges, paths, properties, etc. @@ -268,7 +260,7 @@ return [{"label":"Person"},{"label":"City"},{"label":"Film"}] ``` -### 2.4.NEXT +### 2.4.NEXT The `NEXT` clause is used to connect multiple clauses. @@ -288,7 +280,7 @@ return [{"m.name":"Rachel Kempson","n.birthyear":1970,"n.name":"Christopher Nolan"},{"m.name":"Michael Redgrave","n.birthyear":1970,"n.name":"Christopher Nolan"}] ``` -### 2.5.WHERE +### 2.5.WHERE `WHERE` clause is used to filter records. @@ -335,7 +327,7 @@ returns [{"n":{"identity":3,"label":"Person","properties":{"birthyear":1939,"name":"Corin Redgrave"}}},{"n":{"identity":11,"label":"Person","properties":{"birthyear":1932,"name":"John Williams"}}}] ``` -### 2.6.ORDER BY +### 2.6.ORDER BY `ORDER BY` is a clause of `RETURN` that sorts the output result. @@ -353,7 +345,7 @@ return [{"q":1873},{"q":1908},{"q":1910},{"q":1930},{"q":1932}] ``` -### 2.7.SKIP +### 2.7.SKIP `SKIP` specifies the offset of the result rows. @@ -382,7 +374,7 @@ return [{"n.name":"Corin Redgrave"},{"n.name":"Dennis Quaid"}] ``` -### 2.8.LIMIT +### 2.8.LIMIT The `LIMIT` clause is used to limit the number of rows in the result. diff --git a/docs/zh-CN/source/3.quick-start/1.preparation.md b/docs/zh-CN/source/3.quick-start/1.preparation.md index 99a093e150..d294637d62 100644 --- a/docs/zh-CN/source/3.quick-start/1.preparation.md +++ b/docs/zh-CN/source/3.quick-start/1.preparation.md @@ -46,7 +46,7 @@ _目前我们建议用户使用 NVMe SSD 配合较大的内存配置以获取最 TuGraph 可以通过 Docker Image 快速安装,或者通过 rpm/deb 包本地安装。另外TuGraph在阿里云计算巢上提供了社区版服务,您无需自行购置云主机,即可在计算巢上快速部署TuGraph服务、实现运维监控,从而搭建您自己的图应用。 -> 安装包/镜像下载:[下载地址](../1.guide.md#TuGraph最新版本 )。 +> 安装包/镜像下载:[下载地址](../1.guide.md)。 > 计算巢部署:可以在阿里云计算巢自行搜索,也可以通过[部署链接]( ../5.installation&running/5.cloud-deployment.md )快速访问。 diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index 1f7e4f5b0f..781c471041 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md#TuGraph最新版本)。 +最新版本的安装包地址参见 [链接](../../1.guide.md)。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) From f1df18f665606355320d9c4fcb34c35672219a3d Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Sun, 7 Apr 2024 10:29:07 +0800 Subject: [PATCH 23/28] =?UTF-8?q?=E9=94=9A=E7=82=B9=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en-US/source/5.installation&running/3.docker-deployment.md | 2 +- .../source/5.installation&running/4.local-package-deployment.md | 2 +- .../source/5.installation&running/4.local-package-deployment.md | 2 +- docs/zh-CN/source/conf.py | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/en-US/source/5.installation&running/3.docker-deployment.md b/docs/en-US/source/5.installation&running/3.docker-deployment.md index b664276b7d..1e1453e67b 100644 --- a/docs/en-US/source/5.installation&running/3.docker-deployment.md +++ b/docs/en-US/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ The images are hosted on [DockerHub]( https://hub.docker.com/u/tugraph ) and can be downloaded and used directly. -For the latest version of Docker address, see [Link](../1.guide.md). +For the latest version of Docker address, see "TuGraph-Latest-Version" of [Guide](../../1.guide.md) ### 2.2.Naming Convention diff --git a/docs/en-US/source/5.installation&running/4.local-package-deployment.md b/docs/en-US/source/5.installation&running/4.local-package-deployment.md index ddf4d56f75..cb40030596 100644 --- a/docs/en-US/source/5.installation&running/4.local-package-deployment.md +++ b/docs/en-US/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ If you need to use the complete TuGraph function, please refer to the tugraph-db ## 2. Download the installation package -For the latest version of the installation package address, see [Link](../../1.guide.md). +For the latest version of the installation package address, see "TuGraph-Latest-Version" of [Guide](../../1.guide.md) You can also visit Github to download: [TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index 781c471041..ce229ca0e5 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 [链接](../../1.guide.md)。 +最新版本的安装包地址参见 see [文档地图](../../1.guide.md)的"TuGraph最新版本"章节。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) diff --git a/docs/zh-CN/source/conf.py b/docs/zh-CN/source/conf.py index 98dd5105a9..a00699ccca 100644 --- a/docs/zh-CN/source/conf.py +++ b/docs/zh-CN/source/conf.py @@ -7,6 +7,7 @@ import os, subprocess, sys, shlex project = 'TuGraph' + copyright = '2023, Ant Group' author = 'Ant Group' From 4541a2e0e02507ff35b0c68da32d4f1624310932 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Sun, 7 Apr 2024 10:36:31 +0800 Subject: [PATCH 24/28] =?UTF-8?q?=E9=A1=B5=E9=9D=A2=E9=97=B4=E8=B7=B3?= =?UTF-8?q?=E8=BD=AC=E9=94=9A=E7=82=B9=E8=B0=83=E6=95=B4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh-CN/source/5.installation&running/3.docker-deployment.md | 2 +- .../source/5.installation&running/4.local-package-deployment.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/zh-CN/source/5.installation&running/3.docker-deployment.md b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md index ab402d7187..7400804d9b 100644 --- a/docs/zh-CN/source/5.installation&running/3.docker-deployment.md +++ b/docs/zh-CN/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ 镜像托管在[DockerHub]( https://hub.docker.com/u/tugraph ),可直接下载使用。 -最新版本的Docker地址参见 [链接](../1.guide.md)。 +最新版本的Docker地址参见 [文档地图](../../1.guide.md)的"TuGraph最新版本"章节。 ### 2.2.命名规范 diff --git a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md index ce229ca0e5..04125f35c8 100644 --- a/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md +++ b/docs/zh-CN/source/5.installation&running/4.local-package-deployment.md @@ -10,7 +10,7 @@ TuGraph本地包部署需要对应的环境,快速验证可以使用精简安 ## 2. 安装包下载 -最新版本的安装包地址参见 see [文档地图](../../1.guide.md)的"TuGraph最新版本"章节。 +最新版本的安装包地址参见 [文档地图](../../1.guide.md)的"TuGraph最新版本"章节。 也可以访问Github进行下载:[TuGraph Release](https://github.com/TuGraph-family/tugraph-db/releases) From 06b89bfd99e656936294e3e60ee8d9fae3e5654c Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Sun, 7 Apr 2024 11:35:56 +0800 Subject: [PATCH 25/28] =?UTF-8?q?=E8=B0=83=E6=95=B4=E7=9B=AE=E5=BD=95?= =?UTF-8?q?=E7=BB=93=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../6.interface/4.protocol/index.rst | 8 -------- .../5.developer-manual/6.interface/index.rst | 12 ------------ docs/en-US/source/5.developer-manual/index.rst | 15 --------------- .../5.installation&running/3.docker-deployment.md | 2 +- 4 files changed, 1 insertion(+), 36 deletions(-) delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/4.protocol/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/6.interface/index.rst delete mode 100644 docs/en-US/source/5.developer-manual/index.rst diff --git a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/index.rst b/docs/en-US/source/5.developer-manual/6.interface/4.protocol/index.rst deleted file mode 100644 index 484e600e87..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/4.protocol/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -TuGraph DB Protocol -================================ - -.. toctree:: - :maxdepth: 2 - :glob: - - * \ No newline at end of file diff --git a/docs/en-US/source/5.developer-manual/6.interface/index.rst b/docs/en-US/source/5.developer-manual/6.interface/index.rst deleted file mode 100644 index ea54cb9c63..0000000000 --- a/docs/en-US/source/5.developer-manual/6.interface/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -TuGraph DB Interface -======================== - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.query/index.rst - 2.olap/index.rst - 3.procedure/index.rst - 4.protocol/index.rst - 5.learn/index.rst diff --git a/docs/en-US/source/5.developer-manual/index.rst b/docs/en-US/source/5.developer-manual/index.rst deleted file mode 100644 index 4900dd0189..0000000000 --- a/docs/en-US/source/5.developer-manual/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -TuGraph DB Developer Manual -======================================== - -.. toctree:: - :maxdepth: 2 - :glob: - - 1.installation/index.rst - 2.running/index.rst - 3.server-tools/index.rst - 4.client-tools/index.rst - 5.ecosystem-tools/index.rst - 6.interface/index.rst - 7.quality/index.rst - 8.other/index.rst diff --git a/docs/en-US/source/5.installation&running/3.docker-deployment.md b/docs/en-US/source/5.installation&running/3.docker-deployment.md index 3400fcc46c..bb966b75b2 100644 --- a/docs/en-US/source/5.installation&running/3.docker-deployment.md +++ b/docs/en-US/source/5.installation&running/3.docker-deployment.md @@ -14,7 +14,7 @@ The images are hosted on [DockerHub]( https://hub.docker.com/u/tugraph ) and can be downloaded and used directly. -For the latest version of Docker address, see the TuGraph-Latest-Version section in [Link](../../1.guide.md). +For the latest version of Docker address, see the TuGraph-Latest-Version section in [Guide](../../1.guide.md). ### 2.2.Naming Convention From 96d4e8520370e070d42c4e559755eaedd57c7973 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 18 Apr 2024 11:03:35 +0800 Subject: [PATCH 26/28] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=B8=AD"=E4=BF=AE=E6=94=B9=E8=A7=92=E8=89=B2=E5=AF=B9?= =?UTF-8?q?=E6=8C=87=E5=AE=9A=E5=9B=BE=E7=9A=84=E8=AE=BF=E9=97=AE=E6=9D=83?= =?UTF-8?q?=E9=99=90"=E7=9A=84=E6=8E=A5=E5=8F=A3=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en-US/source/10.permission/1.privilege.md | 9 ++++++++- docs/zh-CN/source/10.permission/1.privilege.md | 8 +++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/en-US/source/10.permission/1.privilege.md b/docs/en-US/source/10.permission/1.privilege.md index 59c569b9f7..8208e9bfc4 100644 --- a/docs/en-US/source/10.permission/1.privilege.md +++ b/docs/en-US/source/10.permission/1.privilege.md @@ -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'}) +``` + diff --git a/docs/zh-CN/source/10.permission/1.privilege.md b/docs/zh-CN/source/10.permission/1.privilege.md index 30b26dd16f..244a9cde82 100644 --- a/docs/zh-CN/source/10.permission/1.privilege.md +++ b/docs/zh-CN/source/10.permission/1.privilege.md @@ -128,5 +128,11 @@ CALL dbms.security.rebuildUserRoles(user::STRING,roles::LIST) - 修改角色对指定图的访问权限 ```cypher -CALL dbms.security.modSpecifiedAccessLevel(role::STRING,access_level::MAP) +CALL dbms.security.modRoleAccessLevel(role::STRING,access_level::MAP) +``` + + - 示例 + +```cypher +CALL dbms.security.modRoleAccessLevel('test_role', {test_graph1:'FULL', test_graph2:'NONE'}) ``` From c4fc131d510334a95138f53e6df6194497aa2d10 Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 18 Apr 2024 11:40:01 +0800 Subject: [PATCH 27/28] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=B8=AD"=E4=BF=AE=E6=94=B9=E8=A7=92=E8=89=B2=E5=AF=B9?= =?UTF-8?q?=E6=8C=87=E5=AE=9A=E5=9B=BE=E7=9A=84=E8=AE=BF=E9=97=AE=E6=9D=83?= =?UTF-8?q?=E9=99=90"=E7=9A=84=E6=8E=A5=E5=8F=A3=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en-US/source/10.permission/1.privilege.md | 2 +- docs/zh-CN/source/10.permission/1.privilege.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en-US/source/10.permission/1.privilege.md b/docs/en-US/source/10.permission/1.privilege.md index 8208e9bfc4..a86fe00229 100644 --- a/docs/en-US/source/10.permission/1.privilege.md +++ b/docs/en-US/source/10.permission/1.privilege.md @@ -134,7 +134,7 @@ CALL dbms.security.rebuildUserRoles(user::STRING,roles::LIST) CALL dbms.security.modRoleAccessLevel(role::STRING,access_level::MAP) ``` - - Example + _Example_ ```cypher CALL dbms.security.modRoleAccessLevel('test_role', {test_graph1:'FULL', test_graph2:'NONE'}) diff --git a/docs/zh-CN/source/10.permission/1.privilege.md b/docs/zh-CN/source/10.permission/1.privilege.md index 244a9cde82..67e65b9cf5 100644 --- a/docs/zh-CN/source/10.permission/1.privilege.md +++ b/docs/zh-CN/source/10.permission/1.privilege.md @@ -131,7 +131,7 @@ CALL dbms.security.rebuildUserRoles(user::STRING,roles::LIST) CALL dbms.security.modRoleAccessLevel(role::STRING,access_level::MAP) ``` - - 示例 + _示例_ ```cypher CALL dbms.security.modRoleAccessLevel('test_role', {test_graph1:'FULL', test_graph2:'NONE'}) From f849339da0b30f16eeeeb3d5e0f862196ed4cefb Mon Sep 17 00:00:00 2001 From: zhangwenhao Date: Thu, 18 Apr 2024 11:41:24 +0800 Subject: [PATCH 28/28] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= =?UTF-8?q?=E4=B8=AD"=E4=BF=AE=E6=94=B9=E8=A7=92=E8=89=B2=E5=AF=B9?= =?UTF-8?q?=E6=8C=87=E5=AE=9A=E5=9B=BE=E7=9A=84=E8=AE=BF=E9=97=AE=E6=9D=83?= =?UTF-8?q?=E9=99=90"=E7=9A=84=E6=8E=A5=E5=8F=A3=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en-US/source/10.permission/1.privilege.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en-US/source/10.permission/1.privilege.md b/docs/en-US/source/10.permission/1.privilege.md index a86fe00229..e924a25bc8 100644 --- a/docs/en-US/source/10.permission/1.privilege.md +++ b/docs/en-US/source/10.permission/1.privilege.md @@ -134,7 +134,7 @@ CALL dbms.security.rebuildUserRoles(user::STRING,roles::LIST) CALL dbms.security.modRoleAccessLevel(role::STRING,access_level::MAP) ``` - _Example_ +_Example_ ```cypher CALL dbms.security.modRoleAccessLevel('test_role', {test_graph1:'FULL', test_graph2:'NONE'})