Class 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डेटा सोर्स टेबल के लिए, पंक्ति की सीमा दिखाता है.
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()

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

वापसी का टिकट

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