Class DataSourceTable

DataSourceTable

Accedi e modifica la tabella dell'origine dati esistente. Per creare una nuova tabella dell'origine dati in un nuovo foglio, usa Spreadsheet.insertSheetWithDataSourceTable(spec).

Utilizza questa classe solo con le origini dati BigQuery.

Questo esempio mostra come creare una nuova tabella dell'origine dati. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActive();
const 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.
const dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
const 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(),
);

Questo esempio mostra come modificare un'origine dati. 

SpreadsheetApp.enableBigQueryExecution();
const dataSheet = SpreadsheetApp.getActive().getSheetByName('Data Sheet 1');
const dataSourceTable = dataSheet.getDataSourceTables()[0];
const dataSource = dataSourceTable.getDataSource();
const 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(),
);

Metodi

MetodoTipo restituitoBreve descrizione
addColumns(columnNames)DataSourceTableAggiunge colonne alla tabella dell'origine dati.
addFilter(columnName, filterCriteria)DataSourceTableAggiunge un filtro applicato alla tabella dell'origine dati.
addSortSpec(columnName, ascending)DataSourceTableAggiunge una specifica di ordinamento a una colonna nella tabella dell'origine dati.
addSortSpec(columnName, sortOrder)DataSourceTableAggiunge una specifica di ordinamento a una colonna nella tabella dell'origine dati.
cancelDataRefresh()DataSourceTableAnnullamento dell'aggiornamento dei dati associato a questo oggetto se è in esecuzione.
forceRefreshData()DataSourceTableAggiorna i dati di questo oggetto indipendentemente dallo stato corrente.
getColumns()DataSourceTableColumn[]Recupera tutte le colonne dell'origine dati aggiunte alla tabella dell'origine dati.
getDataSource()DataSourceRecupera l'origine dati a cui è collegato l'oggetto.
getFilters()DataSourceTableFilter[]Restituisce tutti i filtri applicati alla tabella dell'origine dati.
getRange()RangeRecupera l'Range coperto da questa tabella dell'origine dati.
getRowLimit()IntegerRestituisce il limite di righe per la tabella dell'origine dati.
getSortSpecs()SortSpec[]Recupera tutte le specifiche di ordinamento nella tabella dell'origine dati.
getStatus()DataExecutionStatusRecupera lo stato di esecuzione dei dati dell'oggetto.
isSyncingAllColumns()BooleanRestituisce se la tabella dell'origine dati sincronizza tutte le colonne dell'origine dati associata.
refreshData()DataSourceTableAggiorna i dati dell'oggetto.
removeAllColumns()DataSourceTableRimuove tutte le colonne nella tabella dell'origine dati.
removeAllSortSpecs()DataSourceTableRimuove tutte le specifiche di ordinamento nella tabella dell'origine dati.
setRowLimit(rowLimit)DataSourceTableAggiorna il limite di righe per la tabella dell'origine dati.
syncAllColumns()DataSourceTableSincronizza tutte le colonne correnti e future nell'origine dati associata con la tabella dell'origine dati.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttende il completamento dell'esecuzione corrente e termina dopo il numero di secondi specificato.

Documentazione dettagliata

addColumns(columnNames)

Aggiunge colonne alla tabella dell'origine dati.

Parametri

NomeTipoDescrizione
columnNamesString[]L'elenco dei nomi delle colonne da aggiungere.

Invio

DataSourceTable: la tabella dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addFilter(columnName, filterCriteria)

Aggiunge un filtro applicato alla tabella dell'origine dati.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna a cui applicare questo filtro.
filterCriteriaFilterCriteriaI criteri del filtro da applicare.

Invio

DataSourceTable: la tabella dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addSortSpec(columnName, ascending)

Aggiunge una specifica di ordinamento a una colonna nella tabella dell'origine dati.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna da ordinare.
ascendingBooleanSe true, ordina la colonna in ordine crescente; se false, ordinala in ordine decrescente.

Invio

DataSourceTable: il foglio dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addSortSpec(columnName, sortOrder)

Aggiunge una specifica di ordinamento a una colonna nella tabella dell'origine dati.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna da ordinare.
sortOrderSortOrderL'ordinamento.

