PPL tostring() implementation issue #4492 - #4497

Merged
penghuo merged 25 commits into
opensearch-project:mainfrom
asifabashar:main
Nov 5, 2025
Merged

PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom
asifabashar:main

Conversation

@asifabashar

@asifabasharasifabashar commented Oct 10, 2025•
edited by yuancu
Loading

Copy link
Copy Markdown
Contributor

Description

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

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#4492

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
asifabashar marked this pull request as ready for review October 10, 2025 05:55
@asifabashar

asifabashar commented Oct 10, 2025

Copy link
Copy Markdown
ContributorAuthor

@penghuo Please review

@penghuopenghuo added PPL Piped processing language enhancement New feature or request labels Oct 10, 2025
penghuo
penghuo requested changes Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst Outdated
Comment threaddocs/user/ppl/functions/string.rst Outdated
Comment threaddocs/user/ppl/functions/string.rst Outdated
Comment threaddocs/user/ppl/functions/string.rst Outdated
Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4 Outdated
Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java Outdated
Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java Outdated
Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java Outdated
Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java Outdated
Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo requested changes Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4 Outdated
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4 Outdated
Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java Outdated
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar

asifabashar commented Oct 14, 2025

Copy link
Copy Markdown
ContributorAuthor

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

@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo reviewed Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo

penghuo commented Oct 27, 2025

Copy link
Copy Markdown
Collaborator

@asifabashar Please resolve conflicts.

@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar

asifabashar commented Oct 28, 2025

Copy link
Copy Markdown
ContributorAuthor

fixed merge conflicts

@penghuo

penghuo commented Oct 28, 2025•
edited
Loading

Copy link
Copy Markdown
Collaborator

fixed merge conflicts

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

penghuo
penghuo requested changes Oct 30, 2025
View reviewed changes

@penghuopenghuo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?

@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar

asifabashar commented Nov 2, 2025

Copy link
Copy Markdown
ContributorAuthor

sorry for missing, I have added back tostring doc

@asifabashar

asifabashar commented Nov 3, 2025

Copy link
Copy Markdown
ContributorAuthor

@penghuo please review, fixed merge conflict

dai-chen
dai-chen reviewed Nov 4, 2025
View reviewed changes

@dai-chendai-chen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.

@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar

asifabashar commented Nov 5, 2025

Copy link
Copy Markdown
ContributorAuthor

fixed doctest , removed EMP

@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo enabled auto-merge (squash) November 5, 2025 17:32
@penghuo
penghuo merged commit 6783c89 into opensearch-project:mainNov 5, 2025
35 checks passed
opensearch-trigger-botBot pushed a commit that referenced this pull request Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot mentioned this pull request Nov 5, 2025
Merged
penghuo pushed a commit that referenced this pull request Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224 mentioned this pull request Dec 15, 2025
Merged
8 tasks
@asifabasharasifabashar mentioned this pull request Jan 2, 2026
Open
@tkykenmttkykenmt mentioned this pull request Jan 11, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees

No one assigned

Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation

3 participants

@asifabashar@penghuo@dai-chen
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
PPL tostring() implementation issue #4492 - #4497
Merged
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Nov 5, 2025
Merged
PPL tostring() implementation issue #4492#4497
penghuo merged 25 commits into
opensearch-project:mainfrom 
asifabashar:main
Conversation
@asifabashar
@asifabasharasifabashar
commented
Oct 10, 2025•

edited by yuancu

Loading

Copy link


Copy Markdown

Contributor
Description
Is your feature request related to a problem?

SPL allows tostring which implemented here.

part of RFC #4287 - tostring implementation
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#4492
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
asifabashar
marked this pull request as ready for review
October 10, 2025 05:55
@asifabashar
asifabashar
commented
Oct 10, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Please review
@penghuopenghuo
added

PPL
Piped processing language
enhancement
New feature or request
labels
Oct 10, 2025
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threaddocs/user/ppl/functions/string.rst
Outdated

Comment threadasync-query-core/src/main/antlr/OpenSearchPPLLexer.g4
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
Outdated

Comment threadppl/src/test/java/org/opensearch/sql/ppl/calcite/CalcitePPLStringFunctionTest.java
penghuo
penghuo
requested changes
Oct 10, 2025
View reviewed changes
Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLParser.g4
Outdated

Comment threadlanguage-grammar/src/main/antlr4/OpenSearchSQLLexer.g4
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/DSL.java
Outdated

Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
@asifabashar
asifabashar
commented
Oct 14, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo Thanks for your comments and review. I have made the changes, please check.
@asifabashar
requested changes
08429c1
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
penghuo
penghuo
reviewed
Oct 27, 2025
View reviewed changes
Comment threadcore/src/main/java/org/opensearch/sql/expression/function/udf/ToStringFunction.java
Comment threadcore/src/main/java/org/opensearch/sql/calcite/utils/PPLOperandTypes.java
@penghuo
penghuo
commented
Oct 27, 2025

