Skip to content

Commit 5a9b1f8

Browse files
welpie21welpie21
authored
Merge branch 'main' into doc-371/php-sdk-documentation
2 parents d68e611 + 6b82535 commit 5a9b1f8

File tree

29 files changed

+890
-43
lines changed

29 files changed

+890
-43
lines changed

Diff for: ‎src/components/shared/MarkdownContainer.astro

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const { class: className } = Astro.props;
99
<style>
1010
.flag-markdown {
1111
& :global(h1), & :global(h2), & :global(h3), & :global(h4), & :global(h5), & :global(h6) {
12-
@apply items-center mb-4 mt-10;
12+
@apply items-center mb-4;
1313
scroll-margin-top: 2rem;
1414
}
1515

Diff for: ‎src/content/doc-cloud/faqs/index.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Surreal Cloud offers the power and flexibility of SurrealDB without the pain of
2121
Getting started is easy. [Sign up for an account on Surrealist](https://surrealist.app/cloud/). Once registered, you can access the dashboard, choose services, and start building with Surreal Cloud immediately.
2222

2323
### Are there self-help resources like documentation or tutorials available?
24-
Yes. We have a [resource hub with all our latest documentation](/docs). We also recommend our [YouTube channel](https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w) where you can find easy-to-follow tutorials, and content from our Community.
24+
Yes. We have a [resource hub with all our latest documentation](/docs/). We also recommend our [YouTube channel](https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w) where you can find easy-to-follow tutorials, and content from our Community.
2525

2626

2727
### What kind of support is available at the launch of Surreal Cloud?
@@ -180,7 +180,7 @@ If you are unable to connect to Surreal Cloud, please check the following:
180180

181181
You can find a variety of resources to help you learn more about SurrealDB via [our website]() including:
182182

183-
- [SurrealDB Docs](/docs): Comprehensive guides and references for all features, including docs to accompany [Surrealist](/docs/cloud)
183+
- [SurrealDB Docs](/docs/): Comprehensive guides and references for all features, including docs to accompany [Surrealist](/docs/cloud)
184184
- [YouTube Channel](https://youtube.com/surrealdb): Stay up-to-date with the latest releases, learn new skills and discover what other developers are building with SurrealDB.
185185
- [SurrealDB University](/learn): A self-paced video course with hands-on labs and interactive tutorials.
186186
- [SurrealDB Book](/learn/book): An in-depth, story-driven guide to mastering SurrealDB.

Diff for: ‎src/content/doc-sdk-dotnet/methods/index.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,23 @@ This page lists out the methods that are available in the SurrealDB class.
5252
<tbody>
5353
<tr>
5454
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/methods/query"> <code>db.Query&lt;T&gt;(sql)</code></a></td>
55-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database</td>
55+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database</td>
5656
</tr>
5757
<tr>
5858
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/methods/raw-query"> <code>db.RawQuery&lt;T&gt;(sql, vars)</code></a></td>
59-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database, based on a raw SurrealQL query</td>
59+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database, based on a raw SurrealQL query</td>
6060
</tr>
6161
<tr>
6262
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/methods/select"> <code>db.Select&lt;T&gt;(thing)</code></a></td>
6363
<td scope="row" data-label="Description">Selects all records in a table, or a specific record</td>
6464
</tr>
6565
<tr>
6666
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/core/streaming#live-query"> <code>db.LiveQuery&lt;T&gt;(sql)</code></a></td>
67-
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql/)</td>
67+
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql)</td>
6868
</tr>
6969
<tr>
7070
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/core/streaming#live-raw-query"> <code>db.LiveRawQuery&lt;T&gt;(sql)</code></a></td>
71-
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql/), based on a raw SurrealQL query</td>
71+
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql), based on a raw SurrealQL query</td>
7272
</tr>
7373
<tr>
7474
<td scope="row" data-label="Method"><a href="/docs/sdk/dotnet/core/streaming#live-table"> <code>db.LiveTable&lt;T&gt;(table, diff)</code></a></td>

