Esta página foi traduzida pela API Cloud Translation.

Class BigQueryDataSourceSpecBuilder

O builder de BigQueryDataSourceSpecBuilder.

Métodos

Método	Tipo de retorno	Breve descrição
`build()`	`DataSourceSpec`	Cria uma especificação de fonte de dados com base nas configurações deste criador.
`copy()`	`DataSourceSpecBuilder`	Cria uma `DataSourceSpecBuilder` com base nas configurações da fonte de dados.
`getDatasetId()`	`String`	Extrai o ID do conjunto de dados do BigQuery.
`getParameters()`	`DataSourceParameter[]`	Recebe os parâmetros da fonte de dados.
`getProjectId()`	`String`	Recebe o ID do projeto de faturamento.
`getRawQuery()`	`String`	Recebe a string de consulta bruta.
`getTableId()`	`String`	Extrai o ID da tabela do BigQuery.
`getTableProjectId()`	`String`	Extrai o ID do projeto do BigQuery para a tabela.
`getType()`	`DataSourceType`	Recebe o tipo da fonte de dados.
`removeAllParameters()`	`BigQueryDataSourceSpecBuilder`	Remove todos os parâmetros.
`removeParameter(parameterName)`	`BigQueryDataSourceSpecBuilder`	Remove o parâmetro especificado.
`setDatasetId(datasetId)`	`BigQueryDataSourceSpecBuilder`	Define o ID do conjunto de dados do BigQuery.
`setParameterFromCell(parameterName, sourceCell)`	`BigQueryDataSourceSpecBuilder`	Adiciona um parâmetro ou, se o parâmetro com o nome existir, atualiza a célula de origem para construtores de especificação de origem de dados do tipo `DataSourceType.BIGQUERY`.
`setProjectId(projectId)`	`BigQueryDataSourceSpecBuilder`	Define o ID do projeto do BigQuery de faturamento.
`setRawQuery(rawQuery)`	`BigQueryDataSourceSpecBuilder`	Define a string de consulta bruta.
`setTableId(tableId)`	`BigQueryDataSourceSpecBuilder`	Define o ID da tabela do BigQuery.
`setTableProjectId(projectId)`	`BigQueryDataSourceSpecBuilder`	Define o ID do projeto do BigQuery para a tabela.

Documentação detalhada

`build()`

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

O exemplo de código a seguir cria uma especificação de fonte de dados do 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();

O exemplo de código a seguir cria uma especificação de fonte de dados do Looker.

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

Retornar

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

`copy()`

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

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

Retornar

DataSourceSpecBuilder: o builder.

`getDatasetId()`

Extrai o ID do conjunto de dados do BigQuery.

Retornar

String: o ID do conjunto de dados ou uma string vazia se a especificação da fonte de dados for definida por uma consulta bruta.

`getParameters()`

Recebe os parâmetros da fonte de dados.

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

Esse método está disponível apenas para fontes de dados do BigQuery.

Retornar

DataSourceParameter[]: a lista de parâmetros.

`getProjectId()`

Recebe o ID do projeto de faturamento.

Retornar

String: o ID do projeto.

`getRawQuery()`

Recebe a string de consulta bruta.

Retornar

String: a string de consulta bruta.

`getTableId()`

Extrai o ID da tabela do BigQuery.

Retornar

String: o ID da tabela ou uma string vazia se a especificação da fonte de dados for definida por uma consulta bruta.

`getTableProjectId()`

Extrai o ID do projeto do BigQuery para a tabela.

Retornar

String: o ID do projeto da tabela ou uma string vazia se a especificação da fonte de dados for definida por uma consulta bruta.

`getType()`

Recebe o tipo da fonte de dados.

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

Retornar

DataSourceType: o tipo de origem de dados.

`removeAllParameters()`

Remove todos os parâmetros.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.

`removeParameter(parameterName)`

Remove o parâmetro especificado.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Parâmetros

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

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.

`setDatasetId(datasetId)`

Define o ID do conjunto de dados do BigQuery.

Parâmetros

Nome	Tipo	Descrição
`datasetId`	`String`	O ID do conjunto de dados.

Retornar

BigQueryDataSourceSpecBuilder: este 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 para construtores de especificação de origem de dados do tipo DataSourceType.BIGQUERY.

Esse método está disponível apenas para fontes de dados do BigQuery.

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

Parâmetros

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

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.

`setProjectId(projectId)`

Define o ID do projeto do BigQuery de faturamento.

Parâmetros

Nome	Tipo	Descrição
`projectId`	`String`	O ID do projeto de faturamento.

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.

`setRawQuery(rawQuery)`

Define a string de consulta bruta.

Parâmetros

Nome	Tipo	Descrição
`rawQuery`	`String`	A string de consulta bruta.

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.

`setTableId(tableId)`

Define o ID da tabela do BigQuery.

Parâmetros

Nome	Tipo	Descrição
`tableId`	`String`	O ID da tabela.

Retornar

BigQueryDataSourceSpecBuilder: este builder, para encadeamento.

`setTableProjectId(projectId)`

Define o ID do projeto do BigQuery para a tabela.

Parâmetros

Nome	Tipo	Descrição
`projectId`	`String`	O ID do projeto da tabela do BigQuery.

Retornar

BigQueryDataSourceSpecBuilder: o builder para encadeamento.