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()

यह दिखाता है कि डेटा सोर्स की टेबल, संबंधित डेटा सोर्स के सभी कॉलम को सिंक कर रही है या नहीं.

रिटर्न

BooleanTrue, अगर डेटा सोर्स टेबल, जुड़े हुए डेटा सोर्स के सभी कॉलम को सिंक कर रही है, तो 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