Class DataSource

डेटासोर्स

मौजूदा डेटा सोर्स को ऐक्सेस करना और उसमें बदलाव करना. नए डेटा सोर्स की मदद से डेटा सोर्स टेबल बनाने के लिए, DataSourceTable देखें.

इस क्लास का इस्तेमाल सिर्फ़ उस डेटा के साथ करें जो किसी डेटाबेस से कनेक्ट हो.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
cancelAllLinkedDataSourceObjectRefreshes()voidयह फ़ंक्शन, इस डेटा सोर्स से लिंक किए गए डेटा सोर्स ऑब्जेक्ट के लिए, फ़िलहाल चल रहे सभी रीफ़्रेश को रद्द कर देता है.
createCalculatedColumn(name, formula)DataSourceColumnकैलकुलेट किया गया कॉलम बनाता है.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableयह फ़ंक्शन, इस डेटा सोर्स से नई शीट की पहली सेल में डेटा सोर्स पिवट टेबल बनाता है.
createDataSourceTableOnNewSheet()DataSourceTableयह फ़ंक्शन, इस डेटा सोर्स से एक डेटा सोर्स टेबल बनाता है. यह टेबल, नई शीट की पहली सेल में मौजूद होती है.
getCalculatedColumnByName(columnName)DataSourceColumn|nullयह फ़ंक्शन, डेटा सोर्स में मौजूद उस कैलकुलेटेड कॉलम को दिखाता है जिसका नाम, कॉलम के नाम से मेल खाता है.
getCalculatedColumns()DataSourceColumn[]यह फ़ंक्शन, डेटा सोर्स में मौजूद सभी कैलकुलेटेड कॉलम दिखाता है.
getColumns()DataSourceColumn[]यह फ़ंक्शन, डेटा सोर्स में मौजूद सभी कॉलम दिखाता है.
getDataSourceSheets()DataSourceSheet[]इस डेटा सोर्स से जुड़ी डेटा सोर्स शीट दिखाता है.
getSpec()DataSourceSpecइस तरीके से, डेटा सोर्स स्पेसिफ़िकेशन मिलता है.
refreshAllLinkedDataSourceObjects()voidइससे डेटा सोर्स से लिंक किए गए सभी डेटा सोर्स ऑब्जेक्ट रीफ़्रेश हो जाते हैं.
updateSpec(spec)DataSourceयह फ़ंक्शन, डेटा सोर्स स्पेसिफ़िकेशन को अपडेट करता है. साथ ही, इस डेटा सोर्स से लिंक किए गए डेटा सोर्स ऑब्जेक्ट को नए स्पेसिफ़िकेशन के साथ रीफ़्रेश करता है.
updateSpec(spec, refreshAllLinkedObjects)DataSourceयह कुकी, डेटा सोर्स के स्पेसिफ़िकेशन को अपडेट करती है. साथ ही, लिंक किए गए data source sheets को नए स्पेसिफ़िकेशन के साथ रीफ़्रेश करती है.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidयह फ़ंक्शन, लिंक किए गए डेटा सोर्स ऑब्जेक्ट के सभी मौजूदा एक्ज़ीक्यूशन के पूरा होने का इंतज़ार करता है. साथ ही, तय किए गए सेकंड के बाद टाइम आउट हो जाता है.

ज़्यादा जानकारी वाला दस्तावेज़

cancelAllLinkedDataSourceObjectRefreshes()

यह फ़ंक्शन, इस डेटा सोर्स से लिंक किए गए डेटा सोर्स ऑब्जेक्ट के लिए, फ़िलहाल चल रहे सभी रीफ़्रेश को रद्द कर देता है.

इस उदाहरण में, किसी डेटा सोर्स के सभी रीफ़्रेश रद्द करने का तरीका बताया गया है. 

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

अगर डेटा सोर्स टाइप चालू नहीं है, तो यह फ़ंक्शन एक अपवाद दिखाता है. किसी खास डेटा सोर्स टाइप के लिए डेटा प्रोसेस करने की सुविधा चालू करने के लिए, SpreadsheetApp#enable...Execution() तरीकों का इस्तेमाल करें.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createCalculatedColumn(name, formula)

कैलकुलेट किया गया कॉलम बनाता है. यह तरीका सिर्फ़ BigQuery डेटा सोर्स के लिए उपलब्ध है.

पैरामीटर

नामटाइपब्यौरा
nameStringकैलकुलेट किए गए कॉलम का नाम.
formulaStringकैलकुलेट किए गए कॉलम का फ़ॉर्मूला.

वापसी का टिकट

DataSourceColumn — यह नया कैलकुलेटेड कॉलम है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourcePivotTableOnNewSheet()

यह फ़ंक्शन, इस डेटा सोर्स से नई शीट की पहली सेल में डेटा सोर्स पिवट टेबल बनाता है. इसका एक साइड इफ़ेक्ट यह है कि नई शीट, ऐक्टिव शीट बन जाती है.

वापसी का टिकट

DataSourcePivotTable — यह नया डेटा सोर्स पिवट टेबल है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDataSourceTableOnNewSheet()

यह फ़ंक्शन, इस डेटा सोर्स से एक डेटा सोर्स टेबल बनाता है. यह टेबल, नई शीट की पहली सेल में मौजूद होती है. इसका एक साइड इफ़ेक्ट यह है कि नई शीट, ऐक्टिव शीट बन जाती है.

यह तरीका सिर्फ़ BigQuery डेटा सोर्स के लिए उपलब्ध है.

वापसी का टिकट

DataSourceTable — यह नई बनाई गई डेटा सोर्स टेबल है.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumnByName(columnName)

