Struct Documentation

pub struct Documentation {
    pub doc_section: DocSection,
    pub description: String,
    pub syntax_example: String,
    pub sql_example: Option<String>,
    pub arguments: Option<Vec<(String, String)>>,
    pub alternative_syntax: Option<Vec<String>>,
    pub related_udfs: Option<Vec<String>>,
}

Documentation for use by ScalarUDFImpl, AggregateUDFImpl and WindowUDFImpl functions.

See the DocumentationBuilder to create a new Documentation struct.

The DataFusion SQL function documentation is automatically generated from these structs. The name of the udf will be pulled from the ScalarUDFImpl::name, AggregateUDFImpl::name or WindowUDFImpl::name function as appropriate.

All strings in the documentation are required to be in markdown format.

Currently, documentation only supports a single language thus all text should be in English.

Fields

doc_section: DocSection

The section in the documentation where the UDF will be documented

description: String

The description for the UDF

syntax_example: String

A brief example of the syntax. For example “ascii(str)”

sql_example: Option<String>

A sql example for the UDF, usually in the form of a sql prompt query and output. It is strongly recommended to provide an example for anything but the most basic UDF’s

arguments: Option<Vec<(String, String)>>

Arguments for the UDF which will be displayed in array order. Left member of a pair is the argument name, right is a description for the argument

alternative_syntax: Option<Vec<String>>

A list of alternative syntax examples for a function

related_udfs: Option<Vec<String>>

Related functions if any. Values should match the related udf’s name exactly. Related udf’s must be of the same UDF type (scalar, aggregate or window) for proper linking to occur

Implementations

impl Documentation

pub fn builder( doc_section: DocSection, description: impl Into<String>, syntax_example: impl Into<String>, ) -> DocumentationBuilder

Returns a new DocumentationBuilder with no options set.

pub fn to_doc_attribute(&self) -> String

Output the Documentation struct in form of custom Rust documentation attributes It is useful to semi automate during tmigration of UDF documentation generation from code based to attribute based and can be safely removed after

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Documentation

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.