数据库 REST API：将任何 SQL 查询转换为端点

数据库 REST API · 中心

任何 SQL 查询 变成一个 REST API 端点

在查询生成器中针对 59 个连接器中的任意一个编写查询，然后单击 新端点这样，您就可以在 api.querystreams.com 上获得一个带有专属密钥的 URL。SQL 语句在已部署到您数据上的代理程序上以只读方式运行；调用者会收到 JSON 或 CSV 格式的数据，而不会看到 SQL 语句、架构或凭据。无需托管服务器，无需开放端口，所有套餐（包括免费套餐）均包含此功能。本页为概述；每个连接器都有其专属指南，详见下方。

从已保存的查询算起大约需要 90 秒 没有服务器可供托管 数据保留在您的网络上 每个来电者一个密钥，可随时撤销

你最终会得到什么

这是一个 URL，持有密钥的用户可以通过它访问已保存查询的行数据。在分享此 URL 之前，请先在门户网站的控制台中进行测试。例如：

{
  “城市”: “西雅图”
}

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 '{"city": "Seattle"}'

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

大多数将 REST API 集成到数据库的工具，例如 PostgREST、Hasura、DreamFactory、Directus 以及你自己编写的框架，都会暴露数据库模式：每个表都成为一个端点，调用者可以浏览这些数据。而 Query Streams 则恰恰相反。一个已保存的查询就能精确定义端点返回的内容。调用者只能获取这些行，而无需了解它们的生成方式。你也无需运行 API 服务器，因为你已有的 Agent 会执行查询，而 api.querystreams.com 会处理 HTTP 请求。

你需要准备什么

查询流帐户

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

计算机上的代理程序可以访问您自己的数据库，并且已添加连接。

通常是数据库服务器本身，或者同一网络上的始终在线的计算机。

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

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

分四步完成设置

1. 保存查询

   在 查询生成器 选择一个连接，编写 SELECT 语句并运行一次。 @variable WHERE 子句中的参数会变成 API 参数：

   已保存的查询 · 包含一个动态筛选器

   选择 客户ID、姓名、城市
   从 客户
   地点 城市 = @city
   命令 经过 姓名;

   点击 节省；该名称将成为端点的显示名称。

2. 创建端点

   打开 API 在顶部栏中，点击 新端点，以及在 选择查询 点击您保存的查询。点击 下一页.

   开放 API

3. 配置并锁定参数

   在 配置 保持 寿命 永恒的， 响应模式 静态和 内页格式 第一个端点的 JSON 格式；模式和格式一旦创建就固定下来。 锁定参数 离开 城市 作为 可调用，或 锁 将其设置为调用者无法更改的固定值。点击 下一页.

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

   邀请 人们 通过电子邮件添加 服务密钥 点击获取工具，或者暂时跳过，然后点击 创建并获取我的密钥复制以 开头的 49 个字符的密钥 qsapi_；之后可以从……中再次揭示。 共享 点击标签。 发送 在控制台中发起第一次调用。

无论从哪里拨打电话

将端点 ID 替换为您自己的 ID。 qsapi_YOUR_KEY 用你的钥匙：

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

{
  “列”: [ { “姓名”: "customer_id", “类型”: 整数 }, { “姓名”: “姓名”, “类型”: “细绳” }, { “姓名”: “城市”, “类型”: “细绳” } ],
  “行”: [
    { "customer_id": 1042, “姓名”: “北风贸易公司”, “城市”: “西雅图” },
    { "customer_id": 1057, “姓名”: “高山装备店”, “城市”: “丹佛” },
    { "customer_id": 1063, “姓名”: “港口食品”, “城市”: “哈利法克斯” }
  ],
  “元”: { 行数: 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": {"city": "Seattle"}}'

格式=csv

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

?sample=true

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

压缩=lz4

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

授权：Bearer qsapi_…

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

它的插头在哪里

按连接器指南

Query Streams 支持的所有连接器都可以以这种方式发布。请选择您需要的连接器：

你运行的数据库

• 微软 SQL 服务器
• PostgreSQL
• MySQL
• 玛丽亚数据库
• 甲骨文
• SQLite
• Microsoft Access
• 鸭子数据库
• 苏帕巴

数据仓库

• 雪花
• Google BigQuery

托管数据库

• 氖
• 亚马逊 RDS
• Azure Database for PostgreSQL
• Azure Database for MySQL
• Azure SQL
• Google Cloud SQL
• Google AlloyDB
• DigitalOcean托管数据库
• 艾文
• 脆桥
• Heroku Postgres
• 使成为
• 铁路
• Fly.io Postgres
• Vultr托管数据库
• OVHcloud托管数据库
• Scaleway托管数据库
• OCI 数据库与 PostgreSQL
• MySQL 热浪
• IBM Cloud Databases for PostgreSQL
• MariaDB SkySQL
• 萨塔
• 时间尺度云
• PlanetScale Postgres
• Prisma Postgres
• 科耶布
• 尼罗河

文件和日志文件夹

• 文件系统
• CSV文件夹
• 镶木地板文件夹
• Excel文件夹
• SQLite文件夹
• JSONL文件夹
• 多记录 CSV
• 机器日志
• Web服务器日志
• 容器日志
• 应用程序日志
• 系统日志
• 自定义日志

SaaS 和 API 连接器

• 条纹
• Shopify
• HubSpot
• 谷歌广告
• 谷歌分析 4
• 谷歌搜索控制台
• ShipStation
• iTick

消费者指南： 通过 Power Query M 集成 Power BI 和 Excel.

这些计划允许什么？

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

确保安全

当某些事情不起作用时

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

人们提出的问题

相关指南

• Power BI REST API：无需 ODBC 驱动程序即可连接实时 SQL 数据
• 通过 MCP 将查询流连接到 Claude
• 共享实时数据，而非凭证
• 数据库 REST API 功能概述