Keymaker - 推荐框架与 Cypher 查询管道

Keymaker 充当 API 层,简化了连接 Neo4j 数据库的过程,当前仅支持 Neo4j 4.5 以及 5.x 版本。它提供了用于建立数据库连接和使用 Cypher 构建分析查询管道(称为 engine)的用户界面。这些 engine 可针对特定业务场景进行定制。借助 Keymaker,您开发的每个 engine 或查询管道都会自动配备 GraphQL API 端点。这样即可在使用 React 等前端框架时省去手动编写类型定义、查询和变更的步骤,使开发者能够专注于业务逻辑。

Keymaker 高层架构

Keymaker 的架构围绕三个核心组件构建:管理仪表盘(Admin Dashboard)、管理 API(Admin API)以及 Engine API。这三个组件共同提供了一个完整的接口,以实现框架的无缝交互。

  • 管理仪表盘:用于建立数据库连接、在 Keymaker 中构建称为 “engine” 的分析管道以及编写 Cypher 查询的用户界面。

  • 管理 API:该 API 为用户提供与框架交互的途径。

  • Engine API:该 API 负责连接您的 Neo4j 数据库,并暴露执行 engine 的端点。

下图展示了该架构结构

keymaker architecture

用户活动流程图

下图描绘了用户在 Keymaker 应用中的完整旅程。该流程图概括了从首次登录到最终执行查询管道的每一步操作。用户从 Keymaker 管理 UI 开始,依次完成数据库连接配置、查询管道定义,最终通过 API Key 执行复杂查询。

user activity flow diagram 3

注意:从创建数据库连接到执行查询管道的详细分步指南可在 Github README 中找到。

安装

  • 前往 GitHub 仓库 查看代码。

  • 确保您的机器已安装 Node.js

  • 按照 Keymaker 项目 README 中的说明进行操作。

功能包括

  • Neo4j 数据库集成:直接连接 Neo4j 数据库,专门支持 4.5 与 5.x 版本。

  • 分析查询管道创建:Keymaker 界面允许使用 Cypher 创建面向特定业务场景的分析查询管道(engine)。

  • 自动 GraphQL API 端点:为每个已开发的 engine 或查询管道自动提供 GraphQL API 端点。

  • 专注业务逻辑:使开发者能够专注于业务逻辑,而无需处理 API 与数据库集成的技术细节。

  • 定制化 Engine:支持根据独特的业务需求定制 engine。

文档

该库的文档可在此链接获取:这里

另请参阅 GitHub 仓库

作者

Snehal Maid

社区支持

Neo4j 在线社区

源代码

GitHub

问题追踪

问题反馈

文档

文档

视频与教程

如何在本地机器上安装 Keymaker:分步教程

快速入门:验证 Keymaker 环境并构建首个查询管道

Keymaker 功能概览

© . This site is unofficial and not affiliated with Neo4j, Inc.