Class DataSourceTable

DataSourceTable (link em inglês)

Acesse e modifique a tabela de fonte de dados existente. Para criar uma nova tabela de fonte de dados em uma nova página, use Spreadsheet.insertSheetWithDataSourceTable(spec).

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

Neste exemplo, mostramos como criar uma nova tabela de fonte de dados. 

SpreadsheetApp.enableBigQueryExecution();
var spreadsheet = SpreadsheetApp.getActive();
var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();
// Starts data execution asynchronously.
var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
var dataSourceTable = dataSheet.getDataSourceTables()[0];
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

Neste exemplo, mostramos como editar uma fonte de dados. 

SpreadsheetApp.enableBigQueryExecution();
var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1");
var dataSourceTable = dataSheet.getDataSourceTables()[0];
var dataSource = dataSourceTable.getDataSource();
var newSpec = dataSource.getSpec()
              .copy()
              .asBigQuery()
              .setRawQuery('select name from table limit 2')
              .removeAllParameters()
              .build();
// Updates data source specification and starts data execution asynchronously.
dataSource.updateSpec(newSpec);
// Check status during execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

Métodos

MétodoTipo de retornoBreve descrição
addColumns(columnNames)DataSourceTableAdiciona colunas à tabela de fonte de dados.
addFilter(columnName, filterCriteria)DataSourceTableAdiciona um filtro aplicado à tabela de fonte de dados.
addSortSpec(columnName, ascending)DataSourceTableAdiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.
addSortSpec(columnName, sortOrder)DataSourceTableAdiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.
forceRefreshData()DataSourceTableAtualiza os dados deste objeto, independentemente do estado atual.
getColumns()DataSourceTableColumn[]Recebe todas as colunas da fonte de dados adicionadas à tabela de fonte de dados.
getDataSource()DataSourceAcessa a fonte de dados vinculada ao objeto.
getFilters()DataSourceTableFilter[]Retorna todos os filtros aplicados à tabela de fonte de dados.
getRange()RangeRecebe o Range que essa tabela de fonte de dados abrange.
getRowLimit()IntegerRetorna o limite de linhas da tabela de fonte de dados.
getSortSpecs()SortSpec[]Recebe todas as especificações de classificação na tabela de fonte de dados.
getStatus()DataExecutionStatusAcessa o status de execução de dados do objeto.
isSyncingAllColumns()BooleanRetorna se a tabela da fonte de dados está sincronizando todas as colunas na fonte de dados associada.
refreshData()DataSourceTableAtualiza os dados do objeto.
removeAllColumns()DataSourceTableRemove todas as colunas na tabela de fonte de dados.
removeAllSortSpecs()DataSourceTableRemove todas as especificações de classificação na tabela de fonte de dados.
setRowLimit(rowLimit)DataSourceTableAtualiza o limite de linhas da tabela de fonte de dados.
syncAllColumns()DataSourceTableSincronizar todas as colunas atuais e futuras na fonte de dados associada com a tabela de fonte de dados.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAguarda até que a execução atual seja concluída, expirando após o número de segundos informado.

Documentação detalhada

addColumns(columnNames)

Adiciona colunas à tabela de fonte de dados.

Parâmetros

NomeTipoDescrição
columnNamesString[]A lista dos nomes das colunas a serem adicionadas.

Retornar

DataSourceTable: a tabela de fonte de dados, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addFilter(columnName, filterCriteria)

Adiciona um filtro aplicado à tabela de fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringNome da coluna a que este filtro será aplicado.
filterCriteriaFilterCriteriaSão os critérios de filtro a serem aplicados.

Retornar

DataSourceTable: a tabela de fonte de dados, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, ascending)

Adiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringNome da coluna a ser classificada.
ascendingBooleanSe true, classifique a coluna em ordem crescente. Se false, classifique a coluna em ordem decrescente.

Retornar

DataSourceTable: a página da fonte de dados para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, sortOrder)

Adiciona uma especificação de classificação em uma coluna na tabela de fonte de dados.

Parâmetros

NomeTipoDescrição
columnNameStringNome da coluna a ser classificada.
sortOrderSortOrderA ordem de classificação.

Retornar

DataSourceTable: a página da fonte de dados para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

Atualiza os dados deste objeto, independentemente do estado atual. Consulte refreshData() para ver mais detalhes.

Uma exceção vai ser gerada se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Retornar

DataSourceTable: o objeto de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

Recebe todas as colunas da fonte de dados adicionadas à tabela de fonte de dados.

Retornar

DataSourceTableColumn[]: uma lista de colunas da tabela de fonte de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

Acessa a fonte de dados vinculada ao objeto.

Retornar

DataSource: a fonte de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

Retorna todos os filtros aplicados à tabela de fonte de dados.

Retornar

DataSourceTableFilter[]: uma matriz de todos os filtros aplicados à tabela de fonte de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Recebe o Range que essa tabela de fonte de dados abrange.

Retornar

Range: o intervalo.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRowLimit()

Retorna o limite de linhas da tabela de fonte de dados.

Retornar

Integer: o limite de linha para a tabela de fonte de dados ou null se nenhum limite estiver definido e a tabela usar o limite máximo padrão, como na IU do Planilhas Google.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

Recebe todas as especificações de classificação na tabela de fonte de dados.

Retornar

SortSpec[]: uma lista de especificações de classificação.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

Acessa o status de execução de dados do objeto.

Retornar

DataExecutionStatus: o status da execução de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isSyncingAllColumns()

Retorna se a tabela da fonte de dados está sincronizando todas as colunas na fonte de dados associada.

Retornar

Boolean: True se a tabela de fonte de dados estiver sincronizando todas as colunas na fonte de dados associada ou false se não estiver.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

Atualiza os dados do objeto.

Lança uma exceção se estiver no estado error. Use DataSource#updateSpec() para atualizar a especificação. O método tem preferência sobre forceRefreshData() para evitar edições inesperadas na fonte de dados.

Uma exceção vai ser gerada se o tipo de fonte de dados não estiver ativado. Use métodos SpreadsheetApp#enable...Execution() para ativar a execução de dados para um tipo específico de fonte de dados.

Retornar

DataSourceTable: o objeto de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllColumns()

Remove todas as colunas na tabela de fonte de dados.

Retornar

DataSourceTable: a tabela de fonte de dados, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllSortSpecs()

Remove todas as especificações de classificação na tabela de fonte de dados.

Retornar

DataSourceTable: a página da fonte de dados para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRowLimit(rowLimit)

Atualiza o limite de linhas da tabela de fonte de dados. Se o limite de linhas informado for null, a tabela de fonte de dados será atualizada para usar o limite máximo padrão de linhas na IU do Planilhas Google.

Parâmetros

NomeTipoDescrição
rowLimitIntegerO novo limite de linhas da tabela de dados. Se null, atualiza a tabela para usar o limite de linhas padrão.

Retornar

DataSourceTable: a tabela de fonte de dados, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

syncAllColumns()

Sincronizar todas as colunas atuais e futuras na fonte de dados associada com a tabela de fonte de dados.

Retornar

DataSourceTable: a tabela de fonte de dados, para encadeamento.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

Aguarda até que a execução atual seja concluída, expirando após o número de segundos informado. Emite uma exceção se a execução não é concluída ao expirar, mas não cancela a execução de dados.

Parâmetros

NomeTipoDescrição
timeoutInSecondsIntegerTempo de espera da execução de dados, em segundos. O máximo é de 300 segundos.

Retornar

DataExecutionStatus: o status da execução de dados.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets