From 14fed9ed3de0fcc86ae84513fe3784b13ef57b6b Mon Sep 17 00:00:00 2001 From: Pratim Date: Wed, 10 Apr 2024 18:55:51 +0200 Subject: [PATCH] Update and rename websocket.mdx to rpc.mdx (#468) --- .../integration/{websocket.mdx => rpc.mdx} | 18 ++++++------------ .../version-1.x/surrealql/statements/live.mdx | 2 +- 2 files changed, 7 insertions(+), 13 deletions(-) rename doc-surrealdb_versioned_docs/version-1.x/integration/{websocket.mdx => rpc.mdx} (98%) diff --git a/doc-surrealdb_versioned_docs/version-1.x/integration/websocket.mdx b/doc-surrealdb_versioned_docs/version-1.x/integration/rpc.mdx similarity index 98% rename from doc-surrealdb_versioned_docs/version-1.x/integration/websocket.mdx rename to doc-surrealdb_versioned_docs/version-1.x/integration/rpc.mdx index c25af3b56..3f59fe26c 100644 --- a/doc-surrealdb_versioned_docs/version-1.x/integration/websocket.mdx +++ b/doc-surrealdb_versioned_docs/version-1.x/integration/rpc.mdx @@ -1,19 +1,13 @@ --- sidebar_position: 1 -sidebar_label: WebSocket -title: WebSocket Protocol | Integration -description: The WebSocket protocol allows for easy bi-directional communication with SurrealDB. +sidebar_label: RPC Protocol +title: RPC Protocol | Integration +description: The RPC protocol allows for easy bi-directional communication with SurrealDB. --- -# WebSocket (text protocol) +# RPC Protocol -The WebSocket protocol allows for easy bi-directional communication with SurrealDB. This allows you to maintain a single connection to run all your queries, but also opens up the possibility of Live Queries! - -:::note -Live queries are still under development, though available soon. -::: - -
+The RPC protocol allows for easy bi-directional communication with SurrealDB. This allows you to maintain a single connection to run all your queries, but also opens up the possibility of Live Queries! @@ -1272,4 +1266,4 @@ Notice how the deleted record is being returned here "name": "John Doe" } } -``` \ No newline at end of file +``` diff --git a/doc-surrealdb_versioned_docs/version-1.x/surrealql/statements/live.mdx b/doc-surrealdb_versioned_docs/version-1.x/surrealql/statements/live.mdx index 6ca13f2e8..a5c336136 100644 --- a/doc-surrealdb_versioned_docs/version-1.x/surrealql/statements/live.mdx +++ b/doc-surrealdb_versioned_docs/version-1.x/surrealql/statements/live.mdx @@ -46,7 +46,7 @@ You will want to keep track of this ID, so that you can differentiate between di You can also use this UUID to [KILL (stop)](/docs/surrealdb/surrealql/statements/kill) the Live Query. The protocol will then send messages that are of a Notification format. -You can find an example of such a message in the [Live Query WebSocket protocol](/docs/surrealdb/integration/websocket#live) description. +You can find an example of such a message in the [Live Query WebSocket protocol](/docs/surrealdb/integration/rpc#live) description. ### Diff