Invio

DataSourceTable: il foglio dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

cancelDataRefresh()

Annullamento dell'aggiornamento dei dati associato a questo oggetto se è in esecuzione.

Questo esempio mostra come annullare l'aggiornamento di una formula. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Viene lanciata un'eccezione se il tipo di origine dati non è attivo. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

Invio

DataSourceTable: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

forceRefreshData()

Aggiorna i dati di questo oggetto indipendentemente dallo stato corrente. Per maggiori dettagli, consulta refreshData(). Se vuoi annullare un aggiornamento di questo oggetto attualmente in esecuzione, consulta cancelDataRefresh().

Viene lanciata un'eccezione se il tipo di origine dati non è attivo. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

Invio

DataSourceTable: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getColumns()

Recupera tutte le colonne dell'origine dati aggiunte alla tabella dell'origine dati.

Invio

DataSourceTableColumn[]: un elenco di colonne della tabella dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getDataSource()

Recupera l'origine dati a cui è collegato l'oggetto.

Invio

DataSource: l'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getFilters()

Restituisce tutti i filtri applicati alla tabella dell'origine dati.

Invio

DataSourceTableFilter[]: un array di tutti i filtri applicati alla tabella dell'origine dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRange()

Recupera l'Range coperto da questa tabella dell'origine dati.

Invio

Range: l'intervallo.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getRowLimit()

Restituisce il limite di righe per la tabella dell'origine dati.

Invio

Integer: il limite di righe per la tabella dell'origine dati oppure null se non è impostato alcun limite e la tabella utilizza il limite massimo predefinito come nell'interfaccia utente di Fogli Google.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getSortSpecs()

Recupera tutte le specifiche di ordinamento nella tabella dell'origine dati.

Invio

SortSpec[]: un elenco di specifiche di ordinamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

getStatus()

Recupera lo stato di esecuzione dei dati dell'oggetto.

Invio

DataExecutionStatus: lo stato di esecuzione dei dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

isSyncingAllColumns()

Restituisce se la tabella dell'origine dati sincronizza tutte le colonne dell'origine dati associata.

Invio

Boolean: True se la tabella dell'origine dati sincronizza tutte le colonne nell'origine dati associata o false in caso contrario.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

refreshData()

Aggiorna i dati dell'oggetto.

Genera un'eccezione se è attualmente nello stato error. Utilizza DataSource#updateSpec() per aggiornare la specifica. Il metodo è preferito a forceRefreshData() per evitare modifiche impreviste all'origine dati.

Viene lanciata un'eccezione se il tipo di origine dati non è attivo. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per un tipo di origine dati specifico.

Invio

DataSourceTable: l'oggetto dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeAllColumns()

Rimuove tutte le colonne nella tabella dell'origine dati.

Invio

DataSourceTable: la tabella dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

removeAllSortSpecs()

Rimuove tutte le specifiche di ordinamento nella tabella dell'origine dati.

Invio

DataSourceTable: il foglio dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

setRowLimit(rowLimit)

Aggiorna il limite di righe per la tabella dell'origine dati. Se il limite di righe specificato è null, viene aggiornata la tabella dell'origine dati in modo da utilizzare il limite di righe massimo predefinito come nell'interfaccia utente di Fogli Google.

Parametri

NomeTipoDescrizione
rowLimitIntegerIl nuovo limite di righe per la tabella di dati. Se null, aggiorna la tabella in modo da utilizzare il limite di righe predefinito.

Invio

DataSourceTable: la tabella dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

syncAllColumns()

Sincronizza tutte le colonne correnti e future nell'origine dati associata con la tabella dell'origine dati.

Invio

DataSourceTable: la tabella dell'origine dati per l'accodamento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

waitForCompletion(timeoutInSeconds)

Attende il completamento dell'esecuzione corrente e termina dopo il numero di secondi specificato. Genera un'eccezione se l'esecuzione non è completata al termine del timeout, ma non annulla l'esecuzione dei dati.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per l'esecuzione dei dati, in secondi. Il valore massimo è 300 secondi.

Invio

DataExecutionStatus: lo stato di esecuzione dei dati.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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