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डेटा सोर्स टेबल के कॉलम में, क्रम से लगाने का तरीका जोड़ा जाता है.
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)

डेटा सोर्स की टेबल में कॉलम जोड़ता है.

पैरामीटर

नामTypeब्यौरा
columnNamesString[]जोड़े जाने वाले कॉलम के नामों की सूची.

रिटर्न

DataSourceTable — चेन बनाने के लिए, डेटा सोर्स टेबल.

अनुमति देना

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

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

addFilter(columnName, filterCriteria)

डेटा सोर्स की टेबल पर लागू किया गया फ़िल्टर जोड़ता है.

पैरामीटर

नामTypeब्यौरा
columnNameStringउस कॉलम का नाम जिस पर यह फ़िल्टर लागू करना है.
filterCriteriaFilterCriteriaलागू करने के लिए फ़िल्टर की शर्तें.

रिटर्न

DataSourceTable — चेन बनाने के लिए, डेटा सोर्स टेबल.

अनुमति देना

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

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

addSortSpec(columnName, ascending)

डेटा सोर्स टेबल के कॉलम में, क्रम से लगाने का तरीका जोड़ा जाता है.

पैरामीटर

नामTypeब्यौरा
columnNameStringक्रम से लगाए जाने वाले कॉलम का नाम.
ascendingBooleanअगर true है, तो कॉलम को बढ़ते क्रम में लगाएं. अगर false है, तो कॉलम को घटते क्रम में लगाएं.

रिटर्न

DataSourceTable — चेन बनाने के लिए, डेटा सोर्स शीट.

अनुमति देना

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

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

addSortSpec(columnName, sortOrder)

डेटा सोर्स टेबल के कॉलम में, क्रम से लगाने का तरीका जोड़ा जाता है.

पैरामीटर

नामTypeब्यौरा
columnNameStringक्रम से लगाए जाने वाले कॉलम का नाम.
sortOrderSortOrderक्रम से लगाने का क्रम.

रिटर्न

DataSourceTable — चेन बनाने के लिए, डेटा सोर्स शीट.

अनुमति देना

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

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

forceRefreshData()

इस ऑब्जेक्ट के डेटा को रीफ़्रेश करता है, भले ही मौजूदा स्थिति कुछ भी हो. ज़्यादा जानकारी के लिए, refreshData() पर जाएं.

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

पैरामीटर

नामTypeब्यौरा
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)

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

पैरामीटर

नामTypeब्यौरा
timeoutInSecondsIntegerडेटा प्रोसेस होने तक इंतज़ार का समय (सेकंड में). यह ज़्यादा से ज़्यादा 300 सेकंड का हो सकता है.

रिटर्न

DataExecutionStatus — डेटा एक्ज़ीक्यूशन का स्टेटस.

अनुमति देना

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

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