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 objek sumber data yang sedang berjalan yang ditautkan ke sumber data ini.
createCalculatedColumn(name, formula)DataSourceColumnMembuat kolom yang dihitung.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableMembuat tabel pivot sumber data dari sumber data ini di sel pertama pada lembar baru.
createDataSourceTableOnNewSheet()DataSourceTableMembuat tabel sumber data dari sumber data ini di sel pertama pada sheet baru.
getCalculatedColumnByName(columnName)DataSourceColumnMenampilkan kolom yang dihitung di sumber data yang cocok dengan nama kolom tersebut.
getCalculatedColumns()DataSourceColumn[]Menampilkan semua kolom yang dihitung di sumber data.
getColumns()DataSourceColumn[]Menampilkan semua kolom dalam 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 memuat ulang objek sumber data yang ditautkan dengan sumber data ini 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 saat ini untuk objek sumber data yang ditautkan selesai, dengan waktu habis setelah jumlah detik yang diberikan.

Dokumentasi mendetail

cancelAllLinkedDataSourceObjectRefreshes()

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

Contoh ini menunjukkan cara membatalkan semua pemuatan ulang 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 jenis sumber data tertentu.

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.

Parameter

NamaJenisDeskripsi
nameStringNama kolom yang dihitung.
formulaStringFormula kolom yang dihitung.

Return

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 pada lembar baru. Sebagai efek samping, buat sheet baru menjadi sheet aktif.

Return

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 pada sheet baru. Sebagai efek samping, jadikan sheet baru sebagai sheet aktif.

Return

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 yang dihitung di sumber data yang cocok dengan nama kolom tersebut.

Parameter

NamaJenisDeskripsi
columnNameStringNama kolom kalkulasi yang akan didapatkan.

Return

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

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.

Return

DataSourceColumn[] — Array dari semua kolom yang dihitung 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

getColumns()

Menampilkan semua kolom dalam sumber data.

Return

DataSourceColumn[] — Array dari 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.

Return

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.

Return

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 jenis sumber data tertentu.

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 memuat ulang objek sumber data yang ditautkan dengan sumber data ini dengan spesifikasi baru.

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

Parameter

NamaJenisDeskripsi
specDataSourceSpecSpesifikasi sumber data yang akan diperbarui.

Return

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 yang tertaut dengan spesifikasi baru.

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

Parameter

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

Return

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 saat ini untuk objek sumber data yang ditautkan selesai, dengan waktu habis setelah jumlah detik yang diberikan. Menampilkan pengecualian jika eksekusi tidak selesai saat waktu habis, tetapi tidak membatalkan eksekusi data.

Parameter

NamaJenisDeskripsi
timeoutInSecondsIntegerWaktu tunggu eksekusi data, dalam detik. Durasi 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