PPL tostring() implementation issue #4492 #4497

asifabashar · 2025-10-10T05:54:16Z

Description

Is your feature request related to a problem?
SPL allows tostring which implemented here.
part of RFC #4287 - tostring implementation
issue #4492

What solution would you like?
Function: tostring(,)
Description
This function converts a value to a string. If the value is a number, this function reformats it as a string. If the value is a Boolean value, it returns the corresponding string value, "True" or "False".
Usage
You can use this function with the eval commands and as part of eval expressions.
The value argument can be a field name or a value.

Number is accepted as input to the function.

When you use the tostring function with the eval command, the returned values might not sort as expected. Use the tostring function to format the displayed values.

The format argument is optional and is only used when the value argument is a number. The tostring function supports the following formats.

Format Description
"binary" Converts a number to a binary value.
"hex" Converts the number to a hexadecimal value.
"commas" Formats the number with commas. If the number includes a decimal, the function rounds the number to nearest two decimal places.
"duration" Converts the value in seconds to the readable time format HH:MM:SS.
Binary conversion
You can use this function to convert a number to a string of its binary representation. For example, the result of the following function is 1001, because the binary representation of 9 is 1001.:
eval result = tostring(9, "binary")

For information about bitwise functions that you can use with the tostring function, see Bitwise functions.

Basic examples
The following example returns "True 0xF 12,345.68".
... | eval n=tostring(1==1) + " " + tostring(15, "hex") + " " + tostring(12345.6789, "commas")
The following example returns foo=615 and foo2=00:10:15. The 615 seconds is converted into minutes and seconds.

... | eval foo=615 | eval foo2 = tostring(foo, "duration")
The following example formats the column totalSales to display values with a currency symbol and commas. You must use a period between the currency value and the tostring function.

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

New functionality includes testing.
New functionality has been documented.
New functionality has javadoc added.
New functionality has a user manual doc added.
New PPL command checklist all confirmed.
API changes companion pull request created.
Commits are signed per the DCO using --signoff or -s.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

asifabashar · 2025-10-10T05:56:18Z

@penghuo Please review

docs/user/ppl/functions/string.rst

async-query-core/src/main/antlr/OpenSearchPPLLexer.g4

ppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java

language-grammar/src/main/antlr4/OpenSearchSQLParser.g4

language-grammar/src/main/antlr4/OpenSearchSQLLexer.g4

core/src/main/java/org/opensearch/sql/expression/DSL.java

core/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java

asifabashar · 2025-10-14T05:33:21Z

@penghuo Thanks for your comments and review. I have made the changes, please check.

Signed-off-by: Asif Bashar <[email protected]>

asifabashar · 2025-10-20T19:43:58Z

@penghuo please review

docs/user/ppl/functions/conversion.rst

ppl/src/main/java/org/opensearch/sql/ppl/parser/AstExpressionBuilder.java

ppl/src/main/antlr/OpenSearchPPLParser.g4

ppl/src/main/java/org/opensearch/sql/ppl/parser/AstExpressionBuilder.java

Signed-off-by: Asif Bashar <[email protected]>

asifabashar · 2025-10-21T04:44:43Z

please review @penghuo

asifabashar · 2025-10-22T16:46:21Z

@penghuo please review

docs/user/ppl/functions/conversion.rst

core/src/main/java/org/opensearch/sql/calcite/CalciteRexNodeVisitor.java

core/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java

core/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java

Signed-off-by: Asif Bashar <[email protected]>

asifabashar

Please review @penghuo

Signed-off-by: Asif Bashar <[email protected]>

core/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java

core/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java

penghuo · 2025-10-27T16:40:14Z

@asifabashar Please resolve conflicts.

Signed-off-by: Asif Bashar <[email protected]>

