Class DataSourceSpecBuilder

DataSourceSpecBuilder

Compilateur pour DataSourceSpec. Pour créer une spécification pour un type donné, 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 des données connectées à une base de données.

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

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

Cet exemple montre comment créer une spécification de source de données Looker. Il renvoie un objet LookerDataSourceSpec après avoir utilisé build().

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

Méthodes

Méthode	Type renvoyé	Brève description
asBigQuery()	BigQueryDataSourceSpecBuilder	Obtient le compilateur pour la source de données BigQuery.
asLooker()	LookerDataSourceSpecBuilder	Obtient le compilateur pour la source de données Looker.
build()	DataSourceSpec	Crée une spécification de source de données à partir des paramètres de ce compilateur.
copy()	DataSourceSpecBuilder	Crée un DataSourceSpecBuilder en fonction des paramètres de cette source de données.
getParameters()	DataSourceParameter[]	Obtient les paramètres de la source de données.
getType()	DataSourceType	Obtient le type de la source de données.
removeAllParameters()	DataSourceSpecBuilder	Supprime tous les paramètres.
removeParameter(parameterName)	DataSourceSpecBuilder	Supprime le paramètre spécifié.
setParameterFromCell(parameterName, sourceCell)	DataSourceSpecBuilder	Ajoute un paramètre ou, si le paramètre portant ce nom existe déjà, met à jour sa cellule source pour les compilateurs de spécification de source de données de type DataSourceType.BIGQUERY.

Documentation détaillée

asBigQuery()

Obtient le compilateur pour la source de données BigQuery.

Renvois

BigQueryDataSourceSpecBuilder : compilateur de spécification de source de données BigQuery.

---

asLooker()

Obtient le compilateur pour la source de données Looker.

const spec = SpreadsheetApp.newDataSourceSpec()
                 .asLooker()
                 .setInstanceUrl('https://looker_instance_url.com')
                 .setModelName('model_name')
                 .setExploreName('explore_name')
                 .build();

Renvois

LookerDataSourceSpecBuilder : compilateur de spécification de source de données Looker.

---

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 de créer.

L'exemple de code suivant crée une spécification de source de données BigQuery.

const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');

bigQueryDataSourceSpec.build();

L'exemple de code suivant crée une spécification de source de données Looker.

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

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.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();

const newSpec = spec.copy();

Renvois

DataSourceSpecBuilder : compilateur.

---

getParameters()

Obtient les paramètres de la source de données.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

Cette méthode n'est disponible que pour les sources de données BigQuery.

Renvois

DataSourceParameter[] : liste des paramètres.

---

getType()

Obtient le type de la source de données.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

Renvois

DataSourceType : type de source de données.

---

removeAllParameters()

Supprime tous les paramètres.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.

---

removeParameter(parameterName)

Supprime le paramètre spécifié.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Paramètres

Nom	Type	Description
parameterName	String	Nom du paramètre à supprimer.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.

---

setParameterFromCell(parameterName, sourceCell)

Ajoute un paramètre ou, si le paramètre portant ce nom existe déjà, met à jour sa cellule source pour les compilateurs de spécification de source de données de type DataSourceType.BIGQUERY.

Cette méthode n'est disponible que pour les sources de données BigQuery.

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

Paramètres

Nom	Type	Description
parameterName	String	Nom du paramètre.
sourceCell	String	Cellule source, comme spécifié dans la notation A1.

Renvois

DataSourceSpecBuilder : compilateur, pour le chaînage.