Class DataSourceTable

DataSourceTable

גישה לטבלה של מקור נתונים ושינוי שלהם. כדי ליצור טבלה חדשה של מקור נתונים בגיליון חדש, משתמשים ב-Spreadsheet.insertSheetWithDataSourceTable(spec).

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

בדוגמה הזו מוסבר איך ליצור טבלה חדשה של מקור נתונים. 

SpreadsheetApp.enableBigQueryExecution();
var spreadsheet = SpreadsheetApp.getActive();
var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();
// Starts data execution asynchronously.
var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
var dataSourceTable = dataSheet.getDataSourceTables()[0];
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

בדוגמה הזו מוסבר איך לערוך מקור נתונים. 

SpreadsheetApp.enableBigQueryExecution();
var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1");
var dataSourceTable = dataSheet.getDataSourceTables()[0];
var dataSource = dataSourceTable.getDataSource();
var newSpec = dataSource.getSpec()
              .copy()
              .asBigQuery()
              .setRawQuery('select name from table limit 2')
              .removeAllParameters()
              .build();
// Updates data source specification and starts data execution asynchronously.
dataSource.updateSpec(newSpec);
// Check status during execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
addColumns(columnNames)DataSourceTableהוספת עמודות לטבלה של מקור הנתונים.
addFilter(columnName, filterCriteria)DataSourceTableהוספת מסנן שהוחל על הטבלה של מקור הנתונים.
addSortSpec(columnName, ascending)DataSourceTableהוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.
addSortSpec(columnName, sortOrder)DataSourceTableהוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.
cancelDataRefresh()DataSourceTableמבטל את רענון הנתונים המשויך לאובייקט הזה אם הוא פועל עכשיו.
forceRefreshData()DataSourceTableרענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי.
getColumns()DataSourceTableColumn[]הפונקציה גורמת להוספת כל העמודות של מקור הנתונים לטבלה של מקור הנתונים.
getDataSource()DataSourceמקבלת את מקור הנתונים שאליו האובייקט מקושר.
getFilters()DataSourceTableFilter[]מחזירה את כל המסננים שהוחלו על טבלת מקור הנתונים.
getRange()Rangeהפונקציה מקבלת את Range שכוללת את הטבלה של מקור הנתונים הזה.
getRowLimit()Integerמחזירה את מגבלת השורות בטבלה של מקור הנתונים.
getSortSpecs()SortSpec[]מקבלת את כל מפרטי המיון בטבלה של מקור הנתונים.
getStatus()DataExecutionStatusמקבל את סטטוס ביצוע הנתונים של האובייקט.
isSyncingAllColumns()Booleanמחזירה אם הטבלה של מקור הנתונים מסנכרנת את כל העמודות במקור הנתונים המשויך.
refreshData()DataSourceTableרענון של נתוני האובייקט.
removeAllColumns()DataSourceTableמסירה את כל העמודות בטבלה של מקור הנתונים.
removeAllSortSpecs()DataSourceTableהסרת כל מפרטי המיון מטבלת מקור הנתונים.
setRowLimit(rowLimit)DataSourceTableעדכון מגבלת השורות בטבלה של מקור הנתונים.
syncAllColumns()DataSourceTableסנכרון כל העמודות, הנוכחיות והעתידיות במקור הנתונים המשויך, לטבלה של מקור הנתונים.
waitForCompletion(timeoutInSeconds)DataExecutionStatusבהמתנה עד שההפעלה הנוכחית תסתיים, והתזמון יסתיים אחרי מספר השניות שצוין.

תיעוד מפורט

addColumns(columnNames)

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

פרמטרים

שםסוגתיאור
columnNamesString[]רשימת השמות של העמודות שצריך להוסיף.

החזרות

DataSourceTable – הטבלה של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addFilter(columnName, filterCriteria)

הוספת מסנן שהוחל על הטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה שעליה יש להחיל את המסנן הזה.
filterCriteriaFilterCriteriaהקריטריונים לסינון.

החזרות

DataSourceTable – הטבלה של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, ascending)

הוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה שצריך למיין.
ascendingBooleanאם העמודה true, למיין את העמודה בסדר עולה, ואם הערך הוא false, היא צריכה למיין בסדר יורד.

החזרות

DataSourceTable – הגיליון של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, sortOrder)

הוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה שצריך למיין.
sortOrderSortOrderסדר המיון.

