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 i dati collegati a un database.
Questo esempio mostra come creare una nuova tabella dell'origine dati.
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());
Questo esempio mostra come modificare un'origine dati.
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());
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
addColumns(columnNames) | DataSourceTable | Aggiunge colonne alla tabella dell'origine dati. |
addFilter(columnName, filterCriteria) | DataSourceTable | Aggiunge un filtro applicato alla tabella dell'origine dati. |
addSortSpec(columnName, ascending) | DataSourceTable | Aggiunge una specifica di ordinamento su una colonna della tabella dell'origine dati. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Aggiunge una specifica di ordinamento su una colonna della tabella dell'origine dati. |
cancelDataRefresh() | DataSourceTable | Annulla l'aggiornamento dei dati associato a questo oggetto se è attualmente in esecuzione. |
forceRefreshData() | DataSourceTable | Aggiorna i dati dell'oggetto indipendentemente dallo stato attuale. |
getColumns() | DataSourceTableColumn[] | Recupera tutte le colonne dell'origine dati aggiunte alla tabella dell'origine dati. |
getDataSource() | DataSource | Recupera l'origine dati a cui è collegato l'oggetto. |
getFilters() | DataSourceTableFilter[] | Restituisce tutti i filtri applicati alla tabella dell'origine dati. |
getRange() | Range | Recupera il valore Range di questa tabella dell'origine dati. |
getRowLimit() | Integer | Restituisce il limite di righe per la tabella dell'origine dati. |
getSortSpecs() | SortSpec[] | Recupera tutte le specifiche di ordinamento nella tabella dell'origine dati. |
getStatus() | DataExecutionStatus | Restituisce lo stato di esecuzione dei dati dell'oggetto. |
isSyncingAllColumns() | Boolean | Indica se la tabella dell'origine dati sta sincronizzando tutte le colonne nell'origine dati associata. |
refreshData() | DataSourceTable | Aggiorna i dati dell'oggetto. |
removeAllColumns() | DataSourceTable | Rimuove tutte le colonne nella tabella dell'origine dati. |
removeAllSortSpecs() | DataSourceTable | Rimuove tutte le specifiche di ordinamento nella tabella dell'origine dati. |
setRowLimit(rowLimit) | DataSourceTable | Aggiorna il limite di righe per la tabella dell'origine dati. |
syncAllColumns() | DataSourceTable | Sincronizza tutte le colonne attuali e future dell'origine dati associata con la tabella dell'origine dati. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. |
Documentazione dettagliata
addColumns(columnNames)
Aggiunge colonne alla tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnNames | String[] | L'elenco dei nomi delle colonne da aggiungere. |
Ritorni
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
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna a cui applicare il filtro. |
filterCriteria | FilterCriteria | I criteri del filtro da applicare. |
Ritorni
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 su una colonna della tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
ascending | Boolean | Se true , ordina la colonna in ordine crescente; se false , ordina la colonna in ordine decrescente. |
Ritorni
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 su una colonna della tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
sortOrder | SortOrder | L'ordinamento. |
Ritorni
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 abilitare l'esecuzione dei dati per un tipo di origine dati specifico.
Ritorni
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 dell'oggetto indipendentemente dallo stato attuale. Per ulteriori dettagli, visita la pagina refreshData()
. Se vuoi annullare un aggiornamento attualmente in esecuzione di questo oggetto, vedi cancelDataRefresh()
.
Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per abilitare l'esecuzione dei dati per un tipo di origine dati specifico.
Ritorni
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.
Ritorni
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.
Ritorni
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.
Ritorni
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 il valore Range
di questa tabella dell'origine dati.
Ritorni
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.
Ritorni
Integer
: limite di righe per la tabella dell'origine dati o null
se non viene impostato alcun limite e la tabella utilizza il limite massimo predefinito indicato nell'UI 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.
Ritorni
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()
Restituisce lo stato di esecuzione dei dati dell'oggetto.
Ritorni
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()
Indica se la tabella dell'origine dati sta sincronizzando tutte le colonne nell'origine dati associata.
Ritorni
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 lo stato è error
. Utilizza DataSource#updateSpec()
per aggiornare la specifica. Questo metodo è preferito rispetto 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 abilitare l'esecuzione dei dati per un tipo di origine dati specifico.
Ritorni
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.
Ritorni
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.
Ritorni
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
,
aggiorna la tabella dell'origine dati in modo che utilizzi il limite massimo predefinito di righe indicato nell'interfaccia utente di Fogli Google.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
rowLimit | Integer | Il nuovo limite di righe per la tabella di dati. Se null , aggiorna la tabella in modo da utilizzare il limite di righe predefinito. |
Ritorni
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 attuali e future dell'origine dati associata con la tabella dell'origine dati.
Ritorni
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 specificato. Genera un'eccezione se l'esecuzione non viene completata al momento del timeout, ma non annulla l'esecuzione dei dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
timeoutInSeconds | Integer | Il tempo di attesa per l'esecuzione dei dati, in secondi. Il massimo è 300 secondi. |
Ritorni
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