Class DataSourceSpecBuilder

DataSourceSpecBuilder

O builder de DataSourceSpec. Para criar uma especificação para determinados tipos, use o método as...(). Para criar um novo builder, use SpreadsheetApp.newDataSourceSpec(). Para usar a especificação, consulte DataSourceTable.

Use essa classe apenas com os dados que estão conectados a um banco de dados.

Neste exemplo, mostramos como criar uma especificação da fonte de dados do 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();

Métodos

MétodoTipo de retornoBreve descrição
asBigQuery()BigQueryDataSourceSpecBuilderRecebe o builder da fonte de dados do BigQuery.
build()DataSourceSpecCria uma especificação de fonte de dados nas configurações do builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações da fonte de dados.
getParameters()DataSourceParameter[]Acessa os parâmetros da fonte de dados.
getType()DataSourceTypeAcessa o tipo da fonte de dados.
removeAllParameters()DataSourceSpecBuilderRemove todos os parâmetros.
removeParameter(parameterName)DataSourceSpecBuilderRemove o parâmetro especificado.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAdiciona um parâmetro ou, se houver, atualiza a célula de origem.

Documentação detalhada

asBigQuery()

Recebe o builder da fonte de dados do BigQuery.

Retornar

BigQueryDataSourceSpecBuilder: o criador de especificação de fonte de dados do BigQuery.


build()

Cria uma especificação de fonte de dados nas configurações do builder. Use as...() para especificar um tipo de fonte de dados antes de criar.

Retornar

DataSourceSpec: a especificação da fonte de dados.


copy()

Cria um DataSourceSpecBuilder com base nas configurações da fonte de dados.

Retornar

DataSourceSpecBuilder: o builder.


getParameters()

Acessa os parâmetros da fonte de dados.

Retornar

DataSourceParameter[]: a lista de parâmetros.


getType()

Acessa o tipo da fonte de dados.

Retornar

DataSourceType: o tipo de fonte de dados.


removeAllParameters()

Remove todos os parâmetros.

Retornar

DataSourceSpecBuilder: o builder, para encadeamento.


removeParameter(parameterName)

Remove o parâmetro especificado.

Parâmetros

NomeTipoDescrição
parameterNameStringO nome do parâmetro a ser removido.

Retornar

DataSourceSpecBuilder: o builder, para encadeamento.


setParameterFromCell(parameterName, sourceCell)

Adiciona um parâmetro ou, se houver, atualiza a célula de origem.

Parâmetros

NomeTipoDescrição
parameterNameStringO nome do parâmetro.
sourceCellStringA célula de origem, conforme especificado na notação A1.

Retornar

DataSourceSpecBuilder: o builder, para encadeamento.