Nile REST API：将 SQL 查询转换为端点

REST API · 尼罗河到端点

转动 尼罗河 SQL 查询结果 REST API 端点

在查询构建器中保存查询，然后单击 新端点这样，您就拥有了一个位于 api.querystreams.com 的 URL，它带有自己的密钥。SQL 语句在已部署到您的 Nile 数据库的代理上以只读方式运行；调用者会收到 JSON 或 CSV 数据，而不会看到 SQL 语句、数据库架构或密码。无需托管任何服务器，也无需开放任何端口。从保存查询到执行大约需要 90 秒，免费套餐即可满足您的第一个端点需求。

从已保存的查询算起大约需要 90 秒 没有服务器可供托管 凭证将一直随您保留 每个来电者一个密钥，可随时撤销

你最终会得到什么

网址 api.querystreams.com 它会将您保存的 Nile 查询结果以 JSON 或 CSV 格式返回给任何拥有密钥的人，在您共享之前，请先在门户网站的控制台中进行测试。例如：

{
  “姓名”: “西雅图”
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "Seattle"}'

{
  “列”: [ { “姓名”: "租户ID", “类型”: 整数 }, { “姓名”: "customer_id", “类型”: “细绳” }, { “姓名”: “姓名”, “类型”: “细绳” } ],
  “行”: [
    { "租户ID": 1042, "customer_id": “北风贸易公司”, “姓名”: “西雅图” },
    { "租户ID": 1057, "customer_id": “高山装备店”, “姓名”: “丹佛” },
    { "租户ID": 1063, "customer_id": “港口食品”, “姓名”: “哈利法克斯” }
  ],
  “元”: { 行数: 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

Nile 将您的数据存储在云端，由其服务提供商运营。其他人想要在他们的应用程序、仪表板或脚本中使用部分数据，而通常的解决方案都会带来过多的依赖：例如，一个比项目生命周期更长的数据库登录信息、一个第二天早上就过时的夜间导出数据，或者一个需要有人运行和维护的小型 API 服务器。Query Streams 将端点简化为一个已保存的查询和一个密钥。已部署在您的 Nile 数据库中的代理会运行该查询，api.querystreams.com 会检查密钥和速率限制，然后调用者即可获取数据行。SQL 语句、模式和凭据始终保留在您的帐户中。

你需要准备什么

查询流帐户

每个套餐都提供 REST API。免费套餐提供一个端点、两个键，每次调用最多可发送 250 行数据，足以构建本指南。立即注册！ my.querystreams.com.

在任何始终在线的计算机上安装代理，并添加 Nile 连接。

它只需要连接互联网即可。

查询生成器中已保存的查询

该端点仅封装一个已保存的查询。编写 SELECT 语句，运行一次，然后保存。添加动态筛选器（ @variable 在 WHERE 子句中）如果调用者应该能够进行筛选。

分四步完成设置

1. 保存查询

   在 查询生成器 选择你的 Nile 连接，编写要发布的 SELECT 语句，然后运行一次以查看结果行。确保只包含调用者需要的列；端点会返回查询语句的全部内容。

   已保存查询 · 客户

   选择 租户ID、客户ID、姓名、城市
   从 公共客户
   命令 经过 名字
   限制 100;

   如果呼叫者需要能够进行筛选，请添加动态筛选器，例如 WHERE name = @name。 每个 @variable 在步骤 3 中，它会成为一个 API 参数。点击 节省 并为查询命名；该名称将成为端点的显示名称。

2. 创建端点

   打开 API 点击顶部栏并单击 新端点该向导有四个步骤： 选择查询, 配置, 锁定参数 和 共享。 在 选择查询单击您刚刚保存的查询；代理离线的查询会显示为灰色。单击 下一页.

   开放 API

   捷径。 您可以从查询构建器直接显示已打开的查询；然后向导将从此处开始。 配置 查询语句已选定。

3. 配置并锁定参数

   在 配置 对于第一个端点来说，默认值是正确的： 显示名称 根据查询结果填写， 寿命 永久（选择） 即将到期 （临时份额） 响应模式 静态（一个 JSON 响应；选择） 流媒体 对于超出计划静态行上限的结果）， 内页格式 JSON。响应模式和格式一旦创建就固定不变，因此请在此处决定。点击 下一页.

   在 锁定参数 查询中的每个动态筛选器都会列出。保留调用者可能设置的筛选器。 可调用 并给每个人一个 查询字符串名称; 打钩 必需的 如果调用没有指定该值，则调用应失败。固定一个调用者不得更改的值。 已锁定或者类似这样的约会场景 月初. 隐 保留查询自身的默认值，并拒绝任何设置默认值的尝试。点击 下一页.

4. 分享即可获得您的钥匙

   在 共享 你可以邀请 人们 通过电子邮件或添加 服务密钥 可以是服务器或自动化工具，或者暂时两者都跳过。点击 创建并获取我的密钥成功屏幕会显示端点 URL 和您的密钥：一个以“.”开头的 49 个字符的字符串。 qsapi_复制它。稍后您可以从端点再次显示它。 共享 标签页，这样即使关闭屏幕也不会丢失。

   点击 发送 在控制台中，从门户本身发出第一个调用。响应窗格显示 现状, 时间 和 尺寸， 这 身体 标签页显示 JSON 数据，调用信息显示在标签页上。 活动 几秒钟后按下 Tab 键。

无论从哪里拨打电话

将端点 ID 替换为控制台地址栏中的您自己的端点 ID， qsapi_YOUR_KEY 使用您的密钥。可调用参数放在 GET 请求的查询字符串中；这里保存的查询会公开 名字:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?name=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  “列”: [ { “姓名”: "租户ID", “类型”: 整数 }, { “姓名”: "customer_id", “类型”: “细绳” }, { “姓名”: “姓名”, “类型”: “细绳” } ],
  “行”: [
    { "租户ID": 1042, "customer_id": “北风贸易公司”, “姓名”: “西雅图” },
    { "租户ID": 1057, "customer_id": “高山装备店”, “姓名”: “丹佛” },
    { "租户ID": 1063, "customer_id": “港口食品”, “姓名”: “哈利法克斯” }
  ],
  “元”: { 行数: 3, "agent_duration_ms": 41, "request_id": "req_7Hq2mKd9" }
}

返回的行是以列名为键的对象，包含列列表和一个 元 该信息块会告诉你有多少行数据、结果是否被截断以及你可以引用的请求 ID。与 POST 请求相同的操作会将参数放在 JSON 正文中，这对于较长的值列表来说是合适的选择：

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"name": "Seattle"}}'

