vizbee 0.1b1

# vizbee代理


## 安装

```bash
python -m pip install vizbee
```

可选地，可以传递目标数据源作为参数进行安装
所需依赖项

```bash
python -m pip install vizbee[<source>]
```

其中`<source>`可以是以下之一

* postgresql
* oracle
* mysql
* redshift
* sqlserver
* sybase

## 使用

```bash
用法: vizbee [OPTIONS] COMMAND [ARGS]...

选项
-c, --config TEXT YAML配置文件路径。
--client-id TEXT 应用程序ID。
--client-secret TEXT 应用程序密钥。
--api-url TEXT API URL。
--help 显示此信息并退出。

命令
dashboard 管理仪表板。
dataset 管理数据集。
start 启动调度器。
sync 推送所有数据集和仪表板。
```

## 连接

本节定义了与数据存储的连接
(`default`字段设置默认连接)。

```yaml
connections
default: {DATABASE_URL}
```

目前支持的数据库有

* PostgreSQL: `postgresql://<user>:<password>@<host>/<db>`
* MySQL: `mysql://<user>:<password>@<host>/<db>`
* Oracle: `oracle://<user>:<password>@<host>/<db>`
* Redshift: `redshift://<user>:<password>@<host>/<db>`
* SQLServer: `mssql://<user>:<password>@<host>/<db>`

## 数据集

`Dataset`表示一组单独的数据

```yaml
datasets
my-dataset
name: <数据集名称>

connection: <使用的连接>

query: <用于获取数据的查询>

graph: <图形选项>

schedule: <调度规则>
```

有关详细信息，请参阅[数据集架构](https://vizbee.io/documentation/schema#dataset)。

## 仪表板

`Dashboard`表示`Dataset`集合

```yaml
dashboards
my-dashboard
name: <仪表板名称>

datasets
- <要包含的数据集>
```

有关详细信息，请参阅[仪表板架构](https://visbee.io/documentation/schema#dashboard)。

## 调度

代理可以作为一个守护进程启动，用于调度数据集更新，
需要定义一个调度规则，例如

```yaml
schedule: 5分钟
```

然后启动守护进程

```bash
vizbee start
```

对于每个`Dataset`，可以在其模式中添加一个
`schedule: <rule>`来覆盖调度规则。

调度规则格式为：`<count> <seconds|minutes|hours|days>`