PgREST 项目使用教程

最新推荐文章于 2024-12-31 11:00:56 发布

原创最新推荐文章于 2024-12-31 11:00:56 发布 · 849 阅读

24 ·

CC 4.0 BY-SA版权

PgREST 项目使用教程

pgrest enable REST in postgres 项目地址: https://gitcode.com/gh_mirrors/pg/pgrest

1. 项目介绍

PgREST 是一个在 PostgreSQL 内部运行的 JSON 文档存储系统，能够与现有的关系数据一起工作。它支持加载与 MongoLab 的 REST API 和 Firebase 的实时 API 兼容的 Node.js 模块。PgREST 的目标是提供一个简单易用的 RESTful API，使得开发者能够轻松地在 PostgreSQL 数据库上进行 CRUD 操作。

2. 项目快速启动

2.1 环境准备

PostgreSQL 9.0 及以上版本（推荐使用 9.2 或更高版本）
Node.js 0.10.x 及以上版本
plv8js 扩展：需要安装 PostgreSQL 的 plv8js 扩展。

2.2 安装步骤

安装 plv8js 扩展：
- 如果你使用的是 OS X 上的 Postgres.app，plv8js 已经预装。
- 否则，请参考 plv8js 安装指南。
```
psql -U <user> -c "create extension plv8"
```
如果遇到错误信息 Reason: image not found，请下载 9.2.4.3 版本之后的 PostgresApp。
安装 PgREST：
```
npm i -g pgrest
```
如果你是从 Git 仓库安装，请确保在全局安装之前先运行 npm i。

2.3 快速启动

创建数据库和表：

psql test
test=# CREATE TABLE foo (_id int, info json, tags text[]);
test=# INSERT INTO foo VALUES (1, '{"f1":1, "f2":true, "f3":"Hi I''m \"Daisy\""}', '{"foo", "bar"}');

启动 PgREST 服务：
```
pgrest --db test
```
服务启动后，你可以通过 http://127.0.0.1:3000/collections 访问 test 数据库。

访问数据：

读取数据：

curl http://127.0.0.1:3000/collections/foo/1
curl -g 'http://127.0.0.1:3000/collections/foo?q=["_id":1]'
curl -g 'http://127.0.0.1:3000/collections/foo?q=["tags":["$contains":"foo"]]'

写入数据：

echo '{"_id": 5, "info": {"counter":5} }' | curl -D - -H 'Content-Type: application/json' -X POST -d @- http://localhost:3000/collections/foo

3. 应用案例和最佳实践

3.1 应用案例

实时数据同步：PgREST 可以与 Firebase 的实时 API 兼容，适用于需要实时数据同步的应用场景，如在线协作工具、实时聊天系统等。
RESTful API 开发：对于需要快速开发 RESTful API 的项目，PgREST 提供了一个简单的方式来暴露 PostgreSQL 数据库的接口。