格式=csv

格式为 CSV 而非 JSON，包含表头行。 接受：文本/CSV 也一样。流式端点返回 NDJSON（每行一个 JSON 对象），并以结尾结尾。 {"_summary": true, "row_count": N} 检查最后一行。

?sample=true

最多五排，不计费。适合给客户接线。

压缩=lz4

适用于高流量呼叫者的 LZ4 框架机身，配备解码器； 代码 选项卡中包含每种语言的解码器代码片段。客户端发送文件时，会自动进行纯 gzip 压缩。 Accept-Encoding: gzip.

授权：Bearer qsapi_…

被接受为别名 X-API密钥. 在浏览器代码中使用它。

它的插头在哪里

这些计划允许什么？

每次调用都有固定的 60 秒查询超时时间和 8 MiB 的响应大小上限，返回的数据量会计入您套餐的每月数据流量限额，与 Excel 和 Google Sheets 插件使用的限额相同。免费套餐只有一个端点，每月 5 MB 流量，足以满足每天多次调用的小型表格的需求。 请查看定价页面 按计划发放津贴。

确保安全

当某些事情不起作用时

每个错误体都有其形状 {"error": {"code": "…", "message": "…"}} 每个回应都包含一个 X-QS-请求-ID 邮件头。在联系客服时，请将 ID 号括起来。

人们提出的问题

相关指南

• 通过 MCP 将尼罗河与克劳德连接起来
• 数据库 REST API：将任何 SQL 查询转换为端点
• Microsoft SQL Server REST API
• PostgreSQL REST API
• MySQL REST API
• Snowflake REST API