wolfoo2931/linkedrecords

来源：https://github.com/wolfoo2931/linkedrecords

LinkedRecords

LinkedRecords 是一种 NoSQL 数据库，你可以直接从单页应用连接它——无需后端代码。

📚 快速入门

想用 LinkedRecords 构建应用？ 请查阅文档网站：

• 简介 (https://linkedrecords.com) —— 了解 LinkedRecords 是什么以及它的工作原理
• 快速入门指南 (https://linkedrecords.com/getting-started) —— 构建首个应用的分步指南

性能

下图展示了数据库增长时核心操作的性能。每次合并到主分支后，图表会自动更新。

负载测试模拟了一个真实的文档管理场景。每次 createDocument 操作都会创建一个包含 8 个属性（7 个 KeyValueAttribute + 1 个 LongTextAttribute）的蓝图，包括文档内容、协作者/读者组、评论、引用和配置。fetchDocuments 操作用于列出用户的所有文档，而 fetchDocument 则检索单个文档及其所有关联属性。

负载测试性能图表

负载测试的工作原理

测试模拟了一个多租户环境，包含三个用户：

• 用户 1 不断创建文档（当前测试配置为 5000 次迭代）。
• 用户 2 是“被测试用户”，每当用户 1 创建 10 个文档，该用户就创建 1 个文档，最多创建 300 个文档。达到 300 个文档后，该用户的文档创建停止。
• 用户 3 偶尔创建文档（每 1000 次迭代创建一次）

x 轴表示 数据库中的文档总数（所有用户拥有的文档）。y 轴表示响应时间（毫秒）。

测量内容：

概念

你可以将 LinkedRecords 看作一个桶，任何人都可以注册并向其中插入数据。只要你不将这些数据共享给其他用户或组，只有你能访问你写入的数据。

理论上，任何用户都可以直接使用 LinkedRecords API 写入和检索数据。但这并不方便——就像你不会期望用户编写 SQL 查询一样，你也不会期望他们与 LinkedRecords API 交互。LinkedRecords 应用是一个专门的前端，它隐藏了 API，并提供了方便的用户界面来完成任务。

在传统的 SQL 世界中，不方便并不是不让你直接访问数据库的唯一原因——授权问题更是一个重要原因。使用 LinkedRecords，这不再是问题：授权直接内置于 API 中。这需要一点思维转变：不再在后端为所有记录定义通用授权规则，而是由插入数据记录的用户指定谁可以读取它。

对于 LinkedRecords API，简单性、灵活性和解耦架构是我们追求的主要品质。

• 简单性：API 不应有很多端点或方法；而是由少数几个基本构建块组成。
• 灵活性：通过组合少数可用的端点，可以支持多种用例。内置的授权模型应允许实现不同的授权用例（如 RBAC 等）。
• 解耦：LinkedRecords 应与使用它作为数据存储的单页应用解耦。

可以将其视为可以直接从 React 应用调用的 SQL，而无需担心权限；它比 SQL 更易读，并提供实时更新。

配置

LinkedRecords 通过环境变量配置。请参见下表。

机密客户端模式

如果提供了“公共客户端模式”部分描述的配置，则本节中的环境变量均为可选。

如果 LinkedRecords 以机密客户端模式运行，则会将会话令牌存储在 HttpOnly cookie 中。从安全角度来看，这被认为是推荐方法。但是，如果 LinkedRecords 服务器和前端不在同一域下，则无法实现此模式。跨域时，cookie 会成为第三方 cookie，因此无法使用此模式。

公共客户端模式

如果单页应用托管在与 LinkedRecords 服务器不同的域上，则单页应用必须将访问令牌存储在浏览器中。在此场景下，需要配置以下环境变量。

单页应用需要按如下方式初始化 LinkedRecords SDK：

import LinkedRecords from './src/browser_sdk';

const oidcConfig = {
  client_id: 'your-client-id',
  redirect_uri: window.location.origin + '/callback',
};

// 实例化 LinkedRecords 将自动处理 OIDC 重定向回调
const lr = new LinkedRecords(new URL('https://your-backend.com'), oidcConfig);

// 检查用户是否已认证：
// const isAuth = await lr.isAuthenticated();

// 开始登录流程（例如，在按钮点击时）：
// lr.login();

可选配置

S3

如果配置了 S3，则将使用它来存储 blob 属性值。如果未配置，则它们将存储在 PostgreSQL 数据库中。建议配置 S3。

Paddle