Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 2.89 KB

function-template.md

File metadata and controls

62 lines (42 loc) · 2.89 KB
layout title description parent
default
<name of function>
Reference material for <name of function> function
SQL functions

FUNCTION

Function description, starting with a verb, such as Returns, Counts, Takes, Allows. Define what the function does without assuming prior knowledge, and without using the function to define itself. For example, if you want to define the Manhattan distance, do not define the function by saying that it calculates the Manhattan distance. State how the Manhattan distance is calculated using the simplest terms possible, and write the definition in terms that a 10th grader can follow. Do not use jargon which doesn't translate well, or parentheses unless it's to define an abbreviation, or latinisms such as i.e. or e.g., or etc. Do not use personal pronouns including "we". Avoid passive voice if possible.

Note (optional, includes limitations on this function)

Syntax

{: .no_toc}

FUNCTION(<exp1>, <exp2>)

Aliases (Optional) - remove this entire section if there aren't any

FUNCTION_ALIAS(<exp1>, <exp2>)

Parameters

{: .no_toc}

Parameter Description Supported input types
<expression> <data_type(s)>

//for a full list of parameter labels for different types of inputs, see: https://app.getguru.com/card/cAxkMbki/Function-template-in-docs

Return Types(s)

The FUNCTION function returns a result of type DATATYPE.

Remarks (Optional)

{: .no_toc}

(optional, includes any additional remarks about this function)

Example(s) (Optional if there are several examples)

{: .no_toc}

Example

The following code example (insert a one-sentence complete description of what the code does. You can use AI to help you generate this.) Provide a code example that is simple to follow. For example, instead of calculating the median over a range of 10,000 numbers, calculate it over 4 numbers. Use several examples to illustrate end cases. Customer example data sets are located here. Please also check in your function examples as code and use the sql to docs transpiler to create (interactive) documentation. This ensures that we cannot break documented sql examples in the future in new PackDB releases.

SELECT
	 AS ;

Returns(make sure there is a carriage return after this line so that the text renders correctly)

``

(Optional) The previous code example returns (insert what and why it returns what it does, if necessary for understanding.)