使用 df fetch value 命令获取数据

df fetch value 命令是在 Dataform 中从数据源中提取数据的常用命令之一。它可以用来获取原始数据、结果层数据或者其他你需要的数据。

命令格式

命令格式如下：

df.fetchValue(sql: string, options?: { maxCacheAge?: number }): Promise<any>

参数说明

df.fetchValue 方法接受两个参数：

• sql: string：需要查询的 SQL 语句。
• options?: { maxCacheAge?: number }：可选参数。可以在此处设置缓存时间的最大值。

代码示例

例如，你需要获取一个数据源中的数据，具体 SQL 语句为：

SELECT COUNT(*) as count FROM table_name

那么，你就可以通过如下的方式，使用 df.fetchValue 命令在 Dataform 中获取数据：

const count = await df.fetchValue(`
  SELECT COUNT(*) as count
  FROM table_name
`);

console.log(`数据源中的数据总量为：${count}`);

返回的结果为 markdown 格式，例如：

数据源中的数据总量为：100

缓存设置

你可以通过设置 maxCacheAge 参数来设置缓存时间的最大值，单位为秒。例如，以下代码将强制 Dataform 从数据源中获取数据，并将其缓存在内存中，缓存时间为 10 分钟：

const count = await df.fetchValue(`
  SELECT COUNT(*) as count
  FROM table_name
`, { maxCacheAge: 600 });

console.log(`数据源中的数据总量为：${count}`);

总结

df fetch value 命令是 Dataform 中最常用的命令之一，它可以帮助你从数据源获取数据，并进行进一步的处理和转换。同时，在使用 df.fetchValue 命令时，你可以通过设置 maxCacheAge 参数来优化查询性能和数据缓存。