Class DataSourceTable

DataSourceTable

मौजूदा डेटा सोर्स टेबल को ऐक्सेस करना और उसमें बदलाव करना. नई शीट पर नई डेटा सोर्स टेबल बनाने के लिए, Spreadsheet.insertSheetWithDataSourceTable(spec) का इस्तेमाल करें.

इस क्लास का इस्तेमाल सिर्फ़ BigQuery डेटा सोर्स के साथ करें.

इस उदाहरण में, नई डेटा सोर्स टेबल बनाने का तरीका दिखाया गया है. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActive();
const 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.
const dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
const 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();
const dataSheet = SpreadsheetApp.getActive().getSheetByName('Data Sheet 1');
const dataSourceTable = dataSheet.getDataSourceTables()[0];
const dataSource = dataSourceTable.getDataSource();
const 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|nullयह फ़ंक्शन, डेटा सोर्स टेबल के लिए पंक्तियों की सीमा दिखाता है.
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 — डेटा सोर्स टेबल के लिए लाइन की सीमा या 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() से बेहतर माना जाता है.

अगर डेटा सोर्स टाइप चालू नहीं है, तो यह फ़ंक्शन एक अपवाद दिखाता है. किसी खास तरह के डेटा सोर्स का डेटा प्रोसेस करने के लिए, 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