Comando .alter function docstring

Modifica el DocString valor de una función existente.

DocString es texto libre que se puede adjuntar a una tabla, función o columna que describe la entidad. Esta cadena se presenta en varias configuraciones de experiencia de usuario junto a los nombres de entidad.

Nota

Si la función no existe, se devuelve un error. Para obtener más información sobre cómo crear una nueva función, vea .create function.

Permisos

Debe tener al menos permisos de function Administración para ejecutar este comando. La entidad de seguridad que crea la función se convierte automáticamente en una función Administración.

Syntax

.alterfunctionNombrefuncióndocstringDocumentación

Obtenga más información sobre las convenciones de sintaxis.

Parámetros

Nombre	Tipo	Requerido	Descripción
Nombrefunción	string	✔️	Nombre de la función que se va a modificar.
Documentación	string	✔️	Nuevo valor docstring para la función .

Devoluciones

Parámetro de salida	Tipo	Descripción
Nombre	string	El nombre de la función
Parámetros	string	Parámetros requeridos por la función
Cuerpo	string	(Cero o más) let instrucciones seguidas de una expresión de CSL válida que se evalúa cuando se invoca la función
Carpeta	string	Carpeta usada para la categorización de funciones de la interfaz de usuario. Este parámetro no cambia la forma en que se invoca la función
DocString	string	Descripción de la función con fines de interfaz de usuario

Ejemplo

.alter function MyFunction1 docstring "Updated docstring"

Salida

Nombre	Parámetros	Cuerpo	Carpeta	DocString
MyFunction2	(myLimit: long)	{StormEvents | take myLimit}	MyFolder	Docstring actualizado