Cette page a été traduite par l'API Cloud Translation.

Class DataSourceTable

Accéder à une table de source de données existante et la modifier Pour créer un tableau de source de données dans une nouvelle feuille, utiliser Spreadsheet.insertSheetWithDataSourceTable(spec).

N'utilisez cette classe qu'avec des 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éthode	Type renvoyé	Brève description
`addColumns(columnNames)`	`DataSourceTable`	Ajoute des colonnes à la table de source de données.
`addFilter(columnName, filterCriteria)`	`DataSourceTable`	Ajoute un filtre appliqué au tableau de la source de données.
`addSortSpec(columnName, ascending)`	`DataSourceTable`	Ajoute une spécification de tri sur une colonne de la table de source de données.
`addSortSpec(columnName, sortOrder)`	`DataSourceTable`	Ajoute une spécification de tri sur une colonne de la table de source de données.
`cancelDataRefresh()`	`DataSourceTable`	Annule l'actualisation des données associée à cet objet s'il est en cours d'exécution.
`forceRefreshData()`	`DataSourceTable`	Actualise 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()`	`DataSource`	Récupère la source de données à laquelle l'objet est associé.
`getFilters()`	`DataSourceTableFilter[]`	Renvoie tous les filtres appliqués à la table de source de données.
`getRange()`	`Range`	Récupère les `Range` de cette table de source de données.
`getRowLimit()`	`Integer`	Renvoie 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()`	`DataExecutionStatus`	Récupère l'état d'exécution des données de l'objet.
`isSyncingAllColumns()`	`Boolean`	Indique si la table de source de données synchronise toutes les colonnes de la source de données associée.
`refreshData()`	`DataSourceTable`	Actualise les données de l'objet.
`removeAllColumns()`	`DataSourceTable`	Supprime toutes les colonnes du tableau de source de données.
`removeAllSortSpecs()`	`DataSourceTable`	Supprime toutes les spécifications de tri de la table de source de données.
`setRowLimit(rowLimit)`	`DataSourceTable`	Met à jour le nombre maximal de lignes de la table de source de données.
`syncAllColumns()`	`DataSourceTable`	Synchronisez toutes les colonnes actuelles et futures de la source de données associée avec la table de source de données.
`waitForCompletion(timeoutInSeconds)`	`DataExecutionStatus`	Attend la fin de l'exécution en cours et 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

Nom	Type	Description
`columnNames`	`String[]`	Liste des noms des colonnes à ajouter.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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

Nom	Type	Description
`columnName`	`String`	Nom de la colonne à laquelle appliquer ce filtre.
`filterCriteria`	`FilterCriteria`	Critères de filtre à appliquer.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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

Nom	Type	Description
`columnName`	`String`	Nom de la colonne à trier.
`ascending`	`Boolean`	Si la valeur est `true`, trie la colonne dans l'ordre croissant. Si `false`, trier la colonne dans l’ordre décroissant.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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

Nom	Type	Description
`columnName`	`String`	Nom de la colonne à trier.
`sortOrder`	`SortOrder`	Ordre de tri.

Renvois

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

Autorisation

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

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

`cancelDataRefresh()`

Annule l'actualisation des données associée à cet objet s'il est en cours d'exécution.

Cet exemple montre comment annuler l'actualisation d'une formule.

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

La fonction renvoie une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourceTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. Consultez les refreshData() pour plus de détails. Si vous souhaitez annuler l'actualisation de cet objet en cours, consultez cancelDataRefresh().

Renvois

DataSourceTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de colonnes de table de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getFilters()`

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

Renvois

DataSourceTableFilter[] : tableau contenant l'ensemble des filtres appliqués à la table de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de cette table de source de données.

Renvois

Range : plage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de lignes de la table de source de données, ou null si aucune limite n'est définie et que la valeur le tableau utilise la limite maximale par défaut telle que dans l'interface utilisateur de Google Sheets.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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 correspondant à 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 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 des données associées source, ou false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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.

La fonction renvoie une exception si l'état actuel est error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. La méthode est préférable à forceRefreshData() pour éviter des modifications inattendues de la source de données.

Renvois

DataSourceTable : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 du tableau de source de données.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de la table de source de données. Si la limite de lignes fournie est null, puis met à jour le tableau de la source de données pour qu'il utilise le nombre maximal de lignes par défaut, comme dans l'interface utilisateur de Google Sheets.

Paramètres

Nom	Type	Description
`rowLimit`	`Integer`	Nouvelle limite de lignes pour la table de données. Si la valeur est `null`, la table est mise à jour pour qu'elle utilise la limite de lignes par défaut.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 et expire après le nombre de secondes indiqué. La fonction renvoie une exception si l'exécution n'est pas terminée à l'expiration du délai, mais n'annule pas la l'exécution des données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Délai d'attente de l'exécution des données, en secondes. Le maximum 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 correspondant à un ou plusieurs des champs d'application suivants:

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