Skip to content

Commit

Permalink
Improve integration documentation (#1079)
Browse files Browse the repository at this point in the history
  • Loading branch information
macjuul authored Dec 17, 2024
1 parent 6c8d604 commit b769e45
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 8 deletions.
6 changes: 3 additions & 3 deletions src/content/doc-surrealdb/integration/cbor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ title: CBOR Protocol| Integration
description: SurrealDB supports a number of methods for connecting to the database and performing data queries.
---

# CBOR
# CBOR Protocol

SurrealDB Supports the CBOR protocol, shipped with an additional couple of custom tags.
SurrealDB extends the [CBOR](https://www.rfc-editor.org/rfc/rfc8949.html) protocol with a number of custom tags to support the full range of data types available in SurrealDB. This document provides an overview of the custom tags and their respective values.

## References:
- CBOR Protocol - [RFC 8949](https://www.rfc-editor.org/rfc/rfc8949.html)
- CBOR Official Tags - [Iana](https://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml)

## Tags Overview
## Custom tags

<table>
<thead>
Expand Down
6 changes: 4 additions & 2 deletions src/content/doc-surrealdb/integration/http.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ import Label from "@components/shared/Label.astro";

# HTTP & Rest

The HTTP endpoints enable simple selection and modifications of all records or a single record in a table, in addition to support for custom SurrealQL queries with multiple statements, using traditional RESTful HTTP url endpoints.
The HTTP endpoints exposed by SurrealDB instances provide a simple way to interact with the database over a traditional RESTful interface. This includes selecting and modifying one or more records, executing custom SurrealQL queries, and managing SurrealML models. The endpoints are designed to be simple and easy to use in stateless environments, making them ideal for lightweight applications where a persistent database connection is not required.

## Accessing Endpoints via Postman
## Getting started via Postman

The most convenient way to access these endpoints is via SurrealDB's Postman Collection. To do so, follow these steps:

Expand All @@ -27,6 +27,8 @@ The most convenient way to access these endpoints is via SurrealDB's Postman Col
> [!IMPORTANT]
> Ensure that your URL is set correctly, if running locally, the URL should be `http://localhost:8000`.By default, the URL is set to local. Start your server using the [`surreal start`](/docs/surrealdb/cli/start) command in the CLI or through Surrealist's [local database serving](/docs/surrealist/concepts/local-database-serving) functionality, before querying the endpoints.
## Supported methods

You can use the HTTP endpoints to perform the following actions:

<br />
Expand Down
2 changes: 1 addition & 1 deletion src/content/doc-surrealdb/integration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In this section, you will explore the various integration options and techniques

## Introduction

SurrealDB is designed to be flexible and compatible with a wide range of technologies and frameworks. This section will guide you through the process of integrating SurrealDB into your projects, whether you are working with JavaScript /TypeScript, Python, React, Node.js, or other popular technologies.
SurrealDB is designed to be flexible and compatible with a wide range of technologies and frameworks. This section will guide you through the process of integrating SurrealDB into your projects, whether you are working directly from code, or integrating with one of our supported network protocols.

## API Reference

Expand Down
6 changes: 5 additions & 1 deletion src/content/doc-surrealdb/integration/rpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ import Label from "@components/shared/Label.astro";

# RPC Protocol

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!
The RPC protocol allows for network-protocol agnostic communication with SurrealDB. It is used internally by our client SDKs, and supports both HTTP and WebSocket based communication. Combined with the power of our [CBOR protocol](./cbor) specification, the RPC protocol provides a fully type-safe and efficient way to interact with SurrealDB over the network.

## Supported methods

You can use the RPC protocol to perform the following actions:

<table>
<thead>
Expand Down
2 changes: 1 addition & 1 deletion src/content/doc-surrealdb/integration/sdks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ import DarkWasm from "@img/icon/dark/webassembly.png";

# SDKs

SurrealDB supports a number of methods for connecting to the database and performing data queries.
SurrealDB supports numerous client SDKs for connecting to the database and performing data queries. These SDKs are designed to simplify the integration process and provide developers with the tools they need to interact with SurrealDB from their preferred programming languages.

<Boxes>
<IconBox
Expand Down

0 comments on commit b769e45

Please sign in to comment.