Esta página foi traduzida pela API Cloud Translation.

Class 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.

Neste exemplo, 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étodo	Tipo de retorno	Breve descrição
`asBigQuery()`	`BigQueryDataSourceSpecBuilder`	Recebe o builder da fonte de dados do BigQuery.
`build()`	`DataSourceSpec`	Cria uma especificação da fonte de dados com base nas configurações deste builder.
`copy()`	`DataSourceSpecBuilder`	Cria um `DataSourceSpecBuilder` com base nas configurações dessa fonte de dados.
`getParameters()`	`DataSourceParameter[]`	Recebe os parâmetros da fonte de dados.
`getType()`	`DataSourceType`	Recebe o tipo da fonte de dados.
`removeAllParameters()`	`DataSourceSpecBuilder`	Remove todos os parâmetros.
`removeParameter(parameterName)`	`DataSourceSpecBuilder`	Remove o parâmetro especificado.
`setParameterFromCell(parameterName, sourceCell)`	`DataSourceSpecBuilder`	Adiciona um parâmetro ou, se houver um parâmetro com o nome, 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ções da fonte de dados do BigQuery.

`build()`

Cria uma especificação da 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.

Retornar

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

`copy()`

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

Retornar

DataSourceSpecBuilder: o builder.

`getParameters()`

Recebe os parâmetros da fonte de dados.

Retornar

DataSourceParameter[]: a lista de parâmetros.

`getType()`

Recebe 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

Nome	Tipo	Descrição
`parameterName`	`String`	O nome do parâmetro a ser removido.

Retornar

DataSourceSpecBuilder: o builder para encadeamento.

`setParameterFromCell(parameterName, sourceCell)`

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

Parâmetros

Nome	Tipo	Descrição
`parameterName`	`String`	O nome do parâmetro.
`sourceCell`	`String`	A célula de origem, conforme especificado na notação A1.

Retornar

DataSourceSpecBuilder: o builder para encadeamento.