Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[DOC-2092] add doc for blocking operation in RO #80

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

Conversation

zhihuapengtg
Copy link
Collaborator

add doc for blocking operation in RO

@@ -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

Choose a reason for hiding this comment

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

can we change to RO Workspace? that make sure the description consistent

@@ -22,6 +22,22 @@ 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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Current RO workspace requires manual sync up with the RW workspace to catch up with the latest change.
Current Read-Only (RO) workspace requires manual sync up with the RW workspace to catch up with the latest change.

@@ -22,6 +22,22 @@ 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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
In RO workspace, the following operations are forbidden:
In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations are strictly prohibited:


In RO workspace, the following operations are forbidden:

1. run write queries
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we make the forbidden operations in categories:
Database Operations,
System Administration Commands,
Schema Management,
Graph Management,
Data Modification,
Loading Jobs
Backup and Restore,

Copy link
Collaborator

@samzhou2 samzhou2 left a comment

Choose a reason for hiding this comment

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

@zhihuapengtg can you also capitalize each point, and make them easy for end users to understand, here is what is generated by ChatGPT:
Running any queries that modify the database state.
Creating or dropping graphs.
Updating schemas, including adding, updating, or dropping schema elements.
Creating, dropping, or running schema change jobs.
Inserting, updating, or deleting data.
Performing backup or restore operations.
Exporting or importing data.
Executing the DROP ALL command.
Clearing the graph store.
Rebuilding Operations
Rebuilding any part of the database.
Running gadmin or gsql reset commands.
Creating, deleting, or running loading jobs.
Creating or updating data sources.
Creating, deleting, pausing, restarting, or resuming connectors.

@zhihuapengtg
Copy link
Collaborator Author

@zhihuapengtg can you also capitalize each point, and make them easy for end users to understand, here is what is generated by ChatGPT: Running any queries that modify the database state. Creating or dropping graphs. Updating schemas, including adding, updating, or dropping schema elements. Creating, dropping, or running schema change jobs. Inserting, updating, or deleting data. Performing backup or restore operations. Exporting or importing data. Executing the DROP ALL command. Clearing the graph store. Rebuilding Operations Rebuilding any part of the database. Running gadmin or gsql reset commands. Creating, deleting, or running loading jobs. Creating or updating data sources. Creating, deleting, pausing, restarting, or resuming connectors.

ok, thanks.

Copy link
Collaborator

@samzhou2 samzhou2 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

netlify bot commented Jan 21, 2025

Deploy Preview for thriving-strudel-91d4a9 failed.

Name Link
🔨 Latest commit 7e2f35c
🔍 Latest deploy log https://app.netlify.com/sites/thriving-strudel-91d4a9/deploys/678f89f1daa2ce0007baf10d

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants