Class DataSourceTable

DataSourceTable

به جدول منبع داده موجود دسترسی داشته باشید و آن را اصلاح کنید. برای ایجاد یک جدول منبع داده جدید در یک صفحه جدید، از Spreadsheet.insertSheetWithDataSourceTable(spec) استفاده کنید.

از این کلاس فقط با منابع داده BigQuery استفاده کنید.

این مثال نحوه ایجاد جدول منبع داده جدید را نشان می دهد.

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)

ستون هایی را به جدول منبع داده اضافه می کند.

پارامترها

نام تایپ کنید توضیحات
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

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 - محدودیت ردیف برای جدول منبع داده، یا اگر محدودیتی تنظیم نشده باشد و جدول از حداکثر حد پیش‌فرض مانند رابط کاربر کاربرگ‌نگار Google استفاده کند، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 استفاده کند.

پارامترها

نام تایپ کنید توضیحات
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