דף זה תורגם על ידי Cloud Translation API.

Class 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`	הוספה של מפרט מיון לעמודה בטבלה של מקור הנתונים.
`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)`

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

פרמטרים

שם	תיאור	התיאור
`columnNames`	`String[]`	רשימת השמות של העמודות שיש להוסיף.

החזרות

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

הרשאות

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

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

`addFilter(columnName, filterCriteria)`

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

פרמטרים

שם	תיאור	התיאור
`columnName`	`String`	שם העמודה שעליה יש להחיל את המסנן הזה.
`filterCriteria`	`FilterCriteria`	הקריטריונים של הסינון שרוצים להחיל.

החזרות

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

הרשאות

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

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

`addSortSpec(columnName, ascending)`

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

פרמטרים

שם	תיאור	התיאור
`columnName`	`String`	שם העמודה למיון.
`ascending`	`Boolean`	אם הערך הוא `true`, צריך למיין את העמודה בסדר עולה. אם הערך הוא `false`, צריך למיין את העמודה בסדר יורד.

החזרות

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

הרשאות

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

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

`addSortSpec(columnName, sortOrder)`

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

פרמטרים

שם	תיאור	התיאור
`columnName`	`String`	שם העמודה למיון.
`sortOrder`	`SortOrder`	סדר המיון.

החזרות

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

הרשאות

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

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

`forceRefreshData()`

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

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

החזרות

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.

פרמטרים

שם	תיאור	התיאור
`rowLimit`	`Integer`	מגבלת השורות החדשה בטבלת הנתונים. אם מזינים `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)`

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

פרמטרים

שם	תיאור	התיאור
`timeoutInSeconds`	`Integer`	זמן ההמתנה לביצוע נתונים, בשניות. המקסימום הוא 300 שניות.

החזרות

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

הרשאות

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

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