noth/surrealpatch: FUCKING PATCHED SURREALDB BECAUSE TOKIO GUHHHHH

FUCKING PATCHED SURREALDB BECAUSE TOKIO GUHHHHH

Find a file

Tobie Morgan Hitchcock 1e49a00840 Update 3rd party dependencies		2022-05-05 12:40:05 +01:00
.github	Add initial Github continuous integration workflow	2022-03-05 14:50:18 +00:00
app	Continue with initial code	2021-12-14 10:24:54 +00:00
img	Add initial README	2021-12-14 10:35:00 +00:00
lib	Update 3rd party dependencies	2022-05-05 12:40:05 +01:00
src	Simplify external API when working with Datastore	2022-05-04 00:07:46 +01:00
.dockerignore	Add initial Docker configuration files	2021-12-14 10:24:54 +00:00
.editorconfig	Add initial editorconfig file	2021-12-14 09:35:16 +00:00
.gitignore	Extract core surrealdb code into separate library	2022-02-22 14:16:50 +00:00
.rustfmt.toml	Update rustfmt edition to 2021	2022-03-04 16:01:05 +00:00
Cargo.lock	Update 3rd party dependencies	2022-05-05 12:40:05 +01:00
Cargo.toml	Update 3rd party dependencies	2022-05-05 12:40:05 +01:00
CODE_OF_CONDUCT.md	Update links in code of conduct file	2021-12-14 12:14:31 +00:00
CONTRIBUTING.md	Add contributing information file	2021-12-14 10:35:25 +00:00
DOCKER.md	Update README files	2022-04-29 21:42:18 +01:00
Dockerfile	Add initial Docker configuration files	2021-12-14 10:24:54 +00:00
LICENSE	Add license for SurrealDB 1.0.0	2021-12-14 10:29:35 +00:00
Makefile	Add Makefile for command for checking code	2022-05-04 00:49:38 +01:00
README.md	Update README files	2022-04-29 21:42:18 +01:00
SECURITY.md	Update SECURITY.md file	2022-04-09 13:38:35 +01:00

README.md

is the ultimate cloud
database for tomorrow's applications

Develop easier. Build faster. Scale quicker.

What is SurrealDB?

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, features, or documentation.

SurrealDB Cloud

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.

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.

Client side apps

Server side code

Documentation

For guidance on installation, development, deployment, and administration, see our documentation.

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

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.

brew install surrealdb/tap/surreal

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.

curl -sSf https://install.surrealdb.com | sh

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.

iwr https://install.surrealdb.com -useb | iex

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.

docker run --rm -p 8000:8000 surrealdb/surrealdb:latest start

Community

Join our growing community around the world, for help, ideas, and discussions regarding SurrealDB.

View our official Blog
Follow us on Twitter
Connect with us on LinkedIn
Visit us on YouTube
Join our Dev community
Chat live with us on Discord
Questions tagged #surrealdb on Stack Overflow

Contributing

We would for you to get involved with SurrealDB development! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at security@surrealdb.com instead of posting a public issue on GitHub.

License

Source code for SurrealDB is variously licensed under a number of different licenses. A copy of each license can be found in each repository.

Libraries and SDKs, each located in its own distinct repository, are released under either the Apache License 2.0 or MIT License.
Certain core database components, each located in its own distinct repository, are released under the Apache License 2.0.
Core database code for SurrealDB, located in this repository, is released under the Business Source License 1.1.

For more information, see the licensing information.