Skip to content

Commit 76c87ae

Browse files
Update workspace.adoc
1 parent 391e9d9 commit 76c87ae

File tree

1 file changed

+64
-20
lines changed
  • modules/savanna/modules/workgroup-workspace/pages/workspaces

1 file changed

+64
-20
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,75 @@
1-
= Workspace Overview
1+
= Read/Write and Read Only Workspaces
22

3-
A *Workspace* is a compute unit within a TigerGraph database.
4-
It is where the graph processing and analytics take place.
5-
TigerGraph Savanna supports two types of workspaces: read-write workspaces and read-only workspaces.
3+
Read-Write and Read-Only Workspaces will connect to the same database allowing users to dynamically control OLTP (define) and OLAP (define) workloads for complete isolation of analytical and transactional traffic.
64

7-
** *Read-Write Workspaces (RW)*: These workspaces allow read and write operations on the graph data.
8-
They are typically used for data ingestion, data updates, and running queries that modify the graph structure or properties.
5+
== Read-Write (RW) Workspace
96

10-
** *Read-Only Workspaces (RO)*: These workspaces are optimized for read-intensive operations.
7+
Read-Write (RW) workspaces allow read and write operations on the graph data.
8+
They are typically used for loading data, data updates, and running queries that modify the graph structure or properties.
9+
10+
//[Placeholder for create a new database]
11+
12+
//=== Create a Read-Write workspace
13+
14+
== Read-Only (RO) Workspace
15+
16+
Read-Only (RO) workspaces are optimized for read-intensive operations.
1117
They are used for executing queries and analytics on the graph data without modifying it.
1218
Read-only workspaces provide improved performance and scalability for read operations.
13-
+
14-
[TIP]
15-
====
16-
The separation of compute and storage in workspaces allows for optimized performance and resource allocation, while the databases ensure the persistence and accessibility of the graph data.
17-
====
1819

19-
* The *database* in TigerGraph Savanna refers to the actual data stored within the platform.
20-
It is separate from the workspaces and can be associated with one or more workspaces within a workgroup.
21-
It holds the persistent data that is loaded into TigerGraph and is accessible for graph analytics and visualization.
22-
+
23-
[NOTE]
20+
[NOTE]: The Read-Only workspace must be manually synced with the Read-Write workspace to reflect the latest data changes.
21+
22+
//[Placeholder for attach to an existing database]
23+
24+
=== Operations Prohibited in a Read-Only (RO) Workspace
25+
26+
In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations are strictly prohibited:
27+
28+
.Database Operations
29+
- Running "gsql --reset" command.
30+
- Clearing the graph store.
31+
- Executing the DROP ALL command.
32+
33+
.Schema Management
34+
- Updating schemas, including adding, updating, or dropping schema elements.
35+
- Creating, dropping, or running schema change jobs.
36+
37+
.Graph Management
38+
- Creating or dropping graphs.
39+
- Exporting or importing database data.
40+
41+
.Data Modification
42+
- Running any queries that modify the database data.
43+
- Inserting, updating, or deleting data.
44+
- Committing the data(such as new vertices or edges) in memory to disk. for example: rebuildnow operation
45+
46+
.Loading Jobs
47+
- Creating, deleting, or running loading jobs.
48+
- Creating, deleting, pausing, restarting, or resuming connectors.
49+
- Creating or updating data sources.
50+
51+
.Backup and Restore
52+
- Performing backup or restore operations.
53+
54+
55+
=== Update Read-Only(RO) Workspace
56+
57+
Once a Read-Only (RO) workspace is created, it also creates a snapshot of the data.
58+
You can manually sync up the data with Read-Write(RW) workspace when needed.
59+
60+
//[Placeholder for update read-only workspace]
61+
62+
[NOTE]:Updating a Read-Only (RO) workspace is an offline operation.
63+
64+
If there are any other operations in progress on the RO workspace, they are likely to be affected during the update process.
65+
66+
[TIP]
2467
====
25-
We only support a maximum of one Read-Write workspace to connect to a database.
68+
It is recommended to schedule the update during a time when minimal or no operations are expected on the RO workspace to avoid any potential disruptions.
2669
====
2770

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

31-
Return to the xref:savanna:workgroup-workspace:index.adoc[] page or xref:savanna:overview:index.adoc[Overview] page for a different topic.
73+
Next, about xref:cloud4:workgroup-workspace:workspaces/workspace-size.adoc[Workspace Sizes] or learn how to xref:cloud4:workgroup-workspace:workspaces/expansion-shrink.adoc[Expand and Shrink] a workspace.
74+
75+
Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic.

0 commit comments

Comments
 (0)