Class DataSourceSpecBuilder

DataSourceSpecBuilder

ה-builder של DataSourceSpec. כדי ליצור מפרט לסוג מסוים, משתמשים בשיטה as...(). כדי ליצור כלי בנייה חדש, משתמשים ב-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בונה מפרט של מקור נתונים מההגדרות בבונה הזה.
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()

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

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

בדוגמת הקוד הבאה נוצרת הגדרת מקור נתונים של 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 – הכלי ליצירת קהלים.

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

פרמטרים

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

חזרה

‫DataSourceSpecBuilder — ה-builder, לשרשור.

setParameterFromCell(parameterName, sourceCell)

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

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

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

פרמטרים

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

חזרה

‫DataSourceSpecBuilder — ה-builder, לשרשור.