@@ -95,14 +112,14 @@ View the [features](https://surrealdb.com/features), the latest [releases](https
- [Features](#features)
- [Documentation](#documentation)
+- [Getting started](#getting-started)
+ - [Server side code](#server-side-code)
+ - [Client side apps](#client-side-apps)
- [Installation](#installation)
- [Install on macOS](#install-on-macos)
- [Install on Linux](#install-on-linux)
- [Install on Windows](#install-on-windows)
- [Run using Docker](#run-using-docker)
-- [Getting started](#getting-started)
- - [Server side code](#server-side-code)
- - [Client side apps](#client-side-apps)
- [Quick look](#quick-look)
- [Why SurrealDB](#why-surrealdb)
- [Database, API, and permissions](#database-api-and-permissions)
@@ -138,13 +155,53 @@ View the [features](https://surrealdb.com/features), the latest [releases](https
For guidance on installation, development, deployment, and administration, see our [documentation](https://surrealdb.com/docs).
+
Getting started
+
+Getting started with SurrealDB is as easy as starting up the SurrealDB database server, choosing your platform, and integrating its SDK into your code. You can easily get started with your platform of choice by reading one of our tutorials.
+
+##### Server side code
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+##### Client side apps
+
+
+
+
+
+
+
+
+
+
+
+
+
Installation
SurrealDB is designed to be simple to install and simple to run - using just one command from your terminal. In addition to traditional installation, SurrealDB can be installed and run with HomeBrew, Docker, or using any other container orchestration tool such as Docker Compose, Docker Swarm, Rancher, or in Kubernetes.
-
- Install on macOS
-
+
Install on macOS
The quickest way to get going with SurrealDB on macOS is to use Homebrew. This will install both the command-line tools, and the SurrealDB server as a single executable. If you don't use Homebrew, follow the instructions for Linux below to install SurrealDB.
@@ -152,9 +209,13 @@ The quickest way to get going with SurrealDB on macOS is to use Homebrew. This w
brew install surrealdb/tap/surreal
```
-
- Install on Linux
-
+If you want to test a version with the latest features, published every night, install the `nightly` version:
+
+```bash
+brew install surrealdb/tap/surreal-nightly
+```
+
+
Install on Linux
The easiest and preferred way to get going with SurrealDB on Unix operating systems is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions.
@@ -162,15 +223,19 @@ The easiest and preferred way to get going with SurrealDB on Unix operating syst
curl --proto '=https' --tlsv1.2 -sSf https://install.surrealdb.com | sh
```
-If you want a binary newer than what's currently released, you can install the nightly one.
+If you want to run a beta release, before the next version is released, the `beta` version:
+
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://install.surrealdb.com | sh -s -- --beta
+```
+
+If you want to test a version with the latest features, published every night, install the `nightly` version:
```bash
curl --proto '=https' --tlsv1.2 -sSf https://install.surrealdb.com | sh -s -- --nightly
```
-
- Install on Windows
-
+
Install on Windows
The easiest and preferred way to get going with SurrealDB on Windows is to install and use the SurrealDB command-line tool. Run the following command in your terminal and follow the on-screen instructions.
@@ -178,9 +243,13 @@ The easiest and preferred way to get going with SurrealDB on Windows is to insta
iwr https://windows.surrealdb.com -useb | iex
```
-
- Run using Docker
-
+If you want to test a version with the latest features, published every night, install the `nightly` version:
+
+```ps1
+iex "& { $(irm https://windows.surrealdb.com) } -Nightly"
+```
+
+
Run using Docker
Docker can be used to manage and run SurrealDB database instances without the need to install any command-line tools. The SurrealDB docker container contains the full command-line tools for importing and exporting data from a running server, or for running a server itself.
@@ -194,43 +263,15 @@ For just getting started with a development server running in memory, you can pa
docker run --rm --pull always --name surrealdb -p 8000:8000 surrealdb/surrealdb:latest start --log trace --user root --pass root memory
```
-
Getting started
-
-Getting started with SurrealDB is as easy as starting up the SurrealDB database server, choosing your platform, and integrating its SDK into your code. You can easily get started with your platform of choice by reading one of our tutorials.
-
-##### Server side code
-
-- [x] [Getting started with Javascript](https://surrealdb.com/docs/integration/sdks/javascript)
-- [x] [Getting started with Node.js](https://surrealdb.com/docs/integration/sdks/nodejs)
-- [x] [Getting started with Golang](https://surrealdb.com/docs/integration/sdks/golang)
-- [x] [Getting started with Rust](https://surrealdb.com/docs/integration/sdks/rust)
-- [x] [Getting started with Deno](https://surrealdb.com/docs/integration/sdks/deno)
-- [x] [Getting started with Python](https://surrealdb.com/docs/integration/sdks/python)
-- [x] [Getting started with Java](https://surrealdb.com/docs/integration/sdks/java)
-- [ ] Getting started with C (coming soon)
-- [ ] Getting started with Ruby (coming soon)
-- [ ] Getting started with PHP (coming soon)
-- [ ] Getting started with Swift (coming soon)
-- [ ] Getting started with R (coming soon)
-
-##### Client side apps
-
-- [x] [Getting started with Javascript](https://surrealdb.com/docs/integration/sdks/javascript)
-- [ ] Getting started with Ember.js (coming soon)
-- [ ] Getting started with React.js (coming soon)
-- [ ] Getting started with Angular.js (coming soon)
-- [ ] Getting started with Vue.js (coming soon)
-- [ ] Getting started with Svelte (coming soon)
-
Quick look
With strongly-typed data types, data can be fully modelled right in the database.
```sql
UPDATE person SET
- waist = "34.59",
- height = 201,
- score = 0.3 + 0.3 + 0.3 + 0.1
+ waist = "34",
+ height = 201,
+ score = 0.3 + 0.3 + 0.3 + 0.1
;
```
@@ -238,8 +279,8 @@ Store dynamically computed fields which are calculated when retrieved.
```sql
CREATE person SET
- birthday = "2007-06-22",
- can_drive = { time::now() > birthday + 18y }
+ birthday = "2007-06-22",
+ can_drive = { time::now() > birthday + 18y }
;
```
@@ -260,7 +301,7 @@ DEFINE INDEX email ON TABLE user COLUMNS email UNIQUE;
-- Create a new event whenever a user changes their email address
DEFINE EVENT email ON TABLE user WHEN $before.email != $after.email THEN (
- CREATE event SET user = $value, time = time::now(), value = $after.email, action = 'email_changed'
+ CREATE event SET user = $value, time = time::now(), value = $after.email, action = 'email_changed'
);
```
@@ -269,18 +310,17 @@ Connect records together with fully directed graph edge connections.
```sql
-- Add a graph edge between user:tobie and article:surreal
RELATE user:tobie->write->article:surreal
- SET time.written = time::now()
+ SET time.written = time::now()
;
-- Add a graph edge between specific users and developers
LET $from = (SELECT users FROM company:surrealdb);
LET $devs = (SELECT * FROM user WHERE tags CONTAINS 'developer');
RELATE $from->like->$devs UNIQUE
- SET time.connected = time::now()
+ SET time.connected = time::now()
;
```
-
Query data flexibly with advanced expressions and graph queries.
```sql
@@ -304,15 +344,15 @@ Store GeoJSON geographical data types, including points, lines and polygons.
```sql
UPDATE city:london SET
- centre = (-0.118092, 51.509865),
- boundary = {
- type: "Polygon",
- coordinates: [[
- [-0.38314819, 51.37692386], [0.1785278, 51.37692386],
- [0.1785278, 51.61460570], [-0.38314819, 51.61460570],
- [-0.38314819, 51.37692386]
- ]]
- }
+ centre = (-0.118092, 51.509865),
+ boundary = {
+ type: "Polygon",
+ coordinates: [[
+ [-0.38314819, 51.37692386], [0.1785278, 51.37692386],
+ [0.1785278, 51.61460570], [-0.38314819, 51.61460570],
+ [-0.38314819, 51.37692386]
+ ]]
+ }
;
```
@@ -320,17 +360,17 @@ Write custom embedded logic using JavaScript functions.
```sql
CREATE film SET
- ratings = [
- { rating: 6, user: user:bt8e39uh1ouhfm8ko8s0 },
- { rating: 8, user: user:bsilfhu88j04rgs0ga70 },
- ],
- featured = function() {
- return this.ratings.filter(r => {
- return r.rating >= 7;
- }).map(r => {
- return { ...r, rating: r.rating * 10 };
- });
- }
+ ratings = [
+ { rating: 6, user: user:bt8e39uh1ouhfm8ko8s0 },
+ { rating: 8, user: user:bsilfhu88j04rgs0ga70 },
+ ],
+ featured = function() {
+ return this.ratings.filter(r => {
+ return r.rating >= 7;
+ }).map(r => {
+ return { ...r, rating: r.rating * 10 };
+ });
+ }
;
```
@@ -339,85 +379,90 @@ Specify granular access permissions for client and application access.
```sql
-- Specify access permissions for the 'post' table
DEFINE TABLE post SCHEMALESS
- PERMISSIONS
- FOR select
- -- Published posts can be selected
- WHERE published = true
- -- A user can select all their own posts
- OR user = $auth.id
- FOR create, update
- -- A user can create or update their own posts
- WHERE user = $auth.id
- FOR delete
- -- A user can delete their own posts
- WHERE user = $auth.id
- -- Or an admin can delete any posts
- OR $auth.admin = true
+ PERMISSIONS
+ FOR select
+ -- Published posts can be selected
+ WHERE published = true
+ -- A user can select all their own posts
+ OR user = $auth.id
+ FOR create, update
+ -- A user can create or update their own posts
+ WHERE user = $auth.id
+ FOR delete
+ -- A user can delete their own posts
+ WHERE user = $auth.id
+ -- Or an admin can delete any posts
+ OR $auth.admin = true
;
```
Why SurrealDB?
-#### Database, API, and permissions
+
+
+
+
+
+### Database, API, and permissions
SurrealDB combines the database layer, the querying layer, and the API and authentication layer into one platform. Advanced table-based and row-based customisable access permissions allow for granular data access patterns for different types of users. There's no need for custom backend code and security rules with complicated database development.
-
-
-#### Tables, documents, and graph
+### Tables, documents, and graph
As a multi-model database, SurrealDB enables developers to use multiple techniques to store and model data, without having to choose a method in advance. With the use of tables, SurrealDB has similarities with relational databases, but with the added functionality and flexibility of advanced nested fields and arrays. Inter-document record links allow for simple to understand and highly-performant related queries without the use of JOINs, eliminating the N+1 query problem.
-
+
+
+
+
-#### Advanced inter-document relations and analysis. No JOINs. No pain.
+### Advanced inter-document relations and analysis. No JOINs. No pain.
With full graph database functionality SurrealDB enables more advanced querying and analysis. Records (or vertices) can be connected to one another with edges, each with its own record properties and metadata. Simple extensions to traditional SQL queries allow for multi-table, multi-depth document retrieval, efficiently in the database, without the use of complicated JOINs and without bringing the data down to the client.
-
-
-#### Simple schema definition for frontend and backend development
+### Simple schema definition for frontend and backend development
With SurrealDB, specify your database and API schema in one place, and define column rules and constraints just once. Once a schema is defined, database access is automatically granted to the relevant users. No more custom API code, and no more GraphQL integration. Simple, flexible, and ready for production in minutes not months.
-
+
+
+
+
-#### Connect and query directly from web-browsers and client devices
+### Connect and query directly from web-browsers and client devices
Connect directly to SurrealDB from any end-user client device. Run SurrealQL queries directly within web-browsers, ensuring that users can only view or modify the data that they are allowed to access. Highly-performant WebSocket connections allow for efficient bi-directional queries, responses and notifications.
-
-
-#### Query the database with the tools you want
+### Query the database with the tools you want
Your data, your choice. SurrealDB is designed to be flexible to use, with support for SurrealQL, GraphQL (coming soon), CRUD support over REST, and JSON-RPC querying and modification over WebSockets. With direct-to-client connection with in-built permissions, SurrealDB speeds up the development process, and fits in seamlessly into any tech stack.
-
+
+
+
+
-#### Realtime live queries and data changes direct to application
+### Realtime live queries and data changes direct to application
SurrealDB keeps every client device in-sync with data modifications pushed in realtime to the clients, applications, end-user devices, and server-side libraries. Live SQL queries allow for advanced filtering of the changes to which a client subscribes, and efficient data formats, including DIFFing and PATCHing enable highly-performant web-based data syncing.
-
-
-#### Scale effortlessly to hundreds of nodes for high-availability and scalability
+### Scale effortlessly to hundreds of nodes for high-availability and scalability
SurrealDB can be run as a single in-memory node, or as part of a distributed cluster - offering highly-available and highly-scalable system characteristics. Designed from the ground up to run in a distributed environment, SurrealDB makes use of special techniques when handling multi-table transactions, and document record IDs - with no use of table or row locks.
-
+
+
+
+
-#### Extend your database with JavaScript functions
+### Extend your database with JavaScript functions
Embedded JavaScript functions allow for advanced, custom functionality, with computation logic being moved to the data layer. This improves upon the traditional approach of moving data to the client devices before applying any computation logic, ensuring that only the necessary data is transferred remotely. These advanced JavaScript functions, with support for the ES2020 standard, allow any developer to analyse the data in ever more simple-yet-advanced ways.
-
-
-#### Designed to be embedded or to run distributed in the cloud
+### Designed to be embedded or to run distributed in the cloud
Built entirely in Rust as a single library, SurrealDB is designed to be used as both an embedded database library with advanced querying functionality, and as a database server which can operate in a distributed cluster. With low memory usage and cpu requirements, the system requirements have been specifically thought through for running in all types of environment.
-
-
Community
Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB.
diff --git a/img/white/apple.svg b/img/apple.svg
similarity index 90%
rename from img/white/apple.svg
rename to img/apple.svg
index ebf3e908..44d637b6 100644
--- a/img/white/apple.svg
+++ b/img/apple.svg
@@ -1,9 +1,9 @@
-
+
+ 
@@ -43,6 +43,22 @@
+
+ 
-
Getting started
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+
+ 
+
+ 
+
Installation
- Install on macOS
-
Install on macOS
- Install on Linux
-
Install on Linux
- Install on Windows
-
Install on Windows
- Run using Docker
-
Run using Docker
Quick look
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
Community