凸数据

Convex 是一个开源的反应式数据库，旨在为 Web 应用开发者（无论是人类还是大语言模型）提供便利。通过编写纯 TypeScript 代码来获取数据并执行业务逻辑，并保证强一致性。

Convex 提供了数据库、编写服务器函数的地方以及客户端库。它使得构建和扩展动态实时更新的应用变得容易。阅读文档以了解更多信息。

Convex 后端的开发由 Convex 团队领导。我们欢迎修复 bug 并喜欢接收反馈。我们将此仓库与内部开发工作保持同步，通常在几天内完成同步。

开始使用

访问我们的文档以了解更多关于 Convex 的信息，并按照我们的入门指南进行操作。

使用 Convex 构建应用最简单的方法是通过我们的云平台，该平台提供了慷慨的免费层级，让您能够专注于构建应用程序而不必担心基础设施问题。许多小型应用和副项目可以完全依赖免费层级运行，无需任何成本和维护。

自托管

自托管产品包括了云端产品的大多数功能，包括仪表板和 CLI。自托管的 Convex 可以很好地与多种工具配合使用，如 Neon、Fly.io、Vercel、Netlify、RDS、Sqlite、Postgres 等。

您可以选择使用 Docker（推荐）或预编译的二进制文件来自托管 Convex。请参阅我们的自托管指南以获得详细说明。在 Discord 上的 #self-hosted 频道中可获得社区支持。

社区和支持

• 加入我们的 Discord 社区 获取帮助和讨论。
• 在构建和使用开源 Convex 后端时遇到问题，请通过 GitHub Issues 报告。

从源码构建

请参阅 BUILD.md。

免责声明

• 如果您选择自托管，我们建议遵循自托管指南。如果您是从源代码构建，请确保更改存储库中的默认实例密钥和管理员密钥。
• Convex 在 Linux 和 Mac 上经过了最彻底的测试。在 Windows 上，它的经验较少。如果您遇到问题，请在 Discord 的 #self-hosted 频道上联系我们。
• Convex 自托管版本包含一个信标，以帮助 Convex 改进产品。这些信息是最小化且匿名的，并对 Convex 有帮助，但如果您确实想禁用它，可以在后端二进制文件中设置 --disable-beacon 标志。信标的消息会打印在日志中，仅包括：
  • 您部署的随机标识符（未在其他地方使用）
  • 数据库的迁移版本
  • 后端的 Git 版本
  • 后端的运行时间

仓库结构

• crates/ 包含 Rust 代码

  • 主二进制文件
    • local_backend/ 是基于 Runtime 的应用程序服务器。这是 Convex 云的服务边缘。

• npm-packages/ 包含我们的公共和内部 TypeScript 包。

  • 内部包
    • udf-runtime/ 设置用于查询和变更的用户定义函数 JS 环境
    • udf-tests/ 是一组用于测试隔离层的函数
    • system-udfs/ 包含由 Convex 系统使用的函数，例如 CLI