Lib.rs

是明天应用的终极云
数据库

更容易开发。   更快构建。   更快扩展。

一个可扩展的、分布式的、协作的文档图数据库，适用于实时网络。

  什么是SurrealDB？

SurrealDB是一个面向Web、移动、无服务器、Jamstack、后端和传统应用的端到端云原生数据库。SurrealDB通过简化数据库和API堆栈，消除大多数服务器端组件的需要，从而减少了现代应用程序的开发时间，让您能够更快、更便宜地构建安全、高性能的应用程序。SurrealDB既充当数据库，也充当现代的、实时的、协作的API后端层。SurrealDB可以作为单个服务器运行，也可以在高度可用、高度可扩展的分布式模式下运行——支持从客户端设备进行SQL查询、GraphQL、ACID事务、WebSocket连接、结构化和非结构化数据、图查询、全文索引、地理空间查询以及基于行的权限访问。

查看功能、最新的发布、产品的路线图和文档。

  功能

• 数据库服务器或嵌入式库
• 多行、多表ACID事务
• 单节点或高度可扩展的分布式模式
• 记录链接和有向类型图连接
• 存储结构化和非结构化数据
• 用于预计算高级分析的增量计算视图
• 实时API层，内置安全权限
• 使用表、文档和图以任何方式存储和建模数据
• 前端和后端开发简单的架构定义
• 从Web浏览器和客户端设备直接连接和查询
• 使用内嵌JavaScript函数实现自定义高级功能

  文档

有关安装、开发、部署和管理指南，请参阅我们的文档。

  安装

SurrealDB设计得易于安装和运行 - 只需在终端中运行一个命令。除了传统的安装方式，SurrealDB还可以使用HomeBrew、Docker或任何其他容器编排工具（如Docker Compose、Docker Swarm、Rancher或Kubernetes）进行安装和运行。

  在macOS上安装

在macOS上开始使用SurrealDB的最快方法是使用Homebrew。这将安装命令行工具和SurrealDB服务器作为一个单独的可执行文件。如果您不使用Homebrew，请按照以下Linux说明安装SurrealDB。

brew install surrealdb/tap/surreal

  在Linux上安装

在Unix操作系统上开始使用SurrealDB最简单且推荐的方式是安装并使用SurrealDB命令行工具。在您的终端中运行以下命令，并遵循屏幕上的说明。

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

  在Windows上安装

在Windows上开始使用SurrealDB最简单且推荐的方式是安装并使用SurrealDB命令行工具。在您的终端中运行以下命令，并遵循屏幕上的说明。

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

  使用Docker运行

可以使用Docker来管理和运行SurrealDB数据库实例，无需安装任何命令行工具。SurrealDB Docker容器包含用于从运行中的服务器导入和导出数据或运行服务器的完整命令行工具。

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

更新镜像到最新版本

docker pull surrealdb/surrealdb:latest

  入门

开始使用SurrealDB就像启动SurrealDB数据库服务器、选择您的平台并将其SDK集成到您的代码中一样简单。您可以通过阅读我们的教程之一轻松开始使用您选择的平台。

客户端应用程序

• 从JavaScript开始入门
• 从WebAssembly开始入门
• 从Ember.js开始入门
• 从React.js开始入门
• 从Angular.js开始入门
• 从Vue.js开始入门
• 从Apollo GraphQL开始入门

服务器端代码

• 从JavaScript开始入门
• 从Node.js开始入门
• 从Golang开始入门
• 从Rust开始入门
• 从Deno开始入门
• 从Python开始入门（即将推出）
• 从C开始入门（即将推出）
• 从Java开始入门（即将推出）
• 从Ruby开始入门（即将推出）
• 从PHP开始入门（即将推出）
• 从Swift开始入门（即将推出）
• R语言入门指南（即将推出）

  快速浏览

使用强类型数据类型，数据可以完全在数据库中进行建模。

UPDATE person SET
	waist = <int> "34.59",
	height = <float> 201,
	score = <decimal> 0.3 + 0.3 + 0.3 + 0.1
;

存储动态计算的字段，当检索时进行计算。

CREATE person SET
	birthday = "2007-06-22",
	can_drive = <future> { time::now() > birthday + 18y }
;

轻松处理非结构化或结构化数据，在无模式或全模式模式下。

-- 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 string::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'
);

通过完全定向的图边连接连接记录。

-- 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()
;

使用高级表达式和图查询灵活查询数据。

-- 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;

存储GeoJSON地理数据类型，包括点、线和多边形。

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]
		]]
	}
;

使用JavaScript函数编写自定义嵌入式逻辑。

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 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
;

  社区

加入我们全球不断壮大的社区，获取有关SurrealDB的帮助、想法和讨论。

• 查看我们的官方博客
• 关注我们的Twitter
• 在LinkedIn上联系我们
• 在我们的YouTube频道上访问我们
• 加入我们的Dev社区
• 在我们的Discord上与我们一起实时聊天
• 在Stack Overflow上标记#surrealdb的问题

  贡献

我们希望您能参与到SurrealDB的开发中来！如果您想帮忙，您可以在贡献指南中了解更多有关如何为此项目做出贡献的信息。

  安全

对于安全问题，请通过电子邮件发送给我们[email protected]，而不是在GitHub上发布公开问题。

  许可证

SurrealDB的源代码在各种不同的许可证下发布。每个存储库中都可以找到每个许可证的副本。

• 库和SDK位于各自的独立存储库中，分别以Apache License 2.0或MIT许可证发布。
• 某些核心数据库组件位于各自的独立存储库中，以Apache License 2.0发布。
• 位于此仓库的SurrealDB核心数据库代码，采用商业源代码许可证1.1发布。

更多信息，请参阅许可信息。