Class DataSourceSpecBuilder

DataSourceSpecBuilder

Compilateur pour DataSourceSpec. Pour créer une spécification pour un certain type, utilisez la méthode as...(). Pour créer un compilateur, utilisez SpreadsheetApp.newDataSourceSpec(). Pour utiliser la spécification, consultez DataSourceTable.

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

Cet exemple montre comment créer une spécification de source de données BigQuery.

var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();

Méthodes

MéthodeType renvoyéBrève description
asBigQuery()BigQueryDataSourceSpecBuilderRécupère le compilateur pour la source de données BigQuery.
build()DataSourceSpecCrée une spécification de source de données à partir des paramètres de ce compilateur.
copy()DataSourceSpecBuilderCrée un DataSourceSpecBuilder en fonction des paramètres de cette source de données.
getParameters()DataSourceParameter[]Récupère les paramètres de la source de données.
getType()DataSourceTypeRécupère le type de la source de données.
removeAllParameters()DataSourceSpecBuilderSupprime tous les paramètres.
removeParameter(parameterName)DataSourceSpecBuilderSupprime le paramètre spécifié.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderAjoute un paramètre ou, si le paramètre portant le nom existe, met à jour sa cellule source.

Documentation détaillée

asBigQuery()

Récupère le compilateur pour la source de données BigQuery.

Renvois

BigQueryDataSourceSpecBuilder : compilateur de spécifications de sources de données BigQuery.


build()

Crée une spécification de source de données à partir des paramètres de ce compilateur. Vous devez utiliser as...() pour spécifier un type de source de données avant la compilation.

Renvois

DataSourceSpec : spécification de la source de données.


copy()

Crée un DataSourceSpecBuilder en fonction des paramètres de cette source de données.

Renvois

DataSourceSpecBuilder : compilateur.


getParameters()

Récupère les paramètres de la source de données.

Renvois

DataSourceParameter[] : liste des paramètres


getType()

Récupère le type de la source de données.

Renvois

DataSourceType : type de source de données.


removeAllParameters()

Supprime tous les paramètres.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.


removeParameter(parameterName)

Supprime le paramètre spécifié.

Paramètres

NomTypeDescription
parameterNameStringNom du paramètre à supprimer.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.


setParameterFromCell(parameterName, sourceCell)

Ajoute un paramètre ou, si le paramètre portant le nom existe, met à jour sa cellule source.

Paramètres

NomTypeDescription
parameterNameStringNom du paramètre.
sourceCellStringCellule source, telle que spécifiée en notation A1.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.