Table Commands documentation added by Farhan-25 · Pull Request #159 · rizinorg/book

Farhan-25 · 2026-01-16T17:37:15Z

TABLE API added in tools/rz-bin/tables.md also updated _quarto.yml

wargio · 2026-01-17T05:03:31Z

+
+Rizin generates tables for certain commands, such as `aflt`, `is`, `izz`, and `il`, when they are executed on a file. These commands return structured data in the form of tables.
+
+The Table API is used to process and display this data. Using table specifiers, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.


Suggested change

The Table API is used to process and display this data. Using table specifiers, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.

The table output is used to process and display data. Using the table query syntax, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.

wargio · 2026-01-17T05:04:03Z

+
+## Table Command Syntax
+
+In Rizin, the help command for table-based commands is `:?`.


Suggested change

In Rizin, the help command for table-based commands is `:?`.

In Rizin, the help command for the table query syntax is `:?`.

wargio · 2026-01-17T05:05:45Z

+### Example 1: Filter, sort, and format analyzed functions
+
+```text
+aflt:addr/cols/name/nbbs:size/gt/32:nbbs/gt/1:nbbs/lt/10:nbbs/sort/dec:fancy


Suggested change

aflt:addr/cols/name/nbbs:size/gt/32:nbbs/gt/1:nbbs/lt/10:nbbs/sort/dec:fancy

aflt:addr/cols/name/nbbs:size/gt/32:nbbs/gt/1:nbbs/lt/10:nbbs/sort/rev:fancy

wargio · 2026-01-17T05:06:46Z

+
+Table format specifiers `(<table_spec>)`:
+```
+| <col>/sort/<inc|dec>      # Sort table by column <col> in increasing or decreasing order.


this is wrong. i probably forgot to change this as the sorting can be reversed by doing <col>/sort/rev

wargio · 2026-01-17T05:08:04Z

+Table format specifiers `(<table_spec>)`:
+```
+| <col>/sort/<inc|dec>      # Sort table by column <col> in increasing or decreasing order.
+| <col>/sortlen/<inc|dec>   # Sort table length of column <col> in increasing or decreasing order.


Suggested change

| <col>/sortlen/<inc|dec> # Sort table length of column <col> in increasing or decreasing order.

| <col>/sortlen/rev # Sort table length of column <col> in increasing or decreasing order.

same here. i forgot to update the info.

wargio

definitely a good start! can you fix the description on rizin side first and then the examples here?

Farhan-25 · 2026-01-17T05:21:56Z

Yes sure!

Farhan-25 · 2026-01-17T12:12:56Z

Please verify that I have made the required changes in the book.
rizinorg/rizin#5811
Also link for the pull request of the main rizin software with updated table commands.

notxvilka

It's not an API, commands. Except this looks good, thank you!

Rot127

Generally looks good.

Rot127 · 2026-01-19T14:52:05Z

+
+### Example 2: Paginate strings, filter by length, and export as CSV
+```
+izz:string/minlen/8:length/sort/rev:*/page/0/15:csv


@notxvilka @wargio This command throws errors for me:

