.alter function docstring 명령
적용 대상: ✅Microsoft Fabric✅Azure Data Explorer
기존 함수의 DocString 값을 변경합니다.
DocString 는 엔터티를 설명하는 테이블/함수/열에 연결할 수 있는 무료 텍스트입니다. 이 문자열은 엔터티 이름 옆에 있는 다양한 UX 설정에 표시됩니다.
참고 항목
함수가 없으면 오류가 반환됩니다. 새 함수를 만드는 방법에 대한 자세한 내용은 다음을 참조하세요 .create function.
사용 권한
이 명령을 실행하려면 함수 관리자 권한이 있어야 합니다. 함수를 만드는 보안 주체는 자동으로 함수 관리자로 만들어집니다.
구문
.alterfunction FunctionName docstring 설명서
구문 규칙에 대해 자세히 알아봅니다.
매개 변수
| 이름 | Type | 필수 | 설명 |
|---|---|---|---|
| FunctionName | string |
✔️ | 변경할 함수의 이름입니다. |
| 설명서 | string |
✔️ | 함수의 새 문서 문자열 값입니다. |
반품
| 출력 매개 변수 | Type | Description |
|---|---|---|
| 이름 | 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 | 업데이트된 문서 문자열 |