Class DataSourceSpecBuilder

DataSourceSpecBuilder

ה-builder של DataSourceSpec. כדי ליצור מפרט לסוג מסוים, צריך להשתמש ב-method as...(). כדי ליצור builder חדש, צריך להשתמש ב-SpreadsheetApp.newDataSourceSpec(). כדי להשתמש במפרט: DataSourceTable.

יש להשתמש בכיתה הזו רק עם נתונים שמקושרים למסד נתונים.

בדוגמה הזו תוכלו לראות איך לפתח מפרט של מקורות נתונים ל-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();

בדוגמה הזו תוכלו לראות איך לפתח מפרט של מקורות נתונים של Looker. היא מחזירה אובייקט LookerDataSourceSpec אחרי השימוש ב-build().

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

שיטות

שיטהסוג הערך המוחזרתיאור קצר
asBigQuery()BigQueryDataSourceSpecBuilderקבלת ה-builder של מקור הנתונים של BigQuery.
asLooker()LookerDataSourceSpecBuilderקבלת ה-builder של מקור הנתונים של Looker.
build()DataSourceSpecיצירת מפרט של מקור נתונים מההגדרות של ה-builder הזה.
copy()DataSourceSpecBuilderייווצר DataSourceSpecBuilder על סמך ההגדרות של מקור הנתונים.
getParameters()DataSourceParameter[]הפונקציה מקבלת את הפרמטרים של מקור הנתונים.
getType()DataSourceTypeהפונקציה מקבלת את הסוג של מקור הנתונים.
removeAllParameters()DataSourceSpecBuilderמסירה את כל הפרמטרים.
removeParameter(parameterName)DataSourceSpecBuilderהסרת הפרמטר שצוין.
setParameterFromCell(parameterName, sourceCell)DataSourceSpecBuilderהוספת פרמטר. אם הפרמטר עם השם קיים, המערכת תעדכן את תא המקור שלו לנתונים כלים לבנייה של מפרטי מקור מסוג DataSourceType.BIGQUERY.

מסמכי תיעוד מפורטים

asBigQuery()

הפונקציה מקבלת את ה-builder של מקור הנתונים ב-BigQuery.

חזרה

BigQueryDataSourceSpecBuilder – בונה מפרטי מקורות הנתונים של BigQuery.


asLooker()

קבלת ה-builder של מקור הנתונים של Looker.

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

חזרה

LookerDataSourceSpecBuilder – בונה המפרטים של מקורות הנתונים ב-Looker.


build()

יצירת מפרט של מקור נתונים מההגדרות שב-builder הזה. חובה להשתמש ב-as...() כדי לציין את סוג מקור הנתונים לפני הבנייה.

דוגמת הקוד הבאה יוצרת מפרט של BigQuery DataSource.

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

דוגמת הקוד הבאה יוצרת מפרט של Looker DataSource.

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

חזרה

DataSourceSpec – מפרט מקור הנתונים.


copy()

ייווצר DataSourceSpecBuilder על סמך ההגדרות של מקור הנתונים.

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

var newSpec = spec.copy();

חזרה

DataSourceSpecBuilder – ה-builder.


getParameters()

הפונקציה מקבלת את הפרמטרים של מקור הנתונים.

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

השיטה הזו זמינה רק למקורות נתונים של BigQuery.

חזרה

DataSourceParameter[] – רשימת הפרמטרים.


getType()

הפונקציה מקבלת את הסוג של מקור הנתונים.

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

חזרה

DataSourceType – הסוג של מקור הנתונים.


removeAllParameters()

מסירה את כל הפרמטרים.

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

חזרה

DataSourceSpecBuilder – ה-builder, לשרשורים.


removeParameter(parameterName)

מסירה את הפרמטר שצוין.

var specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter("x");

פרמטרים

שםסוגתיאור
parameterNameStringשם הפרמטר שרוצים להסיר.

חזרה

DataSourceSpecBuilder – ה-builder, לשרשורים.


setParameterFromCell(parameterName, sourceCell)

הוספת פרמטר. אם הפרמטר עם השם קיים, המערכת תעדכן את תא המקור שלו לנתונים כלים לבנייה של מפרטי מקור מסוג DataSourceType.BIGQUERY.

השיטה הזו זמינה רק למקורות נתונים של BigQuery.

var specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell("x", "A1");
var bigQuerySpec = specBuilder.build();

פרמטרים

שםסוגתיאור
parameterNameStringשם הפרמטר.
sourceCellStringתא המקור, כפי שצוין בסימון A1.

חזרה

DataSourceSpecBuilder – ה-builder, לשרשורים.