Class DataSourceSpecBuilder

DataSourceSpecBuilder

Построитель DataSourceSpec . Чтобы создать спецификацию для определенного типа, используйте метод as...() . Чтобы создать новый построитель, используйте SpreadsheetApp.newDataSourceSpec() . Чтобы использовать спецификацию, см. DataSourceTable .

Используйте этот класс только с данными, подключенными к базе данных.

В этом примере показано, как создать спецификацию источника данных BigQuery.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();

В этом примере показано, как создать спецификацию источника данных Looker. Он возвращает объект LookerDataSourceSpec после использования build() .

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Методы

Метод	Тип возврата	Краткое описание
asBigQuery()	BigQueryDataSourceSpecBuilder	Получает построитель для источника данных BigQuery.
asLooker()	LookerDataSourceSpecBuilder	Получает построитель для источника данных Looker.
build()	DataSourceSpec	Создает спецификацию источника данных на основе настроек этого построителя.
copy()	DataSourceSpecBuilder	Создает DataSourceSpecBuilder на основе настроек этого источника данных.
getParameters()	DataSourceParameter[]	Получает параметры источника данных.
getType()	DataSourceType	Получает тип источника данных.
removeAllParameters()	DataSourceSpecBuilder	Удаляет все параметры.
removeParameter(parameterName)	DataSourceSpecBuilder	Удаляет указанный параметр.
setParameterFromCell(parameterName, sourceCell)	DataSourceSpecBuilder	Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для построителей спецификаций источника данных типа DataSourceType.BIGQUERY .

Подробная документация

asBigQuery()

Получает построитель для источника данных BigQuery.

Возвращаться

BigQueryDataSourceSpecBuilder — построитель спецификаций источников данных BigQuery.

---

asLooker()

Получает построитель для источника данных Looker.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asLooker()
           .setInstanceUrl('https://looker_instance_url.com')
           .setModelName('model_name')
           .setExploreName('explore_name')
           .build();

Возвращаться

LookerDataSourceSpecBuilder — построитель спецификаций источников данных Looker.

---

build()

Создает спецификацию источника данных на основе настроек этого построителя. Необходимо использовать as...() , чтобы указать тип источника данных перед построением.

В следующем примере кода создается спецификация BigQuery DataSource.

var 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 DataSource.

var lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker();
var 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');
var spec = ss.getDataSources()[0].getSpec();

var newSpec = spec.copy();

Возвращаться

DataSourceSpecBuilder — Построитель.

---

getParameters()

Получает параметры источника данных.

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

Этот метод доступен только для источников данных BigQuery.

Возвращаться

DataSourceParameter[] — Список параметров.

---

getType()

Получает тип источника данных.

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

Возвращаться

DataSourceType — Тип источника данных.

---

removeAllParameters()

Удаляет все параметры.

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

Возвращаться

DataSourceSpecBuilder — Построитель для цепочки.

---

removeParameter(parameterName)

Удаляет указанный параметр.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

Параметры

Имя	Тип	Описание
parameterName	String	Имя параметра, который нужно удалить.

Возвращаться

DataSourceSpecBuilder — Построитель для цепочки.

---

setParameterFromCell(parameterName, sourceCell)

Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для построителей спецификаций источника данных типа DataSourceType.BIGQUERY .

Этот метод доступен только для источников данных BigQuery.

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

Параметры

Имя	Тип	Описание
parameterName	String	Имя параметра.
sourceCell	String	Исходная ячейка, как указано в нотации A1.

Возвращаться

DataSourceSpecBuilder — Построитель для цепочки.