Skip to content

Commit

Permalink
Merge branch 'main' into update-hubspot-link
Browse files Browse the repository at this point in the history
  • Loading branch information
emile-00 authored Dec 17, 2024
2 parents 3f25f54 + 0509fac commit e93703c
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -424,18 +424,18 @@
"pages": [
"processing/overview",
{
"group": "SQL",
"group": "SQL patterns",
"pages": [
"processing/sql/dynamic-filters",
"processing/sql/temporal-filters",
"processing/sql/joins",
"processing/sql/time-windows",
"processing/sql/top-n-by-group",
"processing/sql/transactions",
"processing/sql/sql-references"
]
},
"processing/deletes-and-updates",
"processing/transactions",
"processing/maintain-wide-table-with-table-sinks",
"processing/watermarks",
"processing/emit-on-window-close",
Expand Down
2 changes: 1 addition & 1 deletion processing/sql/sql-references.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
title: SQL references
title: Full SQL references
url: /sql/overview
---
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Transactions in databases refer to logical units of work that consist of one or

RisingWave supports read-only transactions, where all reads within a transaction are executed against the consistent Hummock snapshot. Hummock is the LSM-Tree-based storage engine in RisingWave that is specifically optimized for streaming workloads.

To initiate a transaction, use either the `START TRANSACTION READ ONLY` or `BEGIN READ ONLY` command. Subsequently, you can execute queries to read data from the consistent snapshot. To finalize the transaction and submit the queries as a single unit, use the `COMMIT` command.
To initiate a transaction, use either the [`START TRANSACTION READ ONLY`](/sql/commands/sql-start-transaction) or [`BEGIN READ ONLY`](/sql/commands/sql-begin) command. Subsequently, you can execute queries to read data from the consistent snapshot. To finalize the transaction and submit the queries as a single unit, use the [`COMMIT`](/sql/commands/sql-commit) command.

Please note that data modifications are not allowed while a transaction is initiated but not yet committed. The statements listed below are not allowed within a transaction:

Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-begin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "BEGIN"
description: "RisingWave supports read-only transactions. You can use the `BEGIN READ ONLY` command to start a read-only transaction."
---

For more information about transactions in RisingWave, see [Transactions](/processing/sql/transactions).
For more information about transactions in RisingWave, see [Transactions](/processing/transactions).

The `BEGIN` command starts the read-write transaction mode, which is not supported yet in RisingWave. For compatibility reasons, this command will still succeed but no transaction is actually started. That is why you need to specify the `READ ONLY` option to start a transaction in read-only mode.

Expand All @@ -23,7 +23,7 @@ BEGIN
## Related topics

<CardGroup>
<Card title="Transactions" icon="rotate" href="/processing/sql/transactions"
<Card title="Transactions" icon="rotate" href="/processing/transactions"
iconType="solid" horizontal/>
<Card title="START TRANSACTION" icon="play" href="/sql/commands/sql-start-transaction" iconType="solid"horizontal/>
<Card title="COMMIT" icon="check" href="/sql/commands/sql-commit"iconType="solid"horizontal/>
Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-commit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "COMMIT"
description: "RisingWave supports read-only transactions. You can use the `COMMIT` command to commit the current transaction."
---

For more information about transactions in RisingWave, see [Transactions](/processing/sql/transactions).
For more information about transactions in RisingWave, see [Transactions](/processing/transactions).

You can start a read-only transaction by using the `BEGIN READ ONLY` or `START TRANSACTION READ ONLY` command.

Expand All @@ -28,7 +28,7 @@ COMMIT
title="Transactions"
icon="rotate"
iconType="solid"
href="/processing/sql/transactions"
href="/processing/transactions"
horizontal
/>
<Card
Expand Down
4 changes: 2 additions & 2 deletions sql/commands/sql-start-transaction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "START TRANSACTION"
description: "RisingWave supports read-only transactions. You can use the `START TRANSACTION READ ONLY` command to start a read-only transaction. For more information about transactions in RisingWave, see [Transactions](/processing/sql/transactions)."
description: "RisingWave supports read-only transactions. You can use the `START TRANSACTION READ ONLY` command to start a read-only transaction. For more information about transactions in RisingWave, see [Transactions](/processing/transactions)."
---

The `START TRANSACTION` command starts the read-write transaction mode, which is not supported yet in RisingWave. For compatibility reasons, this command will still succeed but no transaction is actually started. That is why you need to specify the `READ ONLY` option to start a transaction in read-only mode.
Expand Down Expand Up @@ -36,7 +36,7 @@ START_TRANSACTION
title="Transactions"
icon="exchange"
iconType="solid"
href="/processing/sql/transactions"
href="/processing/transactions"
horizontal
/>

Expand Down

0 comments on commit e93703c

Please sign in to comment.