Skip to content

Commit

Permalink
Update to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
samzhou2 committed Oct 29, 2024
1 parent 53d26ee commit 0739fd6
Show file tree
Hide file tree
Showing 6 changed files with 104 additions and 35 deletions.
86 changes: 54 additions & 32 deletions modules/cloud4/modules/graph-development/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,59 +1,81 @@
= Graph Managment

Here, you will find comprehensive guides and resources to help you design, load, query, and explore your graph database.
Welcome to the Graph Development Landing Page! This guide provides an overview of the essential tools and processes for managing and developing your graph databases. Click on the sections below to learn more about each area.

== Design Schema
== [Load Data](#load-data)

Designing an effective schema is the foundation of a performant graph database. This section covers:
Efficiently loading data into your TigerGraph databases is crucial for successful graph analysis.

- **Schema Basics:** Learn the fundamental concepts of graph schema design.
- **Nodes and Edges:** Understand how to define nodes (vertices) and edges in your schema.
- **Attributes and Types:** Learn how to assign attributes and data types to your nodes and edges.
- **Schema Best Practices:** Tips and best practices for designing a scalable and efficient graph schema.
### Key Features:
- Select an active workspace.
- Use various connectors to load data.
- Choose between a Step-by-Step Guide or GSQL Template for data loading.

[Learn more about Schema Design](#)
### Learn More:
- [Load Data from Local File](#)
- [Load Data from Amazon S3](#)
- [Load Data from Google Cloud Storage](#)
- [Load Data from Azure Blob Storage](#)
- [Load Data from Other Sources](#)

---

== Load Data
== [Design Schema](#design-schema)

Loading data into your graph database is a crucial step. This section provides:
The Schema Designer provides a user-friendly interface for managing your graph database schema.

- **Data Formats:** Supported data formats for importing into the graph database.
- **Data Import Methods:** Various methods to load data, including bulk loading and streaming.
- **Data Mapping:** How to map your data to the defined schema.
- **Error Handling:** Troubleshooting common issues during data loading.
### Key Features:
- Define vertex and edge types.
- Specify properties and indexes.
- Establish relationships between elements.

[Learn more about Loading Data](#)
### Learn More:
- [Edit GSQL Query](#)
- [Schema Designer](#)

---
== [GSQL Editor](#gsql-editor)

== GSQL Editor
The GSQL Editor is a powerful tool for developing and executing GSQL queries.

The GSQL (Graph SQL) Editor is your primary tool for writing and executing queries. This section includes:
### Key Features:
- Four work areas: File List Panel, Result Panel, Schema Designer Panel, and Main GSQL Editing Panel.
- Shortcuts for efficient query execution.
- File List for organizing and managing GSQL queries.
- Query List for managing custom queries.

- **Introduction to GSQL:** Basics of the GSQL language and its syntax.
- **Writing Queries:** How to write and execute queries to retrieve and manipulate data.
- **Advanced GSQL Features:** Explore advanced features like user-defined functions and stored procedures.
- **Performance Tuning:** Tips for optimizing your GSQL queries for better performance.
### Steps to Get Started:
1. **File List**: Navigate through files and folders, search for specific files, and create new files or folders.
![File List](Screenshot 2024-10-11 at 10.59.49.png)

2. **Folders**: Manage shared and user-defined folders.
![Create Folder](Screenshot 2024-04-18 at 10.10.18 AM.png)

3. **Query List**: View, create, edit, delete, and install custom queries.
![Query List](queries.png)

[Learn more about GSQL Editor](#)
### Learn More:
- [Edit GSQL Query](#)
- [Schema Designer](#)

---
== [Explore Graph](#explore-graph)

== Explore Graph
Explore Graph allows users to visually interact with their graph data, helping to navigate and understand complex data structures.

Exploring your graph data helps you gain insights and uncover patterns. This section covers:
### Key Features:
- Visual representation of graph data.
- Identify and explain relationships between data points or entities.

- **Graph Visualization:** Tools and techniques for visualizing your graph data.
- **Exploration Techniques:** Methods for traversing and analyzing your graph.
- **Use Cases:** Real-world examples and use cases of graph exploration.
- **Integration:** Integrating graph exploration with other tools and platforms.
### Prerequisites:
- [Create a Workspace](#)
- [Load Data](#)

[Learn more about Exploring Graph](#)
### Learn More:
- [Use Pattern Search](#)

---

For detailed information on each topic, please refer to the respective documentation pages linked above. Happy graph developing!


== Additional Resources

- **API Documentation:** Detailed reference for the graph database API.
Expand Down
3 changes: 3 additions & 0 deletions modules/cloud4/modules/resources/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
* xref:cloud4:resources:index.adoc[Resources]
** xref:cloud4:resources:aws.adoc[]
** xref:cloud4:resources:gcp.adoc[]
** xref:cloud4:resources:azure.adoc[]
** xref:cloud4:resources:glossary.adoc[]
** xref:cloud4:resources:support.adoc[]
** xref:cloud4:resources:faqs.adoc[]
Expand Down
34 changes: 34 additions & 0 deletions modules/cloud4/modules/resources/pages/aws.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
= Amazon Web Services (AWS)

TigerGraph Cloud 4 leverages Amazon Web Services (AWS) to provide reliable and scalable infrastructure. Below are the supported AWS regions where TigerGraph Cloud 4 is available.

== Supported AWS Regions

* US East (N. Virginia) us-east-1
* US East (Ohio) us-east-2
* US West (Oregon) us-west-2
* Europe (Frankfurt) eu-central-1
* Europe (Ireland) eu-west-1
* Europe (London) eu-west-2
* Europe (Paris) eu-west-3
* South America (Sao Paulo) sa-east-1
* Asia Pacific (Singapore) ap-southeast-1
* Asia Pacific (Sydney) ap-southeast-2
* Asia Pacific (Tokyo) ap-northeast-1

== Storage

TigerGraph Cloud 4 utilizes various AWS storage services to ensure optimal performance and data management:

https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html[Amazon Elastic Block Store (EBS)]: EBS provides high-performance block storage for use with Amazon EC2 instances. In TigerGraph Cloud, EBS is used to store system data, Kafka data, and logs, ensuring faster access and high availability for these critical components.

https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html[Amazon Elastic File System (EFS)]: EFS offers scalable file storage for use with AWS Cloud services and on-premises resources. TigerGraph Cloud uses EFS to store graph IDS data, providing a scalable and managed file system that can grow and shrink automatically as you add and remove files.

https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html[Amazon Simple Storage Service (S3)]: S3 provides object storage with industry-leading scalability, data availability, security, and performance. In TigerGraph Cloud 4, S3 is also utilized to store graph data and backups, offering a highly durable and cost-effective storage solution.

== Data Encryption and Charges
All data stored on AWS services is encrypted-at-rest using platform-managed keys to ensure data security and compliance.

== Next Steps

Learn how much it costs to run TigerGraph Cloud 4 on AWS in xref:cloud4:overview:pricing.adoc[].
5 changes: 5 additions & 0 deletions modules/cloud4/modules/resources/pages/azure.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Microsoft Azure

We do not support Azure at this time, we are actively working on it. Please check back soon.

Please refer to the xref:cloud4:resources:aws.adoc[AWS] for more information.
6 changes: 3 additions & 3 deletions modules/cloud4/modules/resources/pages/faqs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ TigerGraph Cloud 4 stands out among Database-as-a-Service (DBaaS) offerings due
** RESTful API: Access and interact with your graph database using a comprehensive RESTful API.
* Competitive Edge
** Performance: TigerGraph Cloud 4 is optimized for high performance, handling complex queries and large datasets efficiently.
** Flexibility: Support for various deployment options and cloud platforms including AWS, Azure, and GCP.
** Flexibility: Support for various deployment options.
** Community and Support: Access to a vibrant community of users and dedicated support from TigerGraph experts.

In summary, TigerGraph Cloud 4 offers a robust, scalable, and high-performance graph database solution with a wide range of features and tools that set it apart from other DBaaS offerings. Whether you are looking for advanced analytics, ease of use, or scalability, TigerGraph Cloud provides the capabilities you need to succeed.
Expand All @@ -70,7 +70,7 @@ A: There are free credits but no free instances at TigerGraph Cloud 4. You can c

=== *Q: In what cloud platforms and regions does TigerGraph Cloud 4 operate?*

A: TigerGraph Cloud 4 currently only operates on Amazon Web Services (AWS), GCP and Azure are not supported yet. Visit each platform's reference page to learn more about the available regions.
A: TigerGraph Cloud 4 currently only operates on xref:cloud4:resources:aws.adoc[], xref:cloud4:resources:gcp.adoc[] and xref:cloud4:resources:azure.adoc[] are not supported yet. Visit each platform's reference page to learn more about the available regions.

=== *Q: Can I choose different versions of TigerGraph on TigerGraph Cloud 4?*

Expand Down Expand Up @@ -117,7 +117,7 @@ See TigerGraph's xref:cloud4:workgroup-workspace:workgroups/monitor.adoc[Monitor

=== *Q: Is TigerGraph Cloud cloud-agnostic?*

A: While TigerGraph Cloud 4 currently operates on AWS only, we are actively developing support for Azure and GCP. It is not entirely cloud-agnostic as it leverages specific services and integrations from these cloud providers. If you require immediate assistance managing TigerGraph on another cloud provider, please contact link:mailto:[email protected][[email protected]].
A: While TigerGraph Cloud 4 currently operates on xref:cloud4:resources:aws.adoc[] only, we are actively developing support for xref:cloud4:resources:gcp.adoc[] and xref:cloud4:resources:azure.adoc[]. It is not entirely cloud-agnostic as it leverages specific services and integrations from these cloud providers. If you require immediate assistance managing TigerGraph on another cloud provider, please contact link:mailto:[email protected][[email protected]].


=== *Q: Is the support for TigerGraph Cloud the same as the support for TigerGraph Enterprise?*
Expand Down
5 changes: 5 additions & 0 deletions modules/cloud4/modules/resources/pages/gcp.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Google Cloud Platform (GCP)

We do not support GCP at this time, we are actively working on it. Please check back soon.

Please refer to the xref:cloud4:resources:aws.adoc[AWS] for more information.

0 comments on commit 0739fd6

Please sign in to comment.