Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder

Конструктор для BigQueryDataSourceSpecBuilder .

Методы

Метод Тип возвращаемого значения Краткое описание
build() Data Source Spec Создает спецификацию источника данных на основе настроек этого конструктора.
copy() Data Source Spec Builder Создает Data Source Spec Builder на основе настроек этого источника данных.
get Dataset Id() String Получает идентификатор набора данных BigQuery.
get Parameters() Data Source Parameter[] Получает параметры источника данных.
get Project Id() String Получает идентификатор проекта выставления счетов.
get Raw Query() String Получает исходную строку запроса.
get Table Id() String Получает идентификатор таблицы BigQuery.
get Table Project Id() String Получает идентификатор проекта BigQuery для таблицы.
get Type() Data Source Type Получает тип источника данных.
remove All Parameters() Big Query Data Source Spec Builder Удаляет все параметры.
remove Parameter(parameterName) Big Query Data Source Spec Builder Удаляет указанный параметр.
set Dataset Id(datasetId) Big Query Data Source Spec Builder Задает идентификатор набора данных BigQuery.
set Parameter From Cell(parameterName, sourceCell) Big Query Data Source Spec Builder Добавляет параметр или, если параметр с таким именем существует, обновляет его исходную ячейку для конструкторов спецификаций источников данных типа Data Source Type.BIGQUERY .
set Project Id(projectId) Big Query Data Source Spec Builder Устанавливает идентификатор проекта BigQuery для выставления счетов.
set Raw Query(rawQuery) Big Query Data Source Spec Builder Задает исходную строку запроса.
set Table Id(tableId) Big Query Data Source Spec Builder Задает идентификатор таблицы BigQuery.
set Table Project Id(projectId) Big Query Data Source Spec Builder Задает идентификатор проекта BigQuery для таблицы.

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

build()

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

Приведенный ниже пример кода создает спецификацию источника данных BigQuery.

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.

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

String — идентификатор набора данных или пустая строка, если спецификация источника данных определена с помощью необработанного запроса.

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()

Получает идентификатор проекта выставления счетов.

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

String — Идентификатор проекта.

getRawQuery()

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

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

String — исходная строка запроса.

getTableId()

Получает идентификатор таблицы BigQuery.

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

String — идентификатор таблицы или пустая строка, если спецификация источника данных определена с помощью необработанного запроса.

getTableProjectId()

Получает идентификатор проекта BigQuery для таблицы.

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

String — идентификатор проекта таблицы или пустая строка, если спецификация источника данных определена с помощью необработанного запроса.

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');

Параметры

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

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

BigQueryDataSourceSpecBuilder — конструктор для создания цепочек запросов.

setDatasetId(datasetId)

Задает идентификатор набора данных BigQuery.

Параметры

Имя Тип Описание
dataset Id String Идентификатор набора данных.

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

BigQueryDataSourceSpecBuilder — Этот построитель предназначен для создания цепочек запросов.

setParameterFromCell(parameterName, sourceCell)

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

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

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

Параметры

Имя Тип Описание
parameter Name String Название параметра.
source Cell String Исходная ячейка, как указано в обозначении A1.

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

BigQueryDataSourceSpecBuilder — конструктор для создания цепочек запросов.

setProjectId(projectId)

Устанавливает идентификатор проекта BigQuery для выставления счетов.

Параметры

Имя Тип Описание
project Id String Идентификатор проекта выставления счетов.

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

BigQueryDataSourceSpecBuilder — конструктор для создания цепочек запросов.

setRawQuery(rawQuery)

Задает исходную строку запроса.

Параметры

Имя Тип Описание
raw Query String Исходная строка запроса.

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

BigQueryDataSourceSpecBuilder — конструктор для создания цепочек запросов.

setTableId(tableId)

Задает идентификатор таблицы BigQuery.

Параметры

Имя Тип Описание
table Id String Идентификатор таблицы.

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

BigQueryDataSourceSpecBuilder — Этот построитель предназначен для создания цепочек запросов.

setTableProjectId(projectId)

Задает идентификатор проекта BigQuery для таблицы.

Параметры

Имя Тип Описание
project Id String Идентификатор проекта таблицы BigQuery.

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

BigQueryDataSourceSpecBuilder — конструктор для создания цепочек запросов.