Copy link


Copy Markdown

Collaborator
@asifabashar Please resolve conflicts.
@asifabashar
updated with try catch for string parsing.
7e6e9ac
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
merge conflict fix
1420e8f
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
Merge branch 'default-main'
42d705a
* 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 <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Oct 28, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed merge conflicts
@penghuo
penghuo
commented
Oct 28, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
fixed merge conflicts
@asifabashar

tostring docs missing after merge conflict, please double check.
penghuo
penghuo
requested changes
Oct 30, 2025
View reviewed changes
@penghuopenghuo
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asifabashar Could u add back tostring doc?
@asifabashar
added back missing tostring doc
f9c9a12
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 2, 2025

Copy link


Copy Markdown

ContributorAuthor
sorry for missing, I have added back tostring doc
@asifabashar
asifabashar
commented
Nov 3, 2025

Copy link


Copy Markdown

ContributorAuthor
@penghuo please review, fixed merge conflict
dai-chen
dai-chen
reviewed
Nov 4, 2025
View reviewed changes
@dai-chendai-chen
left a comment


Copy link


Copy Markdown

Collaborator
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes! Please fix the CI. It seems index EMP in doctest doesn't exist.
@asifabashar
updated fix for doctest
123fcd5
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@asifabashar
asifabashar
commented
Nov 5, 2025

Copy link


Copy Markdown

ContributorAuthor
fixed doctest , removed EMP
@asifabashar
fix doctest failures
e6d0c8c
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
@penghuo
penghuo
enabled auto-merge (squash)
November 5, 2025 17:32
@penghuo
penghuo
merged commit 6783c89
into
opensearch-project:mainNov 5, 2025

35 checks passed

opensearch-trigger-botBot
pushed a commit
that referenced
this pull request
Nov 5, 2025
@github-actions
PPL tostring() implementation issue#4492(#4497)
d4454a5
---------
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
(cherry picked from commit 6783c89)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-botopensearch-trigger-botBot
mentioned this pull request
Nov 5, 2025
 Merged

penghuo pushed a commit
that referenced
this pull request
Nov 5, 2025
@opensearch-trigger-bot@github-actions
PPL tostring() implementation issue#4492(#4497) (#4747)
96e48e2
---------
(cherry picked from commit 6783c89)
Signed-off-by: Asif Bashar <asif.bashar@gmail.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ykmr1224ykmr1224
mentioned this pull request
Dec 15, 2025
 Merged

8 tasks
@asifabasharasifabashar
mentioned this pull request
Jan 2, 2026

Open

@tkykenmttkykenmt
mentioned this pull request
Jan 11, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@penghuopenghuopenghuo approved these changes
@dai-chendai-chendai-chen approved these changes
@ps48ps48Awaiting requested review from ps48ps48 is a code owner
@kavithacmkavithacmAwaiting requested review from kavithacm
@derek-hoderek-hoAwaiting requested review from derek-ho
@joshuali925joshuali925Awaiting requested review from joshuali925joshuali925 is a code owner
@YANG-DBYANG-DBAwaiting requested review from YANG-DB
@mengweiericmengweiericAwaiting requested review from mengweiericmengweieric is a code owner
@vamsimanoharvamsimanoharAwaiting requested review from vamsimanoharvamsimanohar is a code owner
@SwiddisSwiddisAwaiting requested review from SwiddisSwiddis is a code owner
@seankao-azseankao-azAwaiting requested review from seankao-az
@MaxKsyunzMaxKsyunzAwaiting requested review from MaxKsyunz
@Yury-FridlyandYury-FridlyandAwaiting requested review from Yury-Fridlyand
@anirudhaanirudhaAwaiting requested review from anirudhaanirudha is a code owner
@forestmveyforestmveyAwaiting requested review from forestmvey
@acarbonettoacarbonettoAwaiting requested review from acarbonettoacarbonetto is a code owner
@GumpacGGumpacGAwaiting requested review from GumpacG
@ykmr1224ykmr1224Awaiting requested review from ykmr1224ykmr1224 is a code owner
@LantaoJinLantaoJinAwaiting requested review from LantaoJinLantaoJin is a code owner
@noChargernoChargerAwaiting requested review from noChargernoCharger is a code owner
@qianheng-awsqianheng-awsAwaiting requested review from qianheng-awsqianheng-aws is a code owner
@yuancuyuancuAwaiting requested review from yuancuyuancu is a code owner
@RyanL1997RyanL1997Awaiting requested review from RyanL1997RyanL1997 is a code owner

Assignees


No one assigned


Labels

backport 2.19-devenhancementNew feature or requestPPLPiped processing language

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[FEATURE] RFC #4287 - tostring implementation


3 participants

@asifabashar@penghuo@dai-chen