Class BigQueryDataSourceSpecBuilder

Générateur despécificationsde sourcede donnéesBigQuery

Compilateur pour BigQueryDataSourceSpecBuilder.

Méthodes

MéthodeType renvoyéBrève description
build()DataSourceSpecCrée une spécification de source de données à partir des paramètres de ce générateur.
copy()DataSourceSpecBuilderCrée un DataSourceSpecBuilder en fonction des paramètres de cette source de données.
getDatasetId()StringRécupère l'ID de l'ensemble de données BigQuery.
getParameters()DataSourceParameter[]Récupère les paramètres de la source de données.
getProjectId()StringRécupère l'ID du projet de facturation.
getRawQuery()StringRécupère la chaîne de requête brute.
getTableId()StringRécupère l'ID de la table BigQuery.
getTableProjectId()StringRécupère l'ID de projet BigQuery de la table.
getType()DataSourceTypeRécupère le type de la source de données.
removeAllParameters()BigQueryDataSourceSpecBuilderSupprime tous les paramètres.
removeParameter(parameterName)BigQueryDataSourceSpecBuilderSupprime le paramètre spécifié.
setDatasetId(datasetId)BigQueryDataSourceSpecBuilderDéfinit l'ID de l'ensemble de données BigQuery.
setParameterFromCell(parameterName, sourceCell)BigQueryDataSourceSpecBuilderAjoute un paramètre ou, si le paramètre portant ce nom existe, met à jour sa cellule source pour les générateurs de spécifications de source de données de type DataSourceType.BIGQUERY.
setProjectId(projectId)BigQueryDataSourceSpecBuilderDéfinit l'ID du projet BigQuery de facturation.
setRawQuery(rawQuery)BigQueryDataSourceSpecBuilderDéfinit la chaîne de requête brute.
setTableId(tableId)BigQueryDataSourceSpecBuilderDéfinit l'ID de la table BigQuery.
setTableProjectId(projectId)BigQueryDataSourceSpecBuilderDéfinit l'ID du projet BigQuery pour la table.

Documentation détaillée

build()

Crée une spécification de source de données à partir des paramètres de ce générateur. 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 : le compilateur.


getDatasetId()

Récupère l'ID de l'ensemble de données BigQuery.

Renvois

String : ID de l'ensemble de données ou chaîne vide si la spécification de la source de données est définie par une requête brute.


getParameters()

Récupère 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.


getProjectId()

Récupère l'ID du projet de facturation.

Renvois

String : ID du projet.


getRawQuery()

Récupère la chaîne de requête brute.

Renvois

String : chaîne de requête brute.


getTableId()

Récupère l'ID de la table BigQuery.

Renvois

String : ID de la table ou chaîne vide si la spécification de la source de données est définie par une requête brute.


getTableProjectId()

Récupère l'ID de projet BigQuery de la table.

Renvois

String : ID du projet de la table ou chaîne vide si la spécification de la source de données est définie par une requête brute.


getType()

Récupère 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

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.


removeParameter(parameterName)

Supprime le paramètre spécifié.

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

Paramètres

NomTypeDescription
parameterNameStringNom du paramètre à supprimer.

Renvois

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.


setDatasetId(datasetId)

Définit l'ID de l'ensemble de données BigQuery.

Paramètres

NomTypeDescription
datasetIdStringID de l'ensemble de données.

Renvois

BigQueryDataSourceSpecBuilder : ce générateur, pour le chaînage.


setParameterFromCell(parameterName, sourceCell)

Ajoute un paramètre ou, si le paramètre portant ce nom existe, met à jour sa cellule source pour les générateurs de spécifications 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

NomTypeDescription
parameterNameStringNom du paramètre.
sourceCellStringCellule source, comme spécifié dans la notation A1.

Renvois

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.


setProjectId(projectId)

Définit l'ID du projet BigQuery de facturation.

Paramètres

NomTypeDescription
projectIdStringID du projet de facturation.

Renvois

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.


setRawQuery(rawQuery)

Définit la chaîne de requête brute.

Paramètres

NomTypeDescription
rawQueryStringChaîne de requête brute.

Renvois

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.


setTableId(tableId)

Définit l'ID de la table BigQuery.

Paramètres

NomTypeDescription
tableIdStringID de la table.

Renvois

BigQueryDataSourceSpecBuilder : ce générateur, pour le chaînage.


setTableProjectId(projectId)

Définit l'ID de projet BigQuery de la table.

Paramètres

NomTypeDescription
projectIdStringID du projet de la table BigQuery.

Renvois

BigQueryDataSourceSpecBuilder : compilateur, pour le chaînage.