[0x000037f0]> izz:string/minlen/8:length/sort/rev:*/page/0/15:csv rz_num_calc error: ( ')' expected) in ((i9<iv}2) rz_num_calc error: ( ')' expected) in ((iG<iTZÞ6) rz_num_calc error: ( ')' expected) in ((º<iTZD4) rz_num_calc error: ( ')' expected) in ((iG<iTZî3) rz_num_calc error: ( ')' expected) in ((iG<iTZ) rz_num_calc error: ( ')' expected) in ((iF<inY³) paddr,vaddr,len,size,section,type,string 0x00022f43,----------,14,15,.shstrtab,ascii,.gnu_debugdata 0x00022f34,----------,14,15,.shstrtab,ascii,.gnu_debuglink ...

i had the same error. seems that the buffer is not initialized or going out of bound.

rizinorg/rizin#5993

Farhan-25 · 2026-01-20T09:55:10Z

izz:string/minlen/8:length/sort/rev:*/page/0/15:csv
paddr,vaddr,len,size,section,type,string
0x00003791,----------,11,12,.shstrtab,ascii,.fini_array
0x00003785,----------,11,12,.shstrtab,ascii,.init_array
0x0000377b,----------,9,10,.shstrtab,ascii,.eh_frame
0x0000376d,----------,13,14,.shstrtab,ascii,.eh_frame_hdr
0x00003740,----------,9,10,.shstrtab,ascii,.rela.dyn
0x00003731,----------,14,15,.shstrtab,ascii,.gnu.version_r
0x00003724,----------,12,13,.shstrtab,ascii,.gnu.version
0x0000370a,----------,9,10,.shstrtab,ascii,.gnu.hash
0x000036f7,----------,18,19,.shstrtab,ascii,.note.gnu.build-id
0x000036e4,----------,18,19,.shstrtab,ascii,.note.gnu.property
0x000036da,----------,9,10,.shstrtab,ascii,.shstrtab
0x000036ad,----------,27,28,.strtab,ascii,__cxa_finalize@@GLIBC_2.2.5
0x00003693,----------,25,26,.strtab,ascii,_ITM_registerTMCloneTable
0x0000367f,----------,19,20,.strtab,ascii,malloc@@GLIBC_2.2.5
0x00003670,----------,14,15,.strtab,ascii,gmon_start

is:name/uniq:addr/gt/0x1000:name/str/init:addr/sort:json i used this command with le lt in place of gt and it works. ge will also return a empty table ig the file which i am using doesnt have any addr greater than 0x1000. Or it can be a bug.

Rot127 · 2026-01-21T13:59:17Z

Or it can be a bug.

My bin/ls had functions above this address. So it is a bug probably.

Rot127

Before I forget. Can you please check and document if the addresses used in the filtering are the virtual or physical (effectively the file offset) addresses.

wargio · 2026-01-22T04:12:35Z

My bin/ls had functions above this address. So it is a bug probably.

worth opening an issue on rizin side

Clarified note on address-based table filters and their operation on address types.

Farhan-25 · 2026-01-22T07:29:50Z

Before I forget. Can you please check and document if the addresses used in the filtering are the virtual or physical (effectively the file offset) addresses.

I added a note regarding this.

Farhan-25 · 2026-01-22T17:27:56Z

Can we push this @Rot127 @wargio ?

Rot127 · 2026-01-22T20:49:45Z

+| quiet  # Print the table in a simple form, without headers.
+```
+
+Note: Address-based table filters operate on the address type exposed by the table column. Columns such as `addr` and `vaddr` refer to virtual addresses, while `paddr` refers to physical addresses (file offsets). The table query engine does not perform address translation, therefore table filtering depends on the address type of the selected column.


The table query engine does not perform address translation, therefore table filtering depends on the address type of the selected column.

What do you mean with this sentence?

Also, when I was talking about the addresses, I was talking about the example below. Here it doesn't make sense.

Clarified note on address-based table filters and their operation on virtual addresses in examples.

Farhan-25 · 2026-01-23T04:43:01Z

My bad sir i removed that line.

Rot127 · 2026-01-24T16:08:48Z

 is:name/uniq:addr/gt/0x1000:name/str/init:addr/sort:json
 ```
 This command keeps only the first occurrence of each unique symbol name. It filters symbols whose address is greater than `0x1000` and whose name contains the substring `init`. The results are sorted in increasing order.
+We are using `addr` for filtering, which means that the filtering is performed on virtual addresses.


So I found some time and looked into it and figured what is the problem.

is doesn't have the addr column but only vaddr and paddr. uniq:addr simply prints all of the rows (because addr doesn't exist I guess?).

But it prints an error:

> is:name/uniq:addr/ ERROR: table: Invalid operation ()

This is also why my brief test by running the commands didn't work. because gt/addr couldn't compare to anything. Which was also shown in an error I missed:

In any case, did you run the commands by yourself and tested it?
Or did you just generated the text here with AI?

Yes i used AI. But i crosschecked it too. If addr is not a table then how come this command work?
is:name/uniq:addr/lt/0x1000:name/str/init:addr/sort:json just lt instead of gt.

I forgot that there is no addr column. So i just verified with lt and it was working so i wrote it here.
I can change it to vaddr to correct my mistake.

But i crosschecked it too.

Then it is fine.

I forgot that there is no addr column. So i just verified with lt and it was working so i wrote it here.

That is weird and a bug I think. The filtering should work consistently. Either fail or follow some how it matches.

I can change it to vaddr to correct my mistake.

Yes please. You can also remove the comments about paddr and vaddr then. Since they are no longer relevant.

ok thank you.

Done please check.

Farhan-25 · 2026-03-04T10:28:51Z

@Rot127 Can we merge this??

Rot127 · 2026-03-04T12:58:03Z

After the change we can merge IMO.

Co-authored-by: Rot127 <45763064+Rot127@users.noreply.github.com>

Farhan-25 · 2026-03-04T14:27:12Z

After the change we can merge IMO.

Done, plz check

docs: add Table API documentation

bc046fb

Farhan-25 mentioned this pull request Jan 16, 2026

Document the Table API #41

Open

wargio reviewed Jan 17, 2026

View reviewed changes

Comment thread src/tools/rz-bin/tables.md Outdated

wargio reviewed Jan 17, 2026

View reviewed changes

wargio requested changes Jan 17, 2026

View reviewed changes

Farhan-25 added 2 commits January 17, 2026 12:46

removed inc/dec and added rev

15e7416

minor changes

d4fbc57

Farhan-25 mentioned this pull request Jan 17, 2026

Minor documentation changes in table help command output. rizinorg/rizin#5811

Merged

notxvilka requested changes Jan 17, 2026

View reviewed changes

Rot127 requested changes Jan 19, 2026

View reviewed changes

minor changes

be0ea34

Rot127 requested changes Jan 21, 2026

View reviewed changes

Added note on address-based table filters in tables.md

fc8f5c8

Clarified note on address-based table filters and their operation on address types.

Rot127 reviewed Jan 22, 2026

View reviewed changes

Update notes on address filters in tables.md

f0955ec

Clarified note on address-based table filters and their operation on virtual addresses in examples.

Rot127 requested changes Jan 24, 2026

View reviewed changes

Fixed wrong examples

0ec475c

Rot127 requested changes Mar 4, 2026

View reviewed changes

Comment thread src/tools/rz-bin/tables.md Outdated

Fix example

94f4bdc

Co-authored-by: Rot127 <45763064+Rot127@users.noreply.github.com>

Farhan-25 changed the title ~~Table API documentation added~~ Table Commands documentation added Mar 4, 2026

Rot127 approved these changes Mar 4, 2026

View reviewed changes

wargio merged commit 0e8f8cd into rizinorg:master Mar 4, 2026
1 check passed

IndAlok mentioned this pull request Apr 6, 2026

table: fix shared query filtering rizinorg/rizin#6166

Merged

6 tasks

Farhan-25 deleted the update-table-api-docs branch April 6, 2026 18:00


		Rizin generates tables for certain commands, such as `aflt`, `is`, `izz`, and `il`, when they are executed on a file. These commands return structured data in the form of tables.

		The Table API is used to process and display this data. Using table specifiers, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.

	The Table API is used to process and display this data. Using table specifiers, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.
	The table output is used to process and display data. Using the table query syntax, users can sort rows, filter (grep) data, select specific columns or rows, paginate results, and limit the output. Tables can also be printed in different output formats such as CSV and JSON, or displayed in various textual layouts, including with borders and headers, with headers only, or without headers.


		## Table Command Syntax

		In Rizin, the help command for table-based commands is `:?`.

	In Rizin, the help command for table-based commands is `:?`.
	In Rizin, the help command for the table query syntax is `:?`.

	aflt:addr/cols/name/nbbs:size/gt/32:nbbs/gt/1:nbbs/lt/10:nbbs/sort/dec:fancy
	aflt:addr/cols/name/nbbs:size/gt/32:nbbs/gt/1:nbbs/lt/10:nbbs/sort/rev:fancy

	\| <col>/sortlen/<inc\|dec> # Sort table length of column <col> in increasing or decreasing order.
	\| <col>/sortlen/rev # Sort table length of column <col> in increasing or decreasing order.

Uh oh!

Conversation

Farhan-25 commented Jan 16, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wargio left a comment

Choose a reason for hiding this comment

Uh oh!

Farhan-25 commented Jan 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Farhan-25 commented Jan 17, 2026

Uh oh!

notxvilka left a comment

Choose a reason for hiding this comment

Uh oh!

Rot127 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wargio Jan 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Farhan-25 commented Jan 20, 2026

Uh oh!

Rot127 commented Jan 21, 2026

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wargio commented Jan 22, 2026

Uh oh!

Farhan-25 commented Jan 22, 2026

Uh oh!

Farhan-25 commented Jan 22, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Farhan-25 commented Jan 23, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rot127 Jan 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Farhan-25 commented Mar 4, 2026

Uh oh!

Uh oh!

Rot127 commented Mar 4, 2026

Uh oh!

Farhan-25 commented Mar 4, 2026

Uh oh!

Uh oh!

Reviewers

Farhan-25 commented Jan 17, 2026 •

edited

Loading

wargio Jan 25, 2026 •

edited

Loading

Rot127 left a comment •

edited

Loading

Rot127 Jan 25, 2026 •

edited

Loading