Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder 的构建器。

方法

方法	返回类型	简介
build()	DataSourceSpec	根据此构建工具中的设置构建数据源规范。
copy()	DataSourceSpecBuilder	根据此数据源的设置创建 DataSourceSpecBuilder。
getDatasetId()	String	获取 BigQuery 数据集 ID。
getParameters()	DataSourceParameter[]	获取数据源的参数。
getProjectId()	String	获取结算项目 ID。
getRawQuery()	String	获取原始查询字符串。
getTableId()	String	获取 BigQuery 表 ID。
getTableProjectId()	String	获取表的 BigQuery 项目 ID。
getType()	DataSourceType	获取数据源的类型。
removeAllParameters()	BigQueryDataSourceSpecBuilder	移除所有参数。
removeParameter(parameterName)	BigQueryDataSourceSpecBuilder	移除指定的参数。
setDatasetId(datasetId)	BigQueryDataSourceSpecBuilder	设置 BigQuery 数据集 ID。
setParameterFromCell(parameterName, sourceCell)	BigQueryDataSourceSpecBuilder	添加参数；如果存在具有相应名称的参数，则更新类型为 DataSourceType.BIGQUERY 的数据源规范构建器的来源单元格。
setProjectId(projectId)	BigQueryDataSourceSpecBuilder	设置结算 BigQuery 项目 ID。
setRawQuery(rawQuery)	BigQueryDataSourceSpecBuilder	设置原始查询字符串。
setTableId(tableId)	BigQueryDataSourceSpecBuilder	设置 BigQuery 表 ID。
setTableProjectId(projectId)	BigQueryDataSourceSpecBuilder	设置表的 BigQuery 项目 ID。

详细文档

build()

根据此构建工具中的设置构建数据源规范。必须先使用 as...() 指定数据源类型，然后才能进行构建。

以下代码示例会构建 BigQuery DataSource 规范。

const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');

bigQueryDataSourceSpec.build();

以下代码示例会构建 Looker 数据源规范。

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

返回

DataSourceSpec - 数据源规范。

---

copy()

根据此数据源的设置创建 DataSourceSpecBuilder。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();

const newSpec = spec.copy();

返回

DataSourceSpecBuilder - 构建器。

---

getDatasetId()

获取 BigQuery 数据集 ID。

返回

String - 数据集 ID，如果数据源规范由原始查询定义，则为空字符串。

---

getParameters()

获取数据源的参数。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

此方法仅适用于 BigQuery 数据源。

返回

DataSourceParameter[] - 参数列表。

---

getProjectId()

获取结算项目 ID。

返回

String - 项目 ID。

---

getRawQuery()

获取原始查询字符串。

返回

String - 原始查询字符串。

---

getTableId()

获取 BigQuery 表 ID。

返回

String - 表 ID，如果数据源规范由原始查询定义，则为空字符串。

---

getTableProjectId()

获取表的 BigQuery 项目 ID。

返回

String - 表项目 ID；如果数据源规范由原始查询定义，则为空字符串。

---

getType()

获取数据源的类型。

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

返回

DataSourceType - 数据源类型。

---

removeAllParameters()

移除所有参数。

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。

---

removeParameter(parameterName)

移除指定的参数。

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

参数

名称	类型	说明
parameterName	String	要移除的参数的名称。

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。

---

setDatasetId(datasetId)

设置 BigQuery 数据集 ID。

参数

名称	类型	说明
datasetId	String	数据集的 ID。

返回

BigQueryDataSourceSpecBuilder - 此构建器，用于链式调用。

---

setParameterFromCell(parameterName, sourceCell)

添加参数；如果具有该名称的参数已存在，则更新类型为 DataSourceType.BIGQUERY 的数据源规范构建器的来源单元格。

此方法仅适用于 BigQuery 数据源。

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

参数

名称	类型	说明
parameterName	String	参数名称。
sourceCell	String	源单元格，如 A1 表示法中所指定。

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。

---

setProjectId(projectId)

设置结算 BigQuery 项目 ID。

参数

名称	类型	说明
projectId	String	结算项目的 ID。

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。

---

setRawQuery(rawQuery)

设置原始查询字符串。

参数

名称	类型	说明
rawQuery	String	原始查询字符串。

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。

---

setTableId(tableId)

设置 BigQuery 表 ID。

参数

名称	类型	说明
tableId	String	表的 ID。

返回

BigQueryDataSourceSpecBuilder - 此构建器，用于链式调用。

---

setTableProjectId(projectId)

设置表的 BigQuery 项目 ID。

参数

名称	类型	说明
projectId	String	BigQuery 表的项目 ID。

返回

BigQueryDataSourceSpecBuilder - 用于链接的构建器。