החזרות

DataSourceTable – הגיליון של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

מבטל את רענון הנתונים המשויך לאובייקט הזה אם הוא פועל עכשיו.

בדוגמה הזו מוסבר איך לבטל רענון של נוסחאות. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

מחריג את הקוד אם הסוג של מקור הנתונים לא מופעל. משתמשים בשיטות SpreadsheetApp#enable...Execution() כדי לאפשר ביצוע נתונים לסוג ספציפי של מקור נתונים.

החזרות

DataSourceTable – אובייקט הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

רענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי. פרטים נוספים מופיעים בכתובת refreshData(). אם ברצונך לבטל רענון שרץ כרגע של האובייקט הזה, יש לעיין ב-cancelDataRefresh().

מחריג את הקוד אם הסוג של מקור הנתונים לא מופעל. משתמשים בשיטות SpreadsheetApp#enable...Execution() כדי לאפשר ביצוע נתונים לסוג ספציפי של מקור נתונים.

החזרות

DataSourceTable – אובייקט הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

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

החזרות

DataSourceTableColumn[] - רשימת עמודות בטבלה של מקור נתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

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

החזרות

DataSource – מקור הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

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

החזרות

DataSourceTableFilter[] – מערך של כל המסננים שהוחלו על הטבלה של מקור הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

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

החזרות

Range - הטווח.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRowLimit()

מחזירה את מגבלת השורות בטבלה של מקור הנתונים.

החזרות

Integer — מגבלת השורות בטבלה של מקור הנתונים, או null אם לא הוגדרה מגבלה ובטבלה ייעשה שימוש במגבלה המקסימלית שמוגדרת כברירת מחדל, כמו בממשק המשתמש של Google Sheets.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

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

החזרות

SortSpec[] – רשימה של מפרטי מיון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

מקבל את סטטוס ביצוע הנתונים של האובייקט.

החזרות

DataExecutionStatus – סטטוס ביצוע הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isSyncingAllColumns()

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

החזרות

Boolean - True אם מתבצע סנכרון של כל העמודות במקור הנתונים המשויך בטבלת מקור הנתונים, או false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

רענון של נתוני האובייקט.

הוספת החרגה אם היא נמצאת כרגע במצב error. שימוש ב-DataSource#updateSpec() לעדכון המפרט. השיטה הזו מועדפת על פני forceRefreshData() כדי למנוע עריכות לא צפויות במקור הנתונים.

מחריג את הקוד אם הסוג של מקור הנתונים לא מופעל. משתמשים בשיטות SpreadsheetApp#enable...Execution() כדי לאפשר ביצוע נתונים לסוג ספציפי של מקור נתונים.

החזרות

DataSourceTable – אובייקט הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllColumns()

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

החזרות

DataSourceTable – הטבלה של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllSortSpecs()

הסרת כל מפרטי המיון מטבלת מקור הנתונים.

החזרות

DataSourceTable – הגיליון של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRowLimit(rowLimit)

עדכון מגבלת השורות בטבלה של מקור הנתונים. אם מגבלת השורות שצוינה היא null, הטבלה של מקור הנתונים תתעדכן כך שתוגדר כברירת מחדל מגבלת השורות המקסימלית כמו בממשק המשתמש של Google Sheets.

פרמטרים

שםסוגתיאור
rowLimitIntegerמגבלת השורות החדשה בטבלת הנתונים. אם מזינים null, מעדכנים את הטבלה כך שייעשה שימוש במגבלת השורות שמוגדרת כברירת מחדל.

החזרות

DataSourceTable – הטבלה של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

syncAllColumns()

סנכרון כל העמודות, הנוכחיות והעתידיות במקור הנתונים המשויך, לטבלה של מקור הנתונים.

החזרות

DataSourceTable – הטבלה של מקור הנתונים לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

בהמתנה עד שההפעלה הנוכחית תסתיים, והתזמון יסתיים אחרי מספר השניות שצוין. חריגה: אם הביצוע לא הושלם כשהתזמון יסתיים, אבל הוא לא מבטל את הפעלת הנתונים.

פרמטרים

שםסוגתיאור
timeoutInSecondsIntegerזמן ההמתנה לביצוע נתונים, בשניות. הערך המקסימלי הוא 300 שניות.

החזרות

DataExecutionStatus – סטטוס ביצוע הנתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets