.alter function docstring コマンド
既存の関数の DocString 値を変更します。
DocString は、エンティティを説明するテーブル/関数/列にアタッチできるフリー テキストです。 この文字列は、エンティティ名の横にあるさまざまな UX 設定で表示されます。
Note
関数が存在しない場合、エラーが返されます。 新しい関数の作成方法の詳細については、「.create function」を参照してください。
アクセス許可
このコマンドを実行するには、少なくとも Function Admin アクセス許可が必要です。 関数を作成するプリンシパルは、自動的に関数管理者になります。
構文
.alterfunction FunctionName docstring Documentation
構文規則について詳しく知る。
パラメーター
| 件名 | タイプ | Required | 説明 |
|---|---|---|---|
| FunctionName | string |
✔️ | 変更する関数の名前。 |
| ドキュメント | string |
✔️ | 関数の新しい docstring 値。 |
返品
| 出力パラメーター | 型 | 説明 |
|---|---|---|
| Name | string |
関数の名前 |
| パラメーター | string |
関数に必要なパラメーター |
| 本文 | string |
(0 以上の) let ステートメントの後に、関数の呼び出し時に評価される有効な CSL 式が続きます |
| フォルダー | string |
UI 関数の分類に使用されるフォルダー。 このパラメーターは、関数の呼び出し方法を変更しません |
| DocString | string |
UI 用の関数の説明 |
例
次の例では、MyFunction1 関数の説明 (docstring) を更新します。
.alter function MyFunction1 docstring "Updated docstring"
出力
| Name | パラメーター | 本文 | フォルダー | DocString |
|---|---|---|---|---|
| MyFunction2 | (myLimit: long) | {StormEvents | take myLimit} | MyFolder | docstring を更新しました |