Rename

This topic describes how to use the function in the .

Description

Use the rename function to rename one or more fields. If you want to rename fields with similar names, you can use a wildcard character.

Function Input

collection<record<R>>

This function takes in collections of records with schema R.

Function Output

collection<record<S>>

This function outputs the same collection of records but with a different schema S.

Syntax

The required syntax is in bold.

rename

<wc-source-field> AS <wc-target-field> ["," <wc-source-field> AS <wc-target-field>]...

Required arguments

source-field

Syntax: <string>

Description: The name of a field in your data to rename. You can use a wild card character in the field name. Names with anything other than a-z, A-Z, 0-9, or the underscore ( _ ) character must be enclosed in single-quotation marks. This includes the wildcard character ( * ).

target-field

Syntax: AS <string>

Description: The name you want to use as the replacement name for the field. You can use a wild card character in the field name. Names with anything other than a-z, A-Z, 0-9, or the underscore ( _ ) character must be enclosed in single-quotation marks. This includes the wildcard character ( * ).

SPL2 example

When working in the SPL View, you can write the function by providing the arguments in this exact order.

The following example renames the time field to timestamp.

...|rename time AS timestamp |...;