Class DataSource

DataSource

Mengakses dan mengubah sumber data yang ada. Untuk membuat tabel sumber data dengan sumber data baru, lihat DataSourceTable.

Hanya gunakan class ini dengan data yang terhubung ke database.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
cancelAllLinkedDataSourceObjectRefreshes()voidMembatalkan semua pembaruan yang sedang berjalan pada objek sumber data yang ditautkan ke sumber data ini.
createCalculatedColumn(name, formula)DataSourceColumnMembuat kolom kalkulasi.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableMembuat tabel pivot sumber data dari sumber data ini di sel pertama sheet baru.
createDataSourceTableOnNewSheet()DataSourceTableMembuat tabel sumber data dari sumber data ini di sel pertama sheet baru.
getCalculatedColumnByName(columnName)DataSourceColumnMenampilkan kolom kalkulasi di sumber data yang cocok dengan nama kolom.
getCalculatedColumns()DataSourceColumn[]Menampilkan semua kolom yang dihitung di sumber data.
getColumns()DataSourceColumn[]Menampilkan semua kolom di sumber data.
getDataSourceSheets()DataSourceSheet[]Menampilkan sheet sumber data yang terkait dengan sumber data ini.
getSpec()DataSourceSpecMendapatkan spesifikasi sumber data.
refreshAllLinkedDataSourceObjects()voidMemuat ulang semua objek sumber data yang ditautkan ke sumber data.
updateSpec(spec)DataSourceMemperbarui spesifikasi sumber data dan memperbarui objek sumber data yang ditautkan dengan permintaan ini sumber data dengan spesifikasi baru.
updateSpec(spec, refreshAllLinkedObjects)DataSourceMemperbarui spesifikasi sumber data dan memuat ulang data source sheets yang tertaut dengan spesifikasi baru.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidMenunggu hingga semua eksekusi objek sumber data tertaut saat ini selesai, waktu habis setelah jumlah detik yang diberikan.

Dokumentasi mendetail

cancelAllLinkedDataSourceObjectRefreshes()

Membatalkan semua pembaruan yang sedang berjalan pada objek sumber data yang ditautkan ke sumber data ini.

Contoh ini menunjukkan cara membatalkan semua pembaruan sumber data.

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

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk data tertentu jenis sumber.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createCalculatedColumn(name, formula)

Membuat kolom yang dihitung. Metode ini hanya tersedia untuk sumber data BigQuery.

Parameter

NamaJenisDeskripsi
nameStringNama kolom kalkulasi.
formulaStringFormula kolom yang dihitung.

Pulang pergi

DataSourceColumn — Kolom kalkulasi yang baru dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createDataSourcePivotTableOnNewSheet()

Membuat tabel pivot sumber data dari sumber data ini di sel pertama sheet baru. Sebagai seorang efek samping, menjadikan lembar baru sebagai lembar aktif.

Pulang pergi

DataSourcePivotTable — Tabel pivot sumber data yang baru dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createDataSourceTableOnNewSheet()

Membuat tabel sumber data dari sumber data ini di sel pertama sheet baru. Sebagai sisi , menjadikan lembar baru sebagai lembar aktif.

Metode ini hanya tersedia untuk sumber data BigQuery.

Pulang pergi

DataSourceTable — Tabel sumber data yang baru dibuat.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getCalculatedColumnByName(columnName)

Menampilkan kolom kalkulasi di sumber data yang cocok dengan nama kolom.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom kalkulasi yang akan didapatkan.

Pulang pergi

DataSourceColumn — Kolom kalkulasi yang cocok dengan nama kolom, atau null jika tidak ada kolom kalkulasi.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getCalculatedColumns()

Menampilkan semua kolom yang dihitung di sumber data.

Spesifikasi sumber data jenis DataSourceType.LOOKER menampilkan array kosong.

Pulang pergi

DataSourceColumn[] — Array semua kolom kalkulasi di sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getColumns()

Menampilkan semua kolom di sumber data.

Pulang pergi

DataSourceColumn[] — Array semua DataSourceColumn dalam sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getDataSourceSheets()

Menampilkan sheet sumber data yang terkait dengan sumber data ini.

Pulang pergi

DataSourceSheet[] — Array sheet sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSpec()

Mendapatkan spesifikasi sumber data.

Pulang pergi

DataSourceSpec — Spesifikasi sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

refreshAllLinkedDataSourceObjects()

Memuat ulang semua objek sumber data yang ditautkan ke sumber data.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data untuk data tertentu jenis sumber.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

updateSpec(spec)

Memperbarui spesifikasi sumber data dan memperbarui objek sumber data yang ditautkan dengan permintaan ini sumber data dengan spesifikasi baru.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data bagi jenis sumber data tertentu.

Menampilkan pengecualian jika jenis spesifikasi sumber data adalah jenis yang berbeda dengan jenis sumber data saat ini.

Parameter

NamaJenisDeskripsi
specDataSourceSpecSpesifikasi sumber data yang akan diperbarui.

Pulang pergi

DataSource — Sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

updateSpec(spec, refreshAllLinkedObjects)

Memperbarui spesifikasi sumber data dan memuat ulang data source sheets tertaut dengan spesifikasi baru.

Menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode SpreadsheetApp#enable...Execution() untuk mengaktifkan eksekusi data bagi jenis sumber data tertentu.

Menampilkan pengecualian jika jenis spesifikasi sumber data adalah jenis yang berbeda dengan jenis sumber data saat ini.

Parameter

NamaJenisDeskripsi
specDataSourceSpecSpesifikasi sumber data yang akan diperbarui.
refreshAllLinkedObjectsBooleanJika true, memuat ulang juga semua objek sumber data yang ditautkan dengan sumber data ini.

Pulang pergi

DataSource — Sumber data.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Menunggu hingga semua eksekusi objek sumber data tertaut saat ini selesai, waktu habis setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai ketika waktu habis, namun tidak membatalkan eksekusi data.

Parameter

NamaJenisDeskripsi
timeoutInSecondsIntegerWaktu tunggu untuk eksekusi data, dalam detik. Maksimumnya adalah 300 detik.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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