Diff for: ‎src/content/doc-sdk-dotnet/methods/run.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Label from "@components/shared/Label.astro";
99

1010
# `.Run()` {#run}
1111

12-
Runs a [SurrealQL function](/docs/surrealql/functions/database/).
12+
Runs a [SurrealQL function](/docs/surrealql/functions/database).
1313

1414
```csharp title="Method Syntax"
1515
await db.Run(name, version, args)
@@ -31,7 +31,7 @@ await db.Run(name, version, args)
3131
<Label label="required" />
3232
</td>
3333
<td colspan="2" scope="col" scope="row" data-label="Description">
34-
The name of the [SurrealQL function](/docs/surrealql/functions/database/).
34+
The name of the [SurrealQL function](/docs/surrealql/functions/database).
3535
</td>
3636
</tr>
3737
<tr>
@@ -40,7 +40,7 @@ await db.Run(name, version, args)
4040
<Label label="optional" />
4141
</td>
4242
<td colspan="2" scope="col" scope="row" data-label="Description">
43-
The version of the [SurrealQL function](/docs/surrealql/functions/database/).
43+
The version of the [SurrealQL function](/docs/surrealql/functions/database).
4444
</td>
4545
</tr>
4646
<tr>
@@ -49,7 +49,7 @@ await db.Run(name, version, args)
4949
<Label label="optional" />
5050
</td>
5151
<td colspan="2" scope="col" scope="row" data-label="Description">
52-
The arguments used by the [SurrealQL function](/docs/surrealql/functions/database/).
52+
The arguments used by the [SurrealQL function](/docs/surrealql/functions/database).
5353
</td>
5454
</tr>
5555
<tr>

Diff for: ‎src/content/doc-sdk-golang/methods/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,19 +54,19 @@ This page lists out the methods that are available in the SurrealDB class.
5454
<tbody>
5555
<tr>
5656
<td scope="row" data-label="Method"><a href="/docs/sdk/golang/methods/query"> <code>db.Query&#91;T&#93;(sql string, vars ...interface{})</code></a></td>
57-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database</td>
57+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database</td>
5858
</tr>
5959
<tr>
6060
<td scope="row" data-label="Method"><a href="/docs/sdk/golang/methods/raw-query"> <code>db.RawQuery&#91;T&#93;(sql, vars)</code></a></td>
61-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database, based on a raw SurrealQL query</td>
61+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database, based on a raw SurrealQL query</td>
6262
</tr>
6363
<tr>
6464
<td scope="row" data-label="Method"><a href="/docs/sdk/golang/methods/select"> <code>db.Select&#91;T,R&#93;(resource)</code></a></td>
6565
<td scope="row" data-label="Description">Selects all records in a table, or a specific record</td>
6666
</tr>
6767
<tr>
6868
<td scope="row" data-label="Method"><a href="/docs/sdk/golang/methods/live"> <code>db.Live&#91;T&#93;(table, diff)</code></a></td>
69-
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql/)</td>
69+
<td scope="row" data-label="Description">Initiate a live query from a [SurrealQL statement](/docs/surrealql)</td>
7070
</tr>
7171
<tr>
7272
<td scope="row" data-label="Method"><a href="/docs/sdk/golang/methods/live_notification"> <code>db.LiveNotifications&#91;T&#93;(queryUuid)</code></a></td>

Diff for: ‎src/content/doc-sdk-javascript/methods/query.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Label from "@components/shared/Label.astro";
99

1010
# `.query()` {#query}
1111

12-
Runs a set of [SurrealQL statements](/docs/surrealql/) against the database.
12+
Runs a set of [SurrealQL statements](/docs/surrealql) against the database.
1313

1414
```ts title="Method Syntax"
1515
db.query<T>(query, vars)

Diff for: ‎src/content/doc-sdk-php/core/data-querying.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from "@components/Tabs/TabItem.astro";
1111
# Data Querying
1212

