Class DataSourceSpecBuilder

DataSourceSpecBuilder

ה-builder של DataSourceSpec. כדי ליצור מפרט לסוג מסוים, משתמשים בשיטה as...(). כדי ליצור build חדש, משתמשים ב-SpreadsheetApp.newDataSourceSpec(). למידע נוסף על השימוש במפרט, אפשר לעיין במאמר DataSourceTable.

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

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

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

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
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.

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

חזרה

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

---

build()

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

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

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

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

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const 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',
);
const spec = ss.getDataSources()[0].getSpec();

const 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',
);
const spec = ss.getDataSources()[0].getSpec();
const 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',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

חזרה

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

---

removeAllParameters()

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

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

חזרה

DataSourceSpecBuilder – ה-builder, לצורך קישור.

---

removeParameter(parameterName)

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

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

פרמטרים

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

חזרה

DataSourceSpecBuilder – ה-builder, לצורך קישור.

---

setParameterFromCell(parameterName, sourceCell)

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

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

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

פרמטרים

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

חזרה

DataSourceSpecBuilder – ה-builder, לצורך קישור.