-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
391e9d9
commit 76c87ae
Showing
1 changed file
with
64 additions
and
20 deletions.
There are no files selected for viewing
84 changes: 64 additions & 20 deletions
84
modules/savanna/modules/workgroup-workspace/pages/workspaces/workspace.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,75 @@ | ||
= Workspace Overview | ||
= Read/Write and Read Only Workspaces | ||
|
||
A *Workspace* is a compute unit within a TigerGraph database. | ||
It is where the graph processing and analytics take place. | ||
TigerGraph Savanna supports two types of workspaces: read-write workspaces and read-only workspaces. | ||
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. | ||
|
||
** *Read-Write Workspaces (RW)*: These workspaces allow read and write operations on the graph data. | ||
They are typically used for data ingestion, data updates, and running queries that modify the graph structure or properties. | ||
== Read-Write (RW) Workspace | ||
|
||
** *Read-Only Workspaces (RO)*: These workspaces are optimized for read-intensive operations. | ||
Read-Write (RW) workspaces allow read and write operations on the graph data. | ||
They are typically used for loading data, data updates, and running queries that modify the graph structure or properties. | ||
|
||
//[Placeholder for create a new database] | ||
|
||
//=== Create a Read-Write workspace | ||
|
||
== Read-Only (RO) Workspace | ||
|
||
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. | ||
+ | ||
[TIP] | ||
==== | ||
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. | ||
==== | ||
|
||
* The *database* in TigerGraph Savanna refers to the actual data stored within the platform. | ||
It is separate from the workspaces and can be associated with one or more workspaces within a workgroup. | ||
It holds the persistent data that is loaded into TigerGraph and is accessible for graph analytics and visualization. | ||
+ | ||
[NOTE] | ||
[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] | ||
|
||
=== Operations Prohibited in a Read-Only (RO) Workspace | ||
|
||
In a Read-Only (RO) workspace within TigerGraph Cloud, the following operations are strictly 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. | ||
|
||
|
||
=== Update Read-Only(RO) Workspace | ||
|
||
Once a Read-Only (RO) workspace is created, it also creates a snapshot of the data. | ||
You can manually sync up the data with Read-Write(RW) workspace when needed. | ||
|
||
//[Placeholder for update read-only workspace] | ||
|
||
[NOTE]:Updating a Read-Only (RO) workspace is an offline operation. | ||
|
||
If there are any other operations in progress on the RO workspace, they are likely to be affected during the update process. | ||
|
||
[TIP] | ||
==== | ||
We only support a maximum of one Read-Write workspace to connect to a database. | ||
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. | ||
==== | ||
|
||
== Next Steps | ||
See xref:workspaces/how2-create-a-workspace.adoc[] to get started. | ||
|
||
Return to the xref:savanna:workgroup-workspace:index.adoc[] page or xref:savanna:overview:index.adoc[Overview] page for a different topic. | ||
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. | ||
|
||
Return to the xref:cloud4:workgroup-workspace:index.adoc[] page or xref:cloud4:overview:index.adoc[Overview] page for a different topic. |