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

التفويض

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

  • 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