Class DataSourceTable

DataSourceTable

Accedere alla tabella dell'origine dati esistente e modificarla. Per creare una nuova tabella dell'origine dati in un nuovo foglio, utilizza 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 della tabella dell'origine dati.
addSortSpec(columnName, sortOrder)DataSourceTableAggiunge una specifica di ordinamento a una colonna della tabella dell'origine dati.
cancelDataRefresh()DataSourceTableAnnulla l'aggiornamento dei dati associato a questo oggetto, se è attualmente in esecuzione.
forceRefreshData()DataSourceTableAggiorna i dati di questo oggetto indipendentemente dallo stato attuale.
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'intervallo di Range di questa tabella dell'origine dati.
getRowLimit()Integer|nullRestituisce 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 un valore che indica 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 della 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, con timeout dopo il numero di secondi fornito.

Documentazione dettagliata

addColumns(columnNames)

Aggiunge colonne alla tabella dell'origine dati.

Parametri

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

Indietro

DataSourceTable: la tabella dell'origine dati, per il concatenamento.

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 di filtro da applicare.

Indietro

DataSourceTable: la tabella dell'origine dati, per il concatenamento.

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 della tabella dell'origine dati.

Parametri

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

Indietro

DataSourceTable: il foglio dell'origine dati, per il concatenamento.

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 della tabella dell'origine dati.

Parametri

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

Indietro

DataSourceTable: il foglio dell'origine dati, per il concatenamento.

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

Annulla l'aggiornamento dei dati associato a questo oggetto, se è attualmente 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();

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

Indietro

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 attuale. Per maggiori dettagli, consulta refreshData(). Se vuoi annullare un aggiornamento in corso di questo oggetto, consulta cancelDataRefresh().

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

Indietro

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.

Indietro

DataSourceTableColumn[]: un elenco delle 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.

Indietro

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.

Indietro

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'intervallo di Range di questa tabella dell'origine dati.

Indietro

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.

Indietro

Integer|null: il limite di righe per la tabella dell'origine dati o 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.

Indietro

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.

Indietro

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 un valore che indica se la tabella dell'origine dati sincronizza tutte le colonne dell'origine dati associata.

Indietro

Boolean: True se la tabella dell'origine dati sincronizza tutte le colonne nell'origine dati associata oppure 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 si trova nello stato error. Utilizza DataSource#updateSpec() per aggiornare la specifica. Questo metodo è preferibile a forceRefreshData() per evitare modifiche impreviste all'origine dati.

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

Indietro

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 della tabella dell'origine dati.

Indietro

DataSourceTable: la tabella dell'origine dati, per il concatenamento.

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.

Indietro

DataSourceTable: il foglio dell'origine dati, per il concatenamento.

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 fornito è null, la tabella dell'origine dati viene aggiornata in modo da utilizzare il limite massimo di righe predefinito come nell'interfaccia utente di Fogli Google.

Parametri

NomeTipoDescrizione
rowLimitIntegerIl nuovo limite di righe per la tabella dei dati. Se null, aggiorna la tabella in modo che utilizzi il limite di righe predefinito.

Indietro

DataSourceTable: la tabella dell'origine dati, per il concatenamento.

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.

Indietro

DataSourceTable: la tabella dell'origine dati, per il concatenamento.

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, con timeout dopo il numero di secondi fornito. Genera un'eccezione se l'esecuzione non viene completata al momento 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.

Indietro

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