यह फ़ंक्शन, डेटा सोर्स में मौजूद उस कैलकुलेटेड कॉलम को दिखाता है जिसका नाम, कॉलम के नाम से मेल खाता है.

पैरामीटर

नामटाइपब्यौरा
columnNameStringकैलकुलेट किए गए उस कॉलम का नाम जिसे पाना है.

वापसी का टिकट

DataSourceColumn|null — कॉलम के नाम से मैच करने वाला कैलकुलेट किया गया कॉलम या अगर ऐसा कोई कैलकुलेट किया गया कॉलम नहीं है, तो null.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCalculatedColumns()

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

DataSourceType.LOOKER टाइप के डेटा सोर्स स्पेसिफ़िकेशन, खाली कलेक्शन दिखाते हैं.

वापसी का टिकट

DataSourceColumn[] — डेटा सोर्स में मौजूद सभी कैलकुलेटेड कॉलम की एक ऐरे.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

यह फ़ंक्शन, डेटा सोर्स में मौजूद सभी कॉलम दिखाता है.

वापसी का टिकट

DataSourceColumn[] — डेटा सोर्स में मौजूद सभी DataSourceColumn का कलेक्शन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceSheets()

इस डेटा सोर्स से जुड़ी डेटा सोर्स शीट दिखाता है.

वापसी का टिकट

DataSourceSheet[] — डेटा सोर्स की शीट की एक ऐरे.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSpec()

इस तरीके से, डेटा सोर्स स्पेसिफ़िकेशन मिलता है.

वापसी का टिकट

DataSourceSpec — डेटा सोर्स का स्पेसिफ़िकेशन.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshAllLinkedDataSourceObjects()

इससे डेटा सोर्स से लिंक किए गए सभी डेटा सोर्स ऑब्जेक्ट रीफ़्रेश हो जाते हैं.

अगर डेटा सोर्स टाइप चालू नहीं है, तो यह फ़ंक्शन एक अपवाद दिखाता है. किसी खास डेटा सोर्स टाइप के लिए डेटा प्रोसेस करने की सुविधा चालू करने के लिए, SpreadsheetApp#enable...Execution() तरीकों का इस्तेमाल करें.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec)

यह फ़ंक्शन, डेटा सोर्स स्पेसिफ़िकेशन को अपडेट करता है. साथ ही, इस डेटा सोर्स से लिंक किए गए डेटा सोर्स ऑब्जेक्ट को नए स्पेसिफ़िकेशन के साथ रीफ़्रेश करता है.

अगर डेटा सोर्स टाइप चालू नहीं है, तो यह फ़ंक्शन एक अपवाद दिखाता है. किसी खास डेटा सोर्स टाइप के लिए डेटा प्रोसेस करने की सुविधा चालू करने के लिए, SpreadsheetApp#enable...Execution() तरीकों का इस्तेमाल करें.

अगर डेटा सोर्स स्पेसिफ़िकेशन का टाइप, मौजूदा डेटा सोर्स के टाइप से अलग है, तो यह फ़ंक्शन एक अपवाद दिखाता है.

पैरामीटर

नामटाइपब्यौरा
specDataSourceSpecडेटा सोर्स के स्पेसिफ़िकेशन को अपडेट करना है.

वापसी का टिकट

DataSource — डेटा सोर्स.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateSpec(spec, refreshAllLinkedObjects)

यह कुकी, डेटा सोर्स के स्पेसिफ़िकेशन को अपडेट करती है. साथ ही, लिंक किए गए data source sheets को नए स्पेसिफ़िकेशन के साथ रीफ़्रेश करती है.

अगर डेटा सोर्स टाइप चालू नहीं है, तो यह फ़ंक्शन एक अपवाद दिखाता है. किसी खास डेटा सोर्स टाइप के लिए डेटा प्रोसेस करने की सुविधा चालू करने के लिए, SpreadsheetApp#enable...Execution() तरीकों का इस्तेमाल करें.

अगर डेटा सोर्स स्पेसिफ़िकेशन का टाइप, मौजूदा डेटा सोर्स के टाइप से अलग है, तो यह फ़ंक्शन एक अपवाद दिखाता है.

पैरामीटर

नामटाइपब्यौरा
specDataSourceSpecडेटा सोर्स के स्पेसिफ़िकेशन को अपडेट करना है.
refreshAllLinkedObjectsBooleanअगर true है, तो इस डेटा सोर्स से लिंक किए गए डेटा सोर्स के सभी ऑब्जेक्ट भी रीफ़्रेश हो जाते हैं.

वापसी का टिकट

DataSource — डेटा सोर्स.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForAllDataExecutionsCompletion(timeoutInSeconds)

यह फ़ंक्शन, लिंक किए गए डेटा सोर्स ऑब्जेक्ट के सभी मौजूदा एक्ज़ीक्यूशन के पूरा होने का इंतज़ार करता है. साथ ही, तय किए गए सेकंड के बाद टाइम आउट हो जाता है. अगर तय समय खत्म होने पर भी डेटा प्रोसेस नहीं होता है, तो यह फ़ंक्शन एक अपवाद दिखाता है. हालांकि, यह डेटा प्रोसेस को रद्द नहीं करता है.

पैरामीटर

नामटाइपब्यौरा
timeoutInSecondsIntegerडेटा प्रोसेस होने के लिए तय किया गया समय, सेकंड में. ज़्यादा से ज़्यादा 300 सेकंड.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट के लिए, इनमें से एक या एक से ज़्यादा स्कोप के साथ अनुमति लेना ज़रूरी है:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets