Class DataSourceSpecBuilder

DataSourceSpecBuilder

O builder de DataSourceSpec. Para criar uma especificação para determinado tipo, 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 dados conectados a um banco de dados.

Nestes exemplos, mostramos como criar uma especificação de 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 com base nas configurações deste builder.
copy()DataSourceSpecBuilderCria um DataSourceSpecBuilder com base nas configurações dessa fonte de dados.
getParameters()DataSourceParameter[]Recebe os parâmetros da fonte de dados.
getType()DataSourceTypeExtrai 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 o parâmetro com o nome existir, atualiza a célula de origem.

Documentação detalhada

asBigQuery()

Recebe o builder da fonte de dados do BigQuery.

Retorno

BigQueryDataSourceSpecBuilder: o criador de especificações da fonte de dados do BigQuery.


build()

Cria uma especificação de fonte de dados com base nas configurações deste builder. É necessário usar as...() para especificar um tipo de fonte de dados antes da criação.

Retorno

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


copy()

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

Retorno

DataSourceSpecBuilder: o builder.


getParameters()

Recebe os parâmetros da fonte de dados.

Retorno

DataSourceParameter[]: a lista de parâmetros.


getType()

Extrai o tipo da fonte de dados.

Retorno

DataSourceType: o tipo de fonte de dados.


removeAllParameters()

Remove todos os parâmetros.

Retorno

DataSourceSpecBuilder: o builder, para encadeamento.


removeParameter(parameterName)

Remove o parâmetro especificado.

Parâmetros

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

Retorno

DataSourceSpecBuilder: o builder, para encadeamento.


setParameterFromCell(parameterName, sourceCell)

Adiciona um parâmetro ou, se o parâmetro com o nome existir, 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.

Retorno

DataSourceSpecBuilder: o builder, para encadeamento.