noth/surrealpatch
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update readme file for Docker

Browse source
This commit is contained in:
Tobie Morgan Hitchcock 2022-08-20 11:24:46 +01:00
parent 1fbd9d0dd6
commit 021391f2c9
1 changed files with 284 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

327
DOCKER.md
View file

@ -11,7 +11,7 @@
</p> </p>
<h3 align="center"> <h3 align="center">
<img src="https://github.com/surrealdb/surrealdb/blob/main/img/black/text.svg?raw=true" height="12" alt="SurrealDB"> <img src="https://github.com/surrealdb/surrealdb/blob/main/img/black/text.svg?raw=true" height="15" alt="SurrealDB">
is the ultimate cloud <br> database for tomorrow's applications is the ultimate cloud <br> database for tomorrow's applications
</h3> </h3>
@ -20,10 +20,10 @@
<br> <br>
<p align="center"> <p align="center">
<a href="https://github.com/surrealdb/surrealdb"><img src="https://img.shields.io/github/v/release/surrealdb/surrealdb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a> <a href="https://github.com/surrealdb/surrealdb"><img src="https://img.shields.io/github/v/release/surrealdb/surrealdb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="https://github.com/surrealdb/surrealdb"><img src="https://img.shields.io/badge/built_with-Rust-dca282.svg?style=flat-square"></a>
&nbsp; &nbsp;
<a href="https://github.com/surrealdb/surrealdb"><img src="https://img.shields.io/badge/language-Rust-dca282.svg?style=flat-square"></a>
&nbsp;
<a href="https://github.com/surrealdb/surrealdb/actions"><img src="https://img.shields.io/github/workflow/status/surrealdb/surrealdb/Continuous%20integration?style=flat-square"></a> <a href="https://github.com/surrealdb/surrealdb/actions"><img src="https://img.shields.io/github/workflow/status/surrealdb/surrealdb/Continuous%20integration?style=flat-square"></a>
&nbsp; &nbsp;
<a href="https://status.surrealdb.com"><img src="https://img.shields.io/uptimerobot/ratio/7/m784409192-e472ca350bb615372ededed7?label=cloud%20uptime&style=flat-square"></a> <a href="https://status.surrealdb.com"><img src="https://img.shields.io/uptimerobot/ratio/7/m784409192-e472ca350bb615372ededed7?label=cloud%20uptime&style=flat-square"></a>
@ -34,28 +34,31 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://surrealdb.com/discord"><img src="https://img.shields.io/discord/902568124350599239?label=discord&style=flat-square&color=5a66f6"></a>
&nbsp;
<a href="https://twitter.com/surrealdb"><img src="https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=flat-square"></a> <a href="https://twitter.com/surrealdb"><img src="https://img.shields.io/badge/twitter-follow_us-1d9bf0.svg?style=flat-square"></a>
&nbsp; &nbsp;
<a href="https://surrealdb.com/discord"><img src="https://img.shields.io/discord/902568124350599239?label=discord&style=flat-square&color=5a66f6"></a>
&nbsp;
<a href="https://dev.to/surrealdb"><img src="https://img.shields.io/badge/dev-join_us-86f7b7.svg?style=flat-square"></a> <a href="https://dev.to/surrealdb"><img src="https://img.shields.io/badge/dev-join_us-86f7b7.svg?style=flat-square"></a>
&nbsp; &nbsp;
<a href="https://www.linkedin.com/company/surrealdb/"><img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square"></a> <a href="https://www.linkedin.com/company/surrealdb/"><img src="https://img.shields.io/badge/linkedin-connect_with_us-0a66c2.svg?style=flat-square"></a>
</p> </p>
<p align="center"> <p align="center">
<a href="https://www.linkedin.com/company/surrealdb/"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/linkedin.svg?raw=true" alt="LinkedIn"></a> <a href="https://surrealdb.com/blog"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/blog.svg?raw=true" alt="Blog"></a>
&nbsp;
<a href="https://github.com/surrealdb/surrealdb"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/github.svg?raw=true" alt="Github "></a>
&nbsp;
<a href="https://www.linkedin.com/company/surrealdb/"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/linkedin.svg?raw=true" alt="LinkedIn"></a>
&nbsp; &nbsp;
<a href="https://twitter.com/surrealdb"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/twitter.svg?raw=true" alt="Twitter"></a> <a href="https://twitter.com/surrealdb"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/twitter.svg?raw=true" alt="Twitter"></a>
&nbsp; &nbsp;
<a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/youtube.svg?raw=true" alt="Youtube"></a> <a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/youtube.svg?raw=true" alt="Youtube"></a>
&nbsp; &nbsp;
<a href="https://dev.to/surrealdb"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/dev.svg?raw=true" alt="Dev"></a> <a href="https://dev.to/surrealdb"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/dev.svg?raw=true" alt="Dev"></a>
&nbsp; &nbsp;
<a href="https://surrealdb.com/discord"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/discord.svg?raw=true" alt="Discord"></a> <a href="https://surrealdb.com/discord"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/discord.svg?raw=true" alt="Discord"></a>
&nbsp; &nbsp;
<a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/stack-overflow.svg?raw=true" alt="StackOverflow"></a> <a href="https://stackoverflow.com/questions/tagged/surrealdb"><img height="25" src="https://github.com/surrealdb/surrealdb/blob/main/img/social/stack-overflow.svg?raw=true" alt="StackOverflow"></a>
</p> </p>
<br> <br>
@ -64,39 +67,52 @@
SurrealDB is an end-to-end cloud native database for web, mobile, serverless, jamstack, backend, and traditional applications. SurrealDB reduces the development time of modern applications by simplifying your database and API stack, removing the need for most server-side components, allowing you to build secure, performant apps quicker and cheaper. SurrealDB acts as both a database and a modern, realtime, collaborative API backend layer. SurrealDB can run as a single server or in a highly-available, highly-scalable distributed mode - with support for SQL querying from client devices, GraphQL, ACID transactions, WebSocket connections, structured and unstructured data, graph querying, full-text indexing, geospatial querying, and row-by-row permissions-based access. SurrealDB is an end-to-end cloud native database for web, mobile, serverless, jamstack, backend, and traditional applications. SurrealDB reduces the development time of modern applications by simplifying your database and API stack, removing the need for most server-side components, allowing you to build secure, performant apps quicker and cheaper. SurrealDB acts as both a database and a modern, realtime, collaborative API backend layer. SurrealDB can run as a single server or in a highly-available, highly-scalable distributed mode - with support for SQL querying from client devices, GraphQL, ACID transactions, WebSocket connections, structured and unstructured data, graph querying, full-text indexing, geospatial querying, and row-by-row permissions-based access.
For more details see [why](https://surrealdb.com/why), [features](https://surrealdb.com/features), or [documentation](https://surrealdb.com/docs). View the [features](https://surrealdb.com/features), the latest [releases](https://surrealdb.com/releases), the product [roadmap](https://surrealdb.com/roadmap), and [documentation](https://surrealdb.com/docs).
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/cloud.svg?raw=true">&nbsp;&nbsp;SurrealDB Cloud</h2> <img src="https://github.com/surrealdb/surrealdb/blob/main/img/interface.png?raw=true">
SurrealDB can run as a single-instance, or as a highly-available, highly-scalable cluster. If you don't want to manage your own database, we can run SurrealDB for you, in the Cloud, with just a couple of clicks. To get started with SurrealDB Cloud see our [website](https://surrealdb.com). <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/contents.svg?raw=true">&nbsp;&nbsp;Contents</h2>
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/gettingstarted.svg?raw=true">&nbsp;&nbsp;Getting started</h2> - [Features](#features)
- [Documentation](#documentation)
- [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)
- [Client side apps](#client-side-apps)
- [Server side code](#server-side-apps)
- [Quick look](#quick-look)
- [Why SurrealDB](#why-surrealdb)
- [Database, API, and permissions](#database-api-and-permissions)
- [Tables, documents, and graph](#tables-documents-and-graph)
- [Advanced inter-document relations](#advanced-inter-document-relations-and-analysis-no-joins-no-pain)
- [Simple schema definition](#simple-schema-definition-for-frontend-and-backend-development)
- [Connect directly from web-browsers](#connect-and-query-directly-from-web-browsers-and-client-devices)
- [Multiple different query methods](#query-the-database-with-the-tools-you-want)
- [Realtime live queries and data changes](#realtime-live-queries-and-data-changes-direct-to-application)
- [Scale effortlessly for high-availability](#scale-effortlessly-to-hundreds-of-nodes-for-high-availability-and-scalability)
- [Extend your database with JavaScript](#extend-your-database-with-javascript-functions)
- [Designed to be embedded or in the cloud](#designed-to-be-embedded-or-to-run-distributed-in-the-cloud)
- [Community](#community)
- [Contributing](#contributing)
- [Security](#security)
- [License](#license)
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. <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/features.svg?raw=true">&nbsp;&nbsp;Features</h2>
##### Client side apps - [x] Database server, or embedded library
- [x] Multi-row, multi-table ACID transactions
- [Getting started with Javascript](https://surrealdb.com/docs/integration/libraries/javascript) - [x] Single-node, or highly-scalable distributed mode
- [Getting started with WebAssembly](https://surrealdb.com/docs/integration/libraries/webassembly) - [x] Record links and directed typed graph connections
- [Getting started with Ember.js](https://surrealdb.com/docs/integration/libraries/emberjs) - [x] Store structured and unstructured data
- [Getting started with React.js](https://surrealdb.com/docs/integration/libraries/reactjs) - [x] Incrementally computed views for pre-computed advanced analytics
- [Getting started with Angular.js](https://surrealdb.com/docs/integration/libraries/angularjs) - [x] Realtime-api layer, and security permissions built in
- [Getting started with Vue.js](https://surrealdb.com/docs/integration/libraries/vue.js) - [x] Store and model data in any way with tables, documents, and graph
- [Getting started with Apollo GraphQL](https://surrealdb.com/docs/integration/libraries/apollo) - [x] Simple schema definition for frontend and backend development
- [x] Connect and query directly from web-browsers and client devices
##### Server side code - [x] Use embedded JavaScript functions for custom advanced functionality
- [Getting started with Node.js](https://surrealdb.com/docs/integration/libraries/nodejs)
- [Getting started with Golang](https://surrealdb.com/docs/integration/libraries/golang)
- [Getting started with Rust](https://surrealdb.com/docs/integration/libraries/rust)
- [Getting started with Deno](https://surrealdb.com/docs/integration/libraries/deno)
- [Getting started with Python](https://surrealdb.com/docs/integration/libraries/python)
- [Getting started with C](https://surrealdb.com/docs/integration/libraries/c)
- [Getting started with Java](https://surrealdb.com/docs/integration/libraries/java)
- [Getting started with Ruby](https://surrealdb.com/docs/integration/libraries/ruby)
- [Getting started with PHP](https://surrealdb.com/docs/integration/libraries/php)
- [Getting started with Swift](https://surrealdb.com/docs/integration/libraries/swift)
- [Getting started with R](https://surrealdb.com/docs/integration/libraries/r)
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/documentation.svg?raw=true">&nbsp;&nbsp;Documentation</h2> <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/documentation.svg?raw=true">&nbsp;&nbsp;Documentation</h2>
@ -150,16 +166,241 @@ Docker can be used to manage and run SurrealDB database instances without the ne
docker run --pull --rm -p 8000:8000 surrealdb/surrealdb:latest start docker run --pull --rm -p 8000:8000 surrealdb/surrealdb:latest start
``` ```
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/gettingstarted.svg?raw=true">&nbsp;&nbsp;Getting started</h2>
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.
##### Client side apps
- [x] [Getting started with Javascript](https://surrealdb.com/docs/integration/libraries/javascript)
- [x] [Getting started with WebAssembly](https://surrealdb.com/docs/integration/libraries/webassembly)
- [x] [Getting started with Ember.js](https://surrealdb.com/docs/integration/libraries/emberjs)
- [ ] [Getting started with React.js](https://surrealdb.com/docs/integration/libraries/reactjs)
- [ ] [Getting started with Angular.js](https://surrealdb.com/docs/integration/libraries/angularjs)
- [ ] [Getting started with Vue.js](https://surrealdb.com/docs/integration/libraries/vuejs)
- [ ] [Getting started with Apollo GraphQL](https://surrealdb.com/docs/integration/libraries/apollo)
##### Server side code
- [x] [Getting started with Javascript](https://surrealdb.com/docs/integration/libraries/javascript)
- [x] [Getting started with Node.js](https://surrealdb.com/docs/integration/libraries/nodejs)
- [x] [Getting started with Golang](https://surrealdb.com/docs/integration/libraries/golang)
- [x] [Getting started with Rust](https://surrealdb.com/docs/integration/libraries/rust)
- [x] [Getting started with Deno](https://surrealdb.com/docs/integration/libraries/deno)
- [ ] [Getting started with Python](https://surrealdb.com/docs/integration/libraries/python) (coming soon)
- [ ] [Getting started with C](https://surrealdb.com/docs/integration/libraries/c) (coming soon)
- [ ] [Getting started with Java](https://surrealdb.com/docs/integration/libraries/java) (coming soon)
- [ ] [Getting started with Ruby](https://surrealdb.com/docs/integration/libraries/ruby) (coming soon)
- [ ] [Getting started with PHP](https://surrealdb.com/docs/integration/libraries/php) (coming soon)
- [ ] [Getting started with Swift](https://surrealdb.com/docs/integration/libraries/swift) (coming soon)
- [ ] [Getting started with R](https://surrealdb.com/docs/integration/libraries/r) (coming soon)
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/features.svg?raw=true">&nbsp;&nbsp;Quick look</h2>
With strongly-typed data types, data can be fully modelled right in the database.
```sql
UPDATE person SET
waist = <int> "34.59",
height = <float> 201,
score = <decimal> 0.3 + 0.3 + 0.3 + 0.1
;
```
Store dynamically computed fields which are calculated when retrieved.
```sql
CREATE person SET
birthday = "2007-06-22",
can_drive = <future> { time::now() > birthday + 18y }
;
```
Easily work with unstructured or structured data, in schema-less or schema-full mode.
```sql
-- Create a schemafull table
DEFINE TABLE user SCHEMAFULL;
-- Specify fields on the user table
DEFINE FIELD name ON TABLE user TYPE object;
DEFINE FIELD name.first ON TABLE user TYPE string;
DEFINE FIELD name.last ON TABLE user TYPE string;
DEFINE FIELD email ON TABLE user TYPE string ASSERT is::email($value);
-- Add a unique index on the email field preventing duplicate values
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 = $this, time = time::now(), value = $after.email, action = 'email_changed'
);
```
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()
;
-- 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()
;
```
Query data flexibly with advanced expressions and graph queries.
```sql
-- Select a nested array, and filter based on an attribute
SELECT emails[WHERE active = true] FROM person;
-- Select all 1st, 2nd, and 3rd level people who this specific person record knows, or likes, as separate outputs
SELECT ->knows->(? AS f1)->knows->(? AS f2)->(knows, likes AS e3 WHERE influencer = true)->(? AS f3) FROM person:tobie;
-- Select all person records (and their recipients), who have sent more than 5 emails
SELECT *, ->sent->email->to->person FROM person WHERE count(->sent->email) > 5;
-- Select other products purchased by people who purchased this laptop
SELECT <-purchased<-person->purchased->product FROM product:laptop;
-- Select products purchased by people in the last 3 weeks who have purchased the same products that we purchased
SELECT ->purchased->product<-purchased<-person->(purchased WHERE created_at > time::now() - 3w)->product FROM person:tobie;
```
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]
]]
}
;
```
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 };
});
}
;
```
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
;
```
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/features.svg?raw=true">&nbsp;&nbsp;Why SurrealDB?</h2>
#### 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.
![Database, API, and permissions](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/database-api-security.png?raw=true)
#### 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.
![Tables, documents, and graph](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/multimodel-database.png?raw=true)
#### 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.
![Advanced inter-document relations](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/graph-database.png?raw=true)
#### 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.
![Simple schema definition](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/schema-direct-to-client.png?raw=true)
#### 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.
![Connect directly from web-browsers](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/browser-sync.png?raw=true)
#### 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.
![Multiple different query methods](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/multiple-integrations.png?raw=true)
#### 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.
![Realtime live queries and data changes](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/realtime-live-queries.png?raw=true)
#### 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.
![Scale effortlessly for high-availability](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/scale-up.png?raw=true)
#### 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.
![Extend your database with JavaScript](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/database-plugins.png?raw=true)
#### 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.
![Designed to be embedded or in the cloud](https://github.com/surrealdb/surrealdb/blob/main/img/illustrations/cloud-or-embedded.png?raw=true)
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/community.svg?raw=true">&nbsp;&nbsp;Community</h2> <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/community.svg?raw=true">&nbsp;&nbsp;Community</h2>
Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB. Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB.
- View our official [Blog](https://surrealdb.com/blog) - View our official [Blog](https://surrealdb.com/blog)
- Chat live with us on [Discord](https://surrealdb.com/discord)
- Follow us on [Twitter](https://twitter.com/surrealdb) - Follow us on [Twitter](https://twitter.com/surrealdb)
- Connect with us on [LinkedIn](https://www.linkedin.com/company/surrealdb/) - Connect with us on [LinkedIn](https://www.linkedin.com/company/surrealdb/)
- Visit us on [YouTube](https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w) - Visit us on [YouTube](https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w)
- Join our [Dev community](https://dev.to/surrealdb) - Join our [Dev community](https://dev.to/surrealdb)
- Chat live with us on [Discord](https://surrealdb.com/discord)
- Questions tagged #surrealdb on [Stack Overflow](https://stackoverflow.com/questions/tagged/surrealdb) - Questions tagged #surrealdb on [Stack Overflow](https://stackoverflow.com/questions/tagged/surrealdb)
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/contributing.svg?raw=true">&nbsp;&nbsp;Contributing</h2> <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/contributing.svg?raw=true">&nbsp;&nbsp;Contributing</h2>
@ -168,7 +409,7 @@ We would &nbsp;<img width="15" src="https://github.com/surrealdb/surrealdb/blob/
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/security.svg?raw=true">&nbsp;&nbsp;Security</h2> <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/security.svg?raw=true">&nbsp;&nbsp;Security</h2>
For security issues, kindly email us at [security@surrealdb.com](mailto:security@surrealdb.com) instead of posting a public issue on GitHub. For security issues, view our [vulnerability policy](https://github.com/surrealdb/surrealdb/security/policy), view our [security policy](https://surrealdb.com/legal/security), and kindly email us at [security@surrealdb.com](mailto:security@surrealdb.com) instead of posting a public issue on GitHub.
<h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/license.svg?raw=true">&nbsp;&nbsp;License</h2> <h2><img height="20" src="https://github.com/surrealdb/surrealdb/blob/main/img/license.svg?raw=true">&nbsp;&nbsp;License</h2>