Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2092 #98

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

DOC-2092 #98

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98de0d6
DOC-2092
anjaliIthapeTG Jan 22, 2025
6f84cbb
Update workspace.adoc
anjaliIthapeTG Jan 22, 2025
1cc8993
Update workspace.adoc
anjaliIthapeTG Jan 22, 2025
16f5a79
Update workspace.adoc
anjaliIthapeTG Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions modules/savanna/modules/workgroup-workspace/pages/workspaces/workspace.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,38 @@ It holds the persistent data that is loaded into TigerGraph and is accessible fo
We only support a maximum of one Read-Write workspace to connect to a database.
====


=== Operations Restricted in a Read-Only (RO) Workspace

In a Read-Only (RO) workspace within TigerGraph Savanna, the following operations are restricted:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Saying something "is restricted" means there are some limitations. It does not specify the limitations, and it does not say it is prohibited. For example, think of a sign on a gate that says, "Permission to enter is restricted."

"In RO workspaces, database operations are restricted": true, but by itself, doesn't say enough to be useful.
"In RO workspaces, DROP ALL is restricted": Wrong word. Better: "In RO workspaces, DROP ALL is prohibited."

I suggest first added a better intro sentence, and then using "prohibited" instead of "restricted":

As the name implies, Read-Only workspaces only allow users to read the data in the graph, not to modify.
Accordingly, the following operations are prohibited:

.Database Operations
- Running "gsql --reset" command.
- Clearing the graph store.
- Executing the DROP ALL command.

.Schema Management
- Updating schemas, including adding, updating, or dropping schema elements.
- Creating, dropping, or running schema change jobs.

.Graph Management
- Creating or dropping graphs.
- Exporting or importing database data.

.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

.Loading Jobs
- Creating, deleting, or running loading jobs.
- Creating, deleting, pausing, restarting, or resuming connectors.
- Creating or updating data sources.

.Backup and Restore
- Performing backup or restore operations.


== Next Steps
See xref:workspaces/how2-create-a-workspace.adoc[] to get started.

Expand Down
Loading