User-defined functions

​

When do you need UDFs

UDFs are crucial when there is a need to perform calculations that cannot be supported by standard SQL functions. Here are some typical scenarios and examples:

• Complex mathematical or statistical calculations, such as calculating the greatest common divisor of two numbers.
• Custom data transformations or validations, such as extracting information from network packets.
• Need to use external services or resources, such as accessing OpenAI API to generate text.
• Migration from existing systems, such as migrating Flink UDFs and implementing functions not currently supported by RisingWave.

It is important to note that UDFs have lower execution efficiency compared to built-in functions due to cross-language communication and data conversion. Therefore, users should always prioritize the use of built-in functions.

​

Types of UDFs in RisingWave

At present, there are three ways to define your UDF. The first option is to use it as an external function, which runs as a standalone service and provides maximum flexibility. The second option is to use an embedded UDF, which runs internally in RisingWave. The third is to use a SQL UDF, which allows for the same capabilities as regular SQL while offering a more concise way to express complex queries.

You can create all types of UDFs mentioned above using the CREATE FUNCTION command. However, the syntax may vary slightly depending on the type of UDF you want to create. We have provided specific guides for each type of UDF below, so you can choose the one that best meets your needs.

​

UDFs as external functions

RisingWave supports creating external UDFs with the following programming languages:

​

Embedded UDFs

RisingWave supports creating embedded UDFs with the following programming languages:

​

SQL UDFs

For details about how to create a SQL UDF and its use cases, see:

​

Other ways to categorize UDFs

UDFs can be categorized based on three dimensions. In the documentation provided above, we categorize them according to the execution method of functions, which has an impact on their performance and capabilities.

The other two dimensions are:

• The input and output of functions. For this dimension, since common SQL functions include scalar functions, table functions, aggregate functions, and window functions, UDFS can be classified as user-defined scalar functions (abbreviated as UDFs), user-defined table functions (UDTFs), user-defined aggregate functions (UDAFs), and user-defined window functions (UDWFs). RisingWave supports UDFs, UDTFs and UDAFs, covering most practical needs. You can find their guides in our documentation too. For example, for UDAFs, you can use the CREATE AGGREGATE command to create functions. Meanwhile, we also offer dedicated sections for creating UDAFs in Embedded Python UDFs and Embedded JavaScript UDFs.
• The language used to write functions. RisingWave currently supports using SQL, Python, Java, JavaScript, and Rust to write UDFs.

​

See also

To learn more about the design and implementation of our user-defined functions (UDFs), we have a series of blog articles on our website, for example:

These blogs provide in-depth information about UDFs and can help you understand their features and capabilities better. Feel free to explore them!