Perintah .alter function docstring

Mengubah nilai DocString fungsi yang ada.

DocString adalah teks bebas yang dapat Anda lampirkan ke tabel/fungsi/kolom yang menjelaskan entitas. String ini ditampilkan dalam berbagai pengaturan UX di samping nama entitas.

Catatan

Jika fungsi tidak ada, kesalahan akan ditampilkan. Untuk informasi selengkapnya tentang cara membuat fungsi baru, lihat .create function.

Izin

Anda harus memiliki setidaknya izin Admin Fungsi untuk menjalankan perintah ini. Prinsipal yang membuat fungsi secara otomatis dibuat Admin Fungsi.

Sintaks

.alterfunctionFunctionNamedocstringDocumentation

Pelajari selengkapnya tentang konvensi sintaksis.

Parameter

Nama Jenis Diperlukan Deskripsi
FunctionName string ✔️ Nama fungsi yang akan diubah.
Dokumentasi string ✔️ Nilai docstring baru untuk fungsi.

Mengembalikan

Parameter output Jenis Deskripsi
Nama string Nama fungsi
Parameter string Parameter yang diperlukan oleh fungsi
Isi string Pernyataan let (nol atau lebih) diikuti oleh ekspresi CSL valid yang dievaluasi saat fungsi dipanggil
Folder string Folder yang digunakan untuk kategorisasi fungsi UI. Parameter ini tidak mengubah cara fungsi dipanggil
DocString string Deskripsi fungsi untuk tujuan UI

Contoh

.alter function MyFunction1 docstring "Updated docstring"

Output

Nama Parameter Isi Folder DocString
MyFunction2 (myLimit: long) {StormEvents | take myLimit} MyFolder Docstring yang diperbarui