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تضيف مواصفات للترتيب في عمود في جدول مصدر البيانات.
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

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".

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا مع واحد أو أكثر من النطاقات التالية:

  • 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".

المَعلمات

الاسمالنوعالوصف
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