Class DataSource

DataSource

Accedere a un'origine dati esistente e modificarla. Per creare una tabella dell'origine dati con una nuova origine dati, consulta DataSourceTable.

Utilizza questa classe solo con i dati connessi a un database.

Metodi

MetodoTipo restituitoBreve descrizione
cancelAllLinkedDataSourceObjectRefreshes()voidAnnulla tutti gli aggiornamenti attualmente in esecuzione degli oggetti dell'origine dati collegati a questa origine dati.
createCalculatedColumn(name, formula)DataSourceColumnCrea una colonna calcolata.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCrea una tabella pivot dell'origine dati da questa origine dati nella prima cella di un nuovo foglio.
createDataSourceTableOnNewSheet()DataSourceTableCrea una tabella dell'origine dati da questa origine dati nella prima cella di un nuovo foglio.
getCalculatedColumnByName(columnName)DataSourceColumn|nullRestituisce la colonna calcolata nell'origine dati che corrisponde al nome della colonna.
getCalculatedColumns()DataSourceColumn[]Restituisce tutte le colonne calcolate nell'origine dati.
getColumns()DataSourceColumn[]Restituisce tutte le colonne dell'origine dati.
getDataSourceSheets()DataSourceSheet[]Restituisce i fogli dell'origine dati associati a questa origine dati.
getSpec()DataSourceSpecRecupera la specifica dell'origine dati.
refreshAllLinkedDataSourceObjects()voidAggiorna tutti gli oggetti di origine dati collegati all'origine dati.
updateSpec(spec)DataSourceAggiorna la specifica dell'origine dati e aggiorna gli oggetti dell'origine dati collegati a questa origine dati con la nuova specifica.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAggiorna la specifica dell'origine dati e aggiorna data source sheets collegato con la nuova specifica.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttende il completamento di tutte le esecuzioni correnti degli oggetti dell'origine dati collegata, con timeout dopo il numero di secondi fornito.

Documentazione dettagliata

cancelAllLinkedDataSourceObjectRefreshes()

Annulla tutti gli aggiornamenti attualmente in esecuzione degli oggetti dell'origine dati collegati a questa origine dati.

Questo esempio mostra come annullare tutti gli aggiornamenti di un'origine dati. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

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

createCalculatedColumn(name, formula)

Crea una colonna calcolata. Questo metodo è disponibile solo per le origini dati BigQuery.

Parametri

NomeTipoDescrizione
nameStringIl nome della colonna calcolata.
formulaStringLa formula della colonna calcolata.

Indietro

DataSourceColumn: la colonna calcolata appena creata.

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

createDataSourcePivotTableOnNewSheet()

Crea una tabella pivot dell'origine dati da questa origine dati nella prima cella di un nuovo foglio. Come effetto collaterale, il nuovo foglio diventa il foglio attivo.

Indietro

DataSourcePivotTable: la tabella pivot dell'origine dati appena creata.

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

createDataSourceTableOnNewSheet()

Crea una tabella dell'origine dati da questa origine dati nella prima cella di un nuovo foglio. Come effetto collaterale, il nuovo foglio diventa il foglio attivo.

Questo metodo è disponibile solo per le origini dati BigQuery.

Indietro

DataSourceTable: la tabella dell'origine dati appena creata.

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

getCalculatedColumnByName(columnName)

Restituisce la colonna calcolata nell'origine dati che corrisponde al nome della colonna.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna calcolata da ottenere.

Indietro

DataSourceColumn|null: la colonna calcolata che corrisponde al nome della colonna oppure null se non esiste una colonna calcolata di questo tipo.

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

getCalculatedColumns()

Restituisce tutte le colonne calcolate nell'origine dati.

Le specifiche dell'origine dati di tipo DataSourceType.LOOKER restituiscono un array vuoto.

Indietro

DataSourceColumn[]: un array di tutte le colonne calcolate nell'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

getColumns()

Restituisce tutte le colonne dell'origine dati.

Indietro

DataSourceColumn[]: un array di tutti i DataSourceColumn nell'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

getDataSourceSheets()

Restituisce i fogli dell'origine dati associati a questa origine dati.

Indietro

DataSourceSheet[]: un array di fogli 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

getSpec()

Recupera la specifica dell'origine dati.

Indietro

DataSourceSpec: la specifica 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

refreshAllLinkedDataSourceObjects()

Aggiorna tutti gli oggetti di origine dati collegati 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 il tipo di origine dati specifico.

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

updateSpec(spec)

Aggiorna la specifica dell'origine dati e aggiorna gli oggetti dell'origine dati collegati a questa origine dati con la nuova specifica.

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

Genera un'eccezione se il tipo di specifica dell'origine dati è diverso dal tipo di origine dati corrente.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati da aggiornare.

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

updateSpec(spec, refreshAllLinkedObjects)

Aggiorna la specifica dell'origine dati e aggiorna data source sheets collegato con la nuova specifica.

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

Genera un'eccezione se il tipo di specifica dell'origine dati è diverso dal tipo di origine dati corrente.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati da aggiornare.
refreshAllLinkedObjectsBooleanSe true, aggiorna anche tutti gli oggetti di origine dati collegati a questa origine dati.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Attende il completamento di tutte le esecuzioni correnti degli oggetti dell'origine dati collegata, con timeout dopo il numero di secondi fornito. Genera un'eccezione se le esecuzioni non vengono completate quando si verifica il timeout, ma non annulla le esecuzioni dei dati.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per le esecuzioni dei dati, in secondi. Il valore massimo è 300 secondi.

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