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

Methods

メソッド戻り値の型概要
asBigQuery()BigQueryDataSourceSpecBuilderBigQuery データソースのビルダーを取得します。
build()DataSourceSpecこのビルダーの設定からデータソース仕様を作成します。
copy()DataSourceSpecBuilderこのデータソースの設定に基づいて DataSourceSpecBuilder を作成します。
getParameters()DataSourceParameter[]データソースのパラメータを取得します。
getType()DataSourceTypeデータソースのタイプを取得します。
removeAllParameters()DataSourceSpecBuilderすべてのパラメータを削除します。
removeParameter(parameterName)DataSourceSpecBuilder指定したパラメータを削除します。
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderパラメータを追加するか、この名前のパラメータが存在する場合は、そのソースセルを更新します。

詳細なドキュメント

asBigQuery()

BigQuery データソースのビルダーを取得します。

リターン

BigQueryDataSourceSpecBuilder - BigQuery データソース仕様ビルダー。


build()

このビルダーの設定からデータソース仕様を作成します。ビルドする前に、as...() を使用してデータソースのタイプを指定する必要があります。

リターン

DataSourceSpec - データソース仕様。


copy()

このデータソースの設定に基づいて DataSourceSpecBuilder を作成します。

リターン

DataSourceSpecBuilder - ビルダー。


getParameters()

データソースのパラメータを取得します。

リターン

DataSourceParameter[] - パラメータ リスト。


getType()

データソースのタイプを取得します。

リターン

DataSourceType - データソースのタイプ。


removeAllParameters()

すべてのパラメータを削除します。

リターン

DataSourceSpecBuilder - チェーン用のビルダー。


removeParameter(parameterName)

指定したパラメータを削除します。

パラメータ

名前説明
parameterNameString削除するパラメータの名前。

リターン

DataSourceSpecBuilder - チェーン用のビルダー。


setParameterFromCell(parameterName, sourceCell)

パラメータを追加するか、この名前のパラメータが存在する場合は、そのソースセルを更新します。

パラメータ

名前説明
parameterNameStringパラメータ名。
sourceCellStringソースセル(A1 表記)。

リターン

DataSourceSpecBuilder - チェーン用のビルダー。