1313
The methods below are used to interact with the database and perform CRUD operations.
14-
You can also use the [`query`](/docs/sdk/php/methods/query) method to run [SurrealQL statements](/docs/surrealql/statements/) against the database.
14+
You can also use the [`query`](/docs/sdk/php/methods/query) method to run [SurrealQL statements](/docs/surrealql/statements) against the database.
1515

1616
## Creating records
1717

Diff for: ‎src/content/doc-sdk-php/methods/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This page lists out the methods that are available in the SurrealDB class.
5656
<tbody>
5757
<tr>
5858
<td scope="row" data-label="Function"><a href="/docs/sdk/php/methods/query"> <code>$db->query($sql,$vars)</code></a></td>
59-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database</td>
59+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database</td>
6060
</tr>
6161
<tr>
6262
<td scope="row" data-label="Function"><a href="/docs/sdk/php/methods/select"> <code>$db->select($thing)</code></a></td>

Diff for: ‎src/content/doc-sdk-php/methods/query.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Label from "@components/shared/Label.astro";
99

1010
# `->query()` {#query}
1111

12-
Runs a set of [SurrealQL statements](/docs/surrealql/) against the database.
12+
Runs a set of [SurrealQL statements](/docs/surrealql) against the database.
1313

1414
```php title="Method Syntax"
1515
$db->query($query, $vars)

Diff for: ‎src/content/doc-sdk-python/concepts/writing-surrealql.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The methods below are used to interact with the database and perform CRUD operat
3131

3232
# `.query()`
3333

34-
Runs a set of [SurrealQL statements](/docs/surrealql/) against the database.
34+
Runs a set of [SurrealQL statements](/docs/surrealql) against the database.
3535

3636
```python title="Method Syntax"
3737
db.query(query, vars)

Diff for: ‎src/content/doc-sdk-python/methods/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ This page lists out the methods that are available. Both classes have the same m
5858
<tbody>
5959
<tr>
6060
<td scope="row" data-label="Method"><a href="/docs/sdk/python/methods/query"> <code>db.query(sql,vars)</code></a></td>
61-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database</td>
61+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database</td>
6262
</tr>
6363
<tr>
6464
<td scope="row" data-label="Method"><a href="/docs/sdk/python/methods/select"> <code>db.select(thing)</code></a></td>

Diff for: ‎src/content/doc-sdk-python/methods/query.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Label from "@components/shared/Label.astro";
99

1010
# `.query()`
1111

12-
Runs a set of [SurrealQL statements](/docs/surrealql/) against the database.
12+
Runs a set of [SurrealQL statements](/docs/surrealql) against the database.
1313

