Skip to content

Commit

Permalink
Docs: Add links to SurrealQL docs (#837)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ekwuno authored Sep 10, 2024
1 parent ecbf4f0 commit 8fc3b98
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

# SurrealQL via CLI

In this section, you will explore writing SurrealQL queries using the SurrealDB CLI. To get started, you will need to install the SurrealDB CLI on your local machine. You can do this by following the instructions in the [installation section](/docs/surrealdb/cli).
In this section, you will explore writing [SurrealQL](/docs/surrealql) queries using the SurrealDB CLI. To get started, you will need to install the SurrealDB CLI on your local machine. You can do this by following the instructions in the [installation section](/docs/surrealdb/cli).

The CLI provides allows you to write, execute, and visualize SurrealQL queries in real-time.
The CLI provides allows you to write, execute, and visualize [SurrealQL](/docs/surrealql) queries in real-time.

## Getting Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,19 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

# SurrealQL

In this section, you will explore SurrealQL, a powerful database query language that closely resembles traditional SQL but comes with unique differences and improvements.
In this section, you will explore [SurrealQL](/docs/surrealql), a powerful database query language that closely resembles traditional SQL but comes with unique differences and improvements.

SurrealQL is designed to provide developers with a seamless and intuitive way to interact with SurrealDB. It offers a familiar syntax and supports various statement types, allowing you to perform complex database operations efficiently.
[SurrealQL](/docs/surrealql) is designed to provide developers with a seamless and intuitive way to interact with SurrealDB. It offers a familiar syntax and supports various statement types, allowing you to perform complex database operations efficiently.

While SurrealQL shares similarities with traditional SQL, it introduces enhancements and optimizations that make it well-suited for working with SurrealDB's advanced features. Whether you are querying data, modifying records, or managing database structures, SurrealQL provides a comprehensive set of capabilities to meet your needs.


## Getting Started

To start using SurrealQL, [refer to the documentation on the various statement types and their syntax](/docs/surrealql/statements). The statements page provides comprehensive examples and explanations for each statement type, helping you understand how to construct queries and interact with SurrealDB effectively.

We hope that SurrealQL empowers you to leverage the full potential of SurrealDB and enables you to build robust and scalable applications. Let's dive into the world of SurrealQL and unlock the capabilities of SurrealDB together!

## Key Features

SurrealQL offers several key features that make it a powerful tool for working with SurrealDB:
Expand All @@ -50,17 +57,11 @@ SurrealQL offers several key features that make it a powerful tool for working w
}}
/>

## Getting Started

To start using SurrealQL, [refer to the documentation on the various statement types and their syntax](/docs/surrealql/statements). The statements page provides comprehensive examples and explanations for each statement type, helping you understand how to construct queries and interact with SurrealDB effectively.

We hope that SurrealQL empowers you to leverage the full potential of SurrealDB and enables you to build robust and scalable applications. Let's dive into the world of SurrealQL and unlock the capabilities of SurrealDB together!

## Resources

To learn more about SurrealQL and how to use it effectively, check out the following resources:

- [Select Statement](/docs/surrealql/statements/select): Learn how to retrieve data from your SurrealDB database using the `SELECT` statement and explore various querying options:
<div class="video-container">
<iframe width="560" height="315" src="https://www.youtube.com/embed/TyX45cyZ-W0?si=S9M59afDEiqxeC5d" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
</div>
- [SurrealQL documentation](/docs/surrealql)
- [SurrealQL statements](/docs/surrealql/statements)
- [SurrealQL database functions](/docs/surrealql/functions/database)
- [SurrealQL operators](/docs/surrealql/operators)
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ import useBaseUrl from '@docusaurus/useBaseUrl';

# SurrealQL via Surrealist

In this section, you will explore writing SurrealQL queries using [Surrealist](https://surrealist.app/query), the official query editor for SurrealDB. Surrealist is a powerful tool that allows you to write, execute, and visualize SurrealQL queries in real-time.
In this section, you will explore writing [SurrealQL](/docs/surrealql) queries using [Surrealist](https://surrealist.app/query), the official query editor for SurrealDB. Surrealist is a powerful tool that allows you to write, execute, and visualize SurrealQL queries in real-time.

The Surrealist query editor provides a rich set of features, including syntax highlighting, query validation, and query execution. You can also view the query results in a tabular format, making it easy to analyze and visualize the data.

:::note
__Note:__ Learn more about SurrealQL by exploring the [SurrealQL documentation](/docs/surrealql).
:::
## Getting Started

To get started with SurrealQL in Surrealist, go to the [Surrealist Query Editor](https://surrealist.app/query) and start writing your SurrealQL queries. You can use the query editor to write queries, execute them, and view the results in real-time.
Expand Down

0 comments on commit 8fc3b98

Please sign in to comment.