Class DataSourceTable

DataSourceTable

Accédez à la table de source de données existante et modifiez-la. Pour créer une table de source de données dans une nouvelle feuille, utilisez Spreadsheet.insertSheetWithDataSourceTable(spec).

N'utilisez cette classe qu'avec les données connectées à une base de données.

Cet exemple montre comment créer une table de source de données.

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

Cet exemple montre comment modifier une source de données.

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éthodes

MéthodeType renvoyéBrève description
addColumns(columnNames)DataSourceTableAjoute des colonnes à la table de source de données.
addFilter(columnName, filterCriteria)DataSourceTableAjoute un filtre appliqué au tableau de la source de données.
addSortSpec(columnName, ascending)DataSourceTableAjoute une spécification de tri sur une colonne de la table de source de données.
addSortSpec(columnName, sortOrder)DataSourceTableAjoute une spécification de tri sur une colonne de la table de source de données.
forceRefreshData()DataSourceTableActualise les données de cet objet, quel que soit l'état actuel.
getColumns()DataSourceTableColumn[]Récupère toutes les colonnes de source de données ajoutées à la table de source de données.
getDataSource()DataSourceRécupère la source de données à laquelle l'objet est associé.
getFilters()DataSourceTableFilter[]Affiche tous les filtres appliqués à la table de source de données.
getRange()RangeRécupère les Range couverts par cette table de source de données.
getRowLimit()IntegerRenvoie le nombre maximal de lignes de la table de source de données.
getSortSpecs()SortSpec[]Récupère toutes les spécifications de tri de la table de source de données.
getStatus()DataExecutionStatusRécupère l'état d'exécution des données de l'objet.
isSyncingAllColumns()BooleanIndique si la table de la source de données synchronise toutes les colonnes de la source de données associée.
refreshData()DataSourceTableActualise les données de l'objet.
removeAllColumns()DataSourceTableSupprime toutes les colonnes de la table de source de données.
removeAllSortSpecs()DataSourceTableSupprime toutes les spécifications de tri de la table de source de données.
setRowLimit(rowLimit)DataSourceTableMet à jour le nombre maximal de lignes pour la table de source de données.
syncAllColumns()DataSourceTableSynchronisez toutes les colonnes actuelles et futures de la source de données associée avec la table de la source de données.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttend la fin de l'exécution en cours. Elle expire après le nombre de secondes indiqué.

Documentation détaillée

addColumns(columnNames)

Ajoute des colonnes à la table de source de données.

Paramètres

NomTypeDescription
columnNamesString[]Liste des noms des colonnes à ajouter.

Renvois

DataSourceTable : table de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

addFilter(columnName, filterCriteria)

Ajoute un filtre appliqué au tableau de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à laquelle appliquer ce filtre.
filterCriteriaFilterCriteriaCritères de filtre à appliquer.

Renvois

DataSourceTable : table de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

addSortSpec(columnName, ascending)

Ajoute une spécification de tri sur une colonne de la table de source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à trier.
ascendingBooleanSi la valeur est true, triez la colonne par ordre croissant. Si false, triez la colonne par ordre décroissant.

Renvois

DataSourceTable : feuille de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

addSortSpec(columnName, sortOrder)

Ajoute une spécification de tri sur une colonne de la table de source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à trier.
sortOrderSortOrderOrdre de tri.

Renvois

DataSourceTable : feuille de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

forceRefreshData()

Actualise les données de cet objet, quel que soit l'état actuel. Pour en savoir plus, consultez refreshData().

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getColumns()

Récupère toutes les colonnes de source de données ajoutées à la table de source de données.

Renvois

DataSourceTableColumn[] : liste des colonnes de la table de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getDataSource()

Récupère la source de données à laquelle l'objet est associé.

Renvois

DataSource : source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getFilters()

Affiche tous les filtres appliqués à la table de source de données.

Renvois

DataSourceTableFilter[] : tableau de tous les filtres appliqués à la table de la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getRange()

Récupère les Range couverts par cette table de source de données.

Renvois

Range : plage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getRowLimit()

Renvoie le nombre maximal de lignes de la table de source de données.

Renvois

Integer : limite du nombre de lignes de la table de source de données, ou null si aucune limite n'est définie et que la table utilise la limite maximale par défaut, comme dans l'interface utilisateur de Google Sheets.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getSortSpecs()

Récupère toutes les spécifications de tri de la table de source de données.

Renvois

SortSpec[] : liste de spécifications de tri.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getStatus()

Récupère l'état d'exécution des données de l'objet.

Renvois

DataExecutionStatus : état d'exécution des données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isSyncingAllColumns()

Indique si la table de la source de données synchronise toutes les colonnes de la source de données associée.

Renvois

Boolean : True si la table de source de données synchronise toutes les colonnes de la source de données associée, ou false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

refreshData()

Actualise les données de l'objet.

Génère une exception s'il est actuellement à l'état error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. Il est préférable d'utiliser cette méthode plutôt que forceRefreshData() pour éviter toute modification inattendue de la source de données.

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeAllColumns()

Supprime toutes les colonnes de la table de source de données.

Renvois

DataSourceTable : table de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeAllSortSpecs()

Supprime toutes les spécifications de tri de la table de source de données.

Renvois

DataSourceTable : feuille de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setRowLimit(rowLimit)

Met à jour le nombre maximal de lignes pour la table de source de données. Si le nombre maximal de lignes fourni est null, la table de source de données est mise à jour de manière à utiliser la limite maximale par défaut du nombre de lignes, comme dans l'interface utilisateur de Google Sheets.

Paramètres

NomTypeDescription
rowLimitIntegerNouvelle limite de lignes pour le tableau de données. Si la valeur est null, met à jour la table de sorte qu'elle utilise le nombre maximal de lignes par défaut.

Renvois

DataSourceTable : table de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

syncAllColumns()

Synchronisez toutes les colonnes actuelles et futures de la source de données associée avec la table de la source de données.

Renvois

DataSourceTable : table de la source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

waitForCompletion(timeoutInSeconds)

Attend la fin de l'exécution en cours. Elle expire après le nombre de secondes indiqué. Elle génère une exception si l'exécution n'est pas terminée après expiration du délai, mais n'annule pas l'exécution des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerDélai d'attente de l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Renvois

DataExecutionStatus : état d'exécution des données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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