1414
```python title="Method Syntax"
1515
db.query(query, vars)

Diff for: ‎src/content/doc-sdk-rust/methods/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Most methods in the SurrealDB SDK involve either working with or creating an ins
5858
<tbody>
5959
<tr>
6060
<td scope="row" data-label="Function"><a href="/docs/sdk/rust/methods/query"> <code>db.query()</code></a></td>
61-
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql/) against the database</td>
61+
<td scope="row" data-label="Description">Runs a set of [SurrealQL statements](/docs/surrealql) against the database</td>
6262
</tr>
6363
<tr>
6464
<td scope="row" data-label="Function"><a href="/docs/sdk/rust/methods/run"> <code>db.run()</code></a></td>

Diff for: ‎src/content/doc-surrealdb/faqs/known-issues.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Here are some known bugs and issues with SurrealDB.
1717
- **Affected versions:** 1.x
1818
- **Fixed versions:** -
1919

20-
Some query functionality is not yet available in the SDKs. Such as `IF EXISTS` and `IF NOT EXISTS` clauses in the [`DEFINE` statement](/docs/surrealql/statements/define/). This means that if you used these clauses in your query method (as seen in the example below), the SDK would not be able to parse the query correctly.
20+
Some query functionality is not yet available in the SDKs. Such as `IF EXISTS` and `IF NOT EXISTS` clauses in the [`DEFINE` statement](/docs/surrealql/statements/define). This means that if you used these clauses in your query method (as seen in the example below), the SDK would not be able to parse the query correctly.
2121

2222
```js
2323
await db.query(

Diff for: ‎src/content/doc-surrealdb/installation/upgrading/migrating-data-to-2.x.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ This guide will help you upgrade your current SurrealDB installation to the late
2424
- The `DEFINE SCOPE` statement has been dropped in favor for the new [`DEFINE ACCESS TYPE RECORD`](/docs/surrealql/statements/define/access/record) statement
2525
- `DEFINE TOKEN` definitions defined under scopes are now integrated into `DEFINE ACCESS TYPE RECORD`.
2626
- Some functions have been renamed for clarity
27-
- `meta::tb()` -> [`record::tb()`](/docs/surrealql/functions/database/record/#recordtb)
28-
- `meta::id()` -> [`record::id()`](/docs/surrealql/functions/database/record/#recordid)
29-
- `string::endsWith()` -> [`string::ends_with()`](/docs/surrealql/functions/database/string/#stringends_with)
30-
- `string::startsWith()` -> [`string::starts_with()`](/docs/surrealql/functions/database/string/#stringstarts_with)
27+
- `meta::tb()` -> [`record::tb()`](/docs/surrealql/functions/database/record)
28+
- `meta::id()` -> [`record::id()`](/docs/surrealql/functions/database/record)
29+
- `string::endsWith()` -> [`string::ends_with()`](/docs/surrealql/functions/database/string)
30+
- `string::startsWith()` -> [`string::starts_with()`](/docs/surrealql/functions/database/string)
3131

3232
### Authentication & Headers
3333
- Authentication is now enabled by default as you previously would with `--auth`. The [`--unauthenticated`](/docs/surrealdb/cli/start#unauthenticated-mode) flag is now required in order to provide the previous default behavior.

Diff for: ‎src/content/doc-surrealdb/integration/http.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2583,7 +2583,7 @@ curl -X GET \
25832583

25842584
<Since v="v2.2.0" />
25852585
> [!CAUTION]
2586-
> Currently, this is an experimental feature as such, it may be subject to breaking changes and may present unidentified security issues. Do not rely on this feature in production applications. To enable this, set the `SURREAL_CAPS_ALLOW_EXPERIMENTAL` [environment variable](/docs/surrealdb/cli/start/#experimental-capabilities) to `define_api`.
2586+
> Currently, this is an experimental feature as such, it may be subject to breaking changes and may present unidentified security issues. Do not rely on this feature in production applications. To enable this, set the `SURREAL_CAPS_ALLOW_EXPERIMENTAL` [environment variable](/docs/surrealdb/cli/start) to `define_api`.
25872587
25882588

25892589
A custom endpoint can be set using a [`DEFINE API`](/docs/surrealql/statements/define/api) statement. The possible HTTP methods (GET, PUT, etc.) are set using the statement itself. The path begins with `/api`, continues with the namespace and database, and ends with a custom endpoint that can include both static and dynamic path segments.

Diff for: ‎src/content/doc-surrealdb/introduction/start.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The advantage of using SurrealDB lies in its ability to adapt to your needs, rat
5050

5151
Much like any other database, you can communicate with SurrealDB by executing queries.
5252

53-
Queries are written using [SurrealQL](/docs/surrealql/), SurrealDB's powerful and flexible query language. While SurrealQL takes inspiration from traditional SQL, it is designed to be more expressive and flexible, allowing you to query your data in a variety of ways.
53+
Queries are written using [SurrealQL](/docs/surrealql), SurrealDB's powerful and flexible query language. While SurrealQL takes inspiration from traditional SQL, it is designed to be more expressive and flexible, allowing you to query your data in a variety of ways.
5454

5555
Let's take a look at some of the basic queries you can run in SurrealDB.
5656

0 commit comments

Comments
 (0)