From 6736eb2c3f954d24e53986a478f16a3594aaa64d Mon Sep 17 00:00:00 2001 From: zhihuapeng-tg <160460847+zhihuapengtg@users.noreply.github.com> Date: Fri, 9 Aug 2024 17:06:54 +0800 Subject: [PATCH 1/6] Update writeread_readonly.adoc operation in RO --- .../pages/workspaces/writeread_readonly.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index 887fe20b..a643602f 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -24,6 +24,24 @@ Read-only workspaces provide improved performance and scalability for read opera Current RO workspace requires manual sync up with the RW workspace to catch up with the latest change. ==== +=== Block write operations in RO cluster + +In RO cluster, the following operations are forbidden: + +1. run write queries +2. create/drop graph +3. update schema (add/update/drop), create/drop/run schema change job +4. update data (insert/update/delete) +5. backup/restore +6. export/import +7. drop all +8. clear graph store +9. rebuild +10. gadmin/gsql reset +11. create/delete/run loading job +12. create/update datasource +13. create/delete/pause/restart/resume connector + === Update Read-Only(RO) Workspace Once a Read-Only (RO) workspace is created, it also creates a snapshot of the data. From 4991385a6d9e15b6c091925b81ffb8a44840b7cc Mon Sep 17 00:00:00 2001 From: zhihuapeng-tg <160460847+zhihuapengtg@users.noreply.github.com> Date: Fri, 9 Aug 2024 17:45:27 +0800 Subject: [PATCH 2/6] Update writeread_readonly.adoc --- .../pages/workspaces/writeread_readonly.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index a643602f..d1881ef3 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -22,11 +22,8 @@ Read-only workspaces provide improved performance and scalability for read opera [NOTE] ==== Current RO workspace requires manual sync up with the RW workspace to catch up with the latest change. -==== - -=== Block write operations in RO cluster -In RO cluster, the following operations are forbidden: +In RO workspace, the following operations are forbidden: 1. run write queries 2. create/drop graph @@ -41,6 +38,7 @@ In RO cluster, the following operations are forbidden: 11. create/delete/run loading job 12. create/update datasource 13. create/delete/pause/restart/resume connector +==== === Update Read-Only(RO) Workspace From 6ddf93910c2f3ca62e4da741d32d3e79aab12dc1 Mon Sep 17 00:00:00 2001 From: zhihuapeng-tg <160460847+zhihuapengtg@users.noreply.github.com> Date: Mon, 12 Aug 2024 11:21:48 +0800 Subject: [PATCH 3/6] Update writeread_readonly.adoc address comments --- .../pages/workspaces/writeread_readonly.adoc | 52 +++++++++++++------ 1 file changed, 35 insertions(+), 17 deletions(-) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index d1881ef3..a9a99d6d 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -21,23 +21,41 @@ Read-only workspaces provide improved performance and scalability for read opera [NOTE] ==== -Current RO workspace requires manual sync up with the RW workspace to catch up with the latest change. - -In RO workspace, the following operations are forbidden: - -1. run write queries -2. create/drop graph -3. update schema (add/update/drop), create/drop/run schema change job -4. update data (insert/update/delete) -5. backup/restore -6. export/import -7. drop all -8. clear graph store -9. rebuild -10. gadmin/gsql reset -11. create/delete/run loading job -12. create/update datasource -13. create/delete/pause/restart/resume connector +Current Read-Only (RO) workspace requires manual sync up with the RW workspace to catch up with the latest change. + +In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations are strictly prohibited: + +[.prohibited] +.Database Operations +- gsql reset +- clear graph store +- drop all + +[.prohibited] +.Schema Management +- update schema (add/update/drop), create/drop/run schema change job +- rebuild + +[.prohibited] +.Graph Management +- create/drop graph +- export/import + +[.prohibited] +.Data Modification +- run write queries +- update data (insert/update/delete) + +[.prohibited] +.Loading Jobs +- create/delete/run loading job +- create/delete/pause/restart/resume connector +- create/update datasource + +[.prohibited] +.Backup and Restore +- backup/restore + ==== === Update Read-Only(RO) Workspace From 17c3e87b4a10d54f142ac29e4d0f783428e150a4 Mon Sep 17 00:00:00 2001 From: zhihuapeng-tg Date: Mon, 12 Aug 2024 15:07:14 +0800 Subject: [PATCH 4/6] address comments --- .../pages/workspaces/writeread_readonly.adoc | 31 +++++++++++-------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index a9a99d6d..bc35b588 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -27,34 +27,39 @@ In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations [.prohibited] .Database Operations -- gsql reset -- clear graph store -- drop all +- Running "gsql --reset" command. +- Clearing the graph store. +- Executing the DROP ALL command. + +[.prohibited] +.System Administration Commands +- Running gadmin commands. [.prohibited] .Schema Management -- update schema (add/update/drop), create/drop/run schema change job -- rebuild +- Updating schemas, including adding, updating, or dropping schema elements. +- Creating, dropping, or running schema change jobs. [.prohibited] .Graph Management -- create/drop graph -- export/import +- Creating or dropping graphs. +- Exporting or importing database data. [.prohibited] .Data Modification -- run write queries -- update data (insert/update/delete) +- Running any queries that modify the database data. +- Inserting, updating, or deleting data. +- Committing the data(such as new vertices or edges) in memory to disk. for example: rebuildnow operation [.prohibited] .Loading Jobs -- create/delete/run loading job -- create/delete/pause/restart/resume connector -- create/update datasource +- Creating, deleting, or running loading jobs. +- Creating, deleting, pausing, restarting, or resuming connectors. +- Creating or updating data sources. [.prohibited] .Backup and Restore -- backup/restore +- Performing backup or restore operations. ==== From 9465855d6ef2c39e25f225bf93da799dee4fe1c9 Mon Sep 17 00:00:00 2001 From: zhihuapeng-tg Date: Mon, 12 Aug 2024 15:10:04 +0800 Subject: [PATCH 5/6] address comments --- .../resource-manager/pages/workspaces/writeread_readonly.adoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index bc35b588..1da21837 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -31,10 +31,6 @@ In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations - Clearing the graph store. - Executing the DROP ALL command. -[.prohibited] -.System Administration Commands -- Running gadmin commands. - [.prohibited] .Schema Management - Updating schemas, including adding, updating, or dropping schema elements. From 7e2f35cb134d78d081c3f880151ddf936f645c80 Mon Sep 17 00:00:00 2001 From: anjaliIthapeTG Date: Tue, 21 Jan 2025 17:20:06 +0530 Subject: [PATCH 6/6] DOC-2092 --- .../pages/workspaces/writeread_readonly.adoc | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc index 1da21837..a176992b 100644 --- a/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc +++ b/modules/cloudbeta/modules/resource-manager/pages/workspaces/writeread_readonly.adoc @@ -17,47 +17,40 @@ Read-Only (RO) workspaces are optimized for read-intensive operations. They are used for executing queries and analytics on the graph data without modifying it. Read-only workspaces provide improved performance and scalability for read operations. +[NOTE]: The Read-Only workspace must be manually synced with the Read-Write workspace to reflect the latest data changes. + //[Placeholder for attach to an existing database] -[NOTE] -==== -Current Read-Only (RO) workspace requires manual sync up with the RW workspace to catch up with the latest change. +=== Operations Prohibited in a Read-Only (RO) Workspace In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations are strictly prohibited: -[.prohibited] .Database Operations - Running "gsql --reset" command. - Clearing the graph store. - Executing the DROP ALL command. -[.prohibited] .Schema Management - Updating schemas, including adding, updating, or dropping schema elements. - Creating, dropping, or running schema change jobs. -[.prohibited] .Graph Management - Creating or dropping graphs. - Exporting or importing database data. -[.prohibited] .Data Modification - Running any queries that modify the database data. - Inserting, updating, or deleting data. - Committing the data(such as new vertices or edges) in memory to disk. for example: rebuildnow operation -[.prohibited] .Loading Jobs - Creating, deleting, or running loading jobs. - Creating, deleting, pausing, restarting, or resuming connectors. - Creating or updating data sources. -[.prohibited] .Backup and Restore - Performing backup or restore operations. -==== === Update Read-Only(RO) Workspace