* default-main: (34 commits) Enhance dynamic source clause to support only metadata filters (opensearch-project#4554) Make nested alias type support referring to outer context (opensearch-project#4673) Update big5 ppl queries and check plans (opensearch-project#4668) Support push down sort after limit (opensearch-project#4657) Use table scan rowType in filter pushdown could fix rename issue (opensearch-project#4670) Fix: Support Alias Fields in MIN, MAX, FIRST, LAST, and TAKE Aggregations (opensearch-project#4621) Fix bin nested fields issue (opensearch-project#4606) Add `per_minute`, `per_hour`, `per_day` function support (opensearch-project#4531) Pushdown sort aggregate metrics (opensearch-project#4603) Followup: Change ComparableLinkedHashMap to compare Key than Value (opensearch-project#4648) Mitigate the CI failure caused by 500 Internal Server Error (opensearch-project#4646) Allow renaming group-by fields to existing field names (opensearch-project#4586) Publish internal modules separately for downstream reuse (opensearch-project#4484) Revert "Update grammar files and developer guide (opensearch-project#4301)" (opensearch-project#4643) Support Automatic Type Conversion for REX/SPATH/PARSE Command Extractions (opensearch-project#4599) Replace all dots in fields of table scan's PhysType (opensearch-project#4633) Return comparable LinkedHashMap in `valueForCalcite()` of ExprTupleValue (opensearch-project#4629) Refactor JsonExtractAllFunctionIT and MapConcatFunctionIT (opensearch-project#4623) Pushdown case function in aggregations as range queries (opensearch-project#4400) Update GEOIP function to support IP types as input (opensearch-project#4613) ... Signed-off-by: Asif Bashar <[email protected]>

asifabashar · 2025-10-28T17:28:00Z

fixed merge conflicts

penghuo · 2025-10-28T20:50:10Z

fixed merge conflicts

@asifabashar
tostring docs missing after merge conflict, please double check.

asifabashar marked this pull request as ready for review October 10, 2025 05:55

penghuo added PPL Piped processing language enhancement New feature or request labels Oct 10, 2025

penghuo requested changes Oct 10, 2025

View reviewed changes

asifabashar added 3 commits October 19, 2025 06:14

added doc update to specifically set 2nd argument as optional

6e24aa3

Signed-off-by: Asif Bashar <[email protected]>

mentioned as value instead of number specifically

454cfc8

Signed-off-by: Asif Bashar <[email protected]>

fixed wrong bullet point

b221e8c

Signed-off-by: Asif Bashar <[email protected]>

asifabashar force-pushed the main branch from 1f2f12b to b221e8c Compare October 19, 2025 13:14

removed extra quote

1ed88e1

Signed-off-by: Asif Bashar <[email protected]>

penghuo requested changes Oct 20, 2025

View reviewed changes

asifabashar force-pushed the main branch from b31b465 to 3584d68 Compare October 21, 2025 04:30

asifabashar added 2 commits October 20, 2025 21:33

we have duplicated example

5cbedcc

Signed-off-by: Asif Bashar <[email protected]>

applied recommended changes

682eb9d

Signed-off-by: Asif Bashar <[email protected]>

asifabashar force-pushed the main branch from 3584d68 to 682eb9d Compare October 21, 2025 04:34

asifabashar requested a review from penghuo October 21, 2025 04:44

penghuo requested changes Oct 22, 2025

View reviewed changes

recommended changes

d0b809a

Signed-off-by: Asif Bashar <[email protected]>

asifabashar force-pushed the main branch from 548daf8 to d0b809a Compare October 26, 2025 03:17

asifabashar commented Oct 26, 2025

View reviewed changes

asifabashar requested a review from penghuo October 26, 2025 03:33

asifabashar added 2 commits October 25, 2025 20:39

requested changes

ba3553b

Signed-off-by: Asif Bashar <[email protected]>

requested changes

08429c1

Signed-off-by: Asif Bashar <[email protected]>

penghuo reviewed Oct 27, 2025

View reviewed changes

core/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java Show resolved Hide resolved

core/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java Show resolved Hide resolved

asifabashar added 3 commits October 28, 2025 09:53

updated with try catch for string parsing.

7e6e9ac

Signed-off-by: Asif Bashar <[email protected]>

merge conflict fix

1420e8f

Signed-off-by: Asif Bashar <[email protected]>

asifabashar force-pushed the main branch from e7775d3 to 42d705a Compare October 28, 2025 17:16

asifabashar requested a review from penghuo October 28, 2025 17:28

Uh oh!

PPL tostring() implementation issue #4492 #4497

Are you sure you want to change the base?

PPL tostring() implementation issue #4492 #4497

Conversation

asifabashar commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Check List

Uh oh!

asifabashar commented Oct 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asifabashar commented Oct 14, 2025

Uh oh!

asifabashar commented Oct 20, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asifabashar commented Oct 21, 2025

Uh oh!

asifabashar commented Oct 22, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asifabashar left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

penghuo commented Oct 27, 2025

Uh oh!

asifabashar commented Oct 28, 2025

Uh oh!

penghuo commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

asifabashar commented Oct 10, 2025 •

edited

Loading

asifabashar left a comment •

edited

Loading

penghuo commented Oct 28, 2025 •

edited

Loading