Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF


On October 30, 2022, all 1.2.x versions of the Splunk Data Stream Processor will reach its end of support date. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see the Upgrade the Splunk Data Stream Processor topic.
Acrobat logo Download topic as PDF

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 |...;
Last modified on 09 February, 2022
PREVIOUS
Rex
  NEXT
Select

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.1.0, 1.2.0, 1.2.1-patch02, 1.2.1, 1.2.2-patch02, 1.2.4, 1.2.5, 1.3.0, 1.3.1


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters