Mosaic DuckDB 服务器

一个基于Python的服务器，运行本地DuckDB实例，并支持通过WebSocket或HTTP进行查询，以Apache Arrow或JSON格式返回数据。

注意： 此软件包提供本地DuckDB服务器。要在浏览器中使用DuckDB-WASM，请使用mosaic-core包中的wasmConnector。

安装和使用

我们建议在隔离环境中使用pipx运行服务器。例如，要直接运行服务器，使用

pipx run duckdb-server

或者，您可以使用pip install duckdb-server安装服务器。然后您可以使用duckdb-server启动服务器。

开发者设置

我们使用hatch来管理我们的开发设置。

使用hatch run serve启动开发服务器。更改代码时，服务器会重新启动。

要运行测试，使用hatch run test:cov。

要设置SSL的本地证书，使用https://github.com/FiloSottile/mkcert。

API

服务器支持通过HTTP GET和POST以及WebSocket进行查询。GET端点对于调试很有用。例如，您可以使用此url查询它。

每个端点都接受一个包含type中命令的JSON对象。服务器支持以下命令。

exec

在 sql 字段中执行 SQL 查询。

箭头

在 sql 字段中执行 SQL 查询，并以 Apache Arrow 格式返回结果。

json

在 sql 字段中执行 SQL 查询，并以 JSON 格式返回结果。

create-bundle

将 queries 字段中 SQL 查询的结果和所需的数据集缓存起来。

load-bundle

加载捆绑结果。

发布

使用 hatch build 运行构建。然后使用 hatch publish 发布。我们使用令牌进行发布，所以当被要求时，将用户名设置为 __token__，然后使用您的令牌作为密码。或者，创建一个 .pypirc 文件。