Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Utility for generation of man pages #493

Merged
merged 2 commits into from
Jun 19, 2022
Merged

chore: Utility for generation of man pages #493

merged 2 commits into from
Jun 19, 2022

Conversation

orpheuslummis
Copy link
Contributor

@orpheuslummis orpheuslummis commented Jun 1, 2022 •
edited
Loading

RELEVANT ISSUE(S)

Resolves #258

DESCRIPTION

Small utility to generate man pages of the CLI.

HOW HAS THIS BEEN TESTED?

Manual testing.

CHECKLIST:

  • I have commented the code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the repo-held documentation.
  • I have made sure that the PR title adheres to the conventional commit style (subset of the ones we use can be found under: tools/configs/chglog/config.yml

ENVIRONMENT / OS THIS WAS TESTED ON?

Please specify which of the following was this tested on (remove or add your own):

  • Arch Linux
  • Debian Linux
  • MacOS
  • Windows

@orpheuslummis orpheuslummis added ci/build This is issue is about the build or CI system, and the administration of it. area/cli Related to the CLI binary labels Jun 1, 2022
@orpheuslummis orpheuslummis added this to the DefraDB v0.3 milestone Jun 1, 2022
@orpheuslummis orpheuslummis self-assigned this Jun 1, 2022
@orpheuslummis orpheuslummis changed the title feat: Utility for generation of man pages chore: Utility for generation of man pages Jun 1, 2022
@source-devs
Copy link

Benchmark Results

Summary

  • 113 Benchmarks successfully compared.
  • 3 Benchmarks were ✅ Better.
  • 110 Benchmarks were ❌ Worse .
  • 0 Benchmarks were ✨ Unchanged.
✅ See Better Results...
time/opdelta
_Collection_UserSimple_Create_Async_0_100-458.8ms ± 0%54.9ms ± 0%−6.61%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_1000-4572ms ± 0%473ms ± 0%−17.41%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_10000-45.85s ± 0%4.83s ± 0%−17.48%(p=1.000 n=1+1)
 
❌ See Worse Results...
time/opdelta
_Collection_UserSimple_CreateMany_Sync_0_100-4217ms ± 0%270ms ± 0%+24.34%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_10-49.91ms ± 0%13.45ms ± 0%+35.63%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_100-4105ms ± 0%117ms ± 0%+12.01%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_1000-41.05s ± 0%1.12s ± 0%+6.31%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_10_10-4348µs ± 0%398µs ± 0%+14.35%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_100_100-43.62ms ± 0%4.63ms ± 0%+28.01%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_1000-438.8ms ± 0%41.0ms ± 0%+5.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_10-4379µs ± 0%386µs ± 0%+1.78%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_100-43.75ms ± 0%3.96ms ± 0%+5.69%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_10_10-4244µs ± 0%294µs ± 0%+20.57%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_100_100-41.73ms ± 0%2.08ms ± 0%+19.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_1000-423.5ms ± 0%24.4ms ± 0%+3.75%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_10-4253µs ± 0%269µs ± 0%+6.31%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_100-41.81ms ± 0%1.93ms ± 0%+6.16%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_100-41.17ms ± 0%1.36ms ± 0%+16.30%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_1000-49.50ms ± 0%10.30ms ± 0%+8.40%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_10-4415µs ± 0%507µs ± 0%+22.14%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_100-41.29ms ± 0%1.56ms ± 0%+21.50%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_1000-410.0ms ± 0%12.1ms ± 0%+21.06%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_10-4376µs ± 0%487µs ± 0%+29.56%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_100-4434µs ± 0%560µs ± 0%+29.03%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_1000-4431µs ± 0%480µs ± 0%+11.33%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_10-4646µs ± 0%851µs ± 0%+31.78%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_100-4635µs ± 0%710µs ± 0%+11.83%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_1000-4629µs ± 0%673µs ± 0%+7.00%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_10-4277µs ± 0%359µs ± 0%+29.56%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_100-4274µs ± 0%360µs ± 0%+31.58%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_1000-4275µs ± 0%277µs ± 0%+0.64%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_10-4402µs ± 0%531µs ± 0%+31.95%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_100-41.36ms ± 0%1.62ms ± 0%+19.16%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_1000-412.1ms ± 0%12.9ms ± 0%+7.10%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0128-412.3µs ± 0%15.9µs ± 0%+30.06%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0256-413.5µs ± 0%15.6µs ± 0%+15.67%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0512-415.5µs ± 0%19.5µs ± 0%+26.16%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:1024-419.3µs ± 0%30.3µs ± 0%+57.46%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0064-4119µs ± 0%158µs ± 0%+32.69%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0128-4127µs ± 0%155µs ± 0%+22.28%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0256-4136µs ± 0%156µs ± 0%+14.83%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0512-4155µs ± 0%172µs ± 0%+11.16%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:1024-4192µs ± 0%249µs ± 0%+29.88%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0064-414.4µs ± 0%16.9µs ± 0%+17.72%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0128-414.6µs ± 0%16.9µs ± 0%+15.51%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0256-415.3µs ± 0%19.1µs ± 0%+25.21%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0512-416.4µs ± 0%21.8µs ± 0%+32.85%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:1024-420.1µs ± 0%28.0µs ± 0%+38.92%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0064-4133µs ± 0%167µs ± 0%+24.83%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0128-4142µs ± 0%171µs ± 0%+20.48%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0256-4147µs ± 0%188µs ± 0%+27.79%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0512-4159µs ± 0%210µs ± 0%+31.72%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:1024-4194µs ± 0%246µs ± 0%+27.25%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0064-443.9µs ± 0%54.9µs ± 0%+25.14%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0128-444.6µs ± 0%57.5µs ± 0%+28.95%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0256-445.1µs ± 0%55.8µs ± 0%+23.73%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0512-452.0µs ± 0%65.2µs ± 0%+25.34%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:1024-463.3µs ± 0%80.0µs ± 0%+26.37%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0064-4315µs ± 0%404µs ± 0%+28.20%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0128-4325µs ± 0%484µs ± 0%+48.82%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0256-4342µs ± 0%521µs ± 0%+52.42%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0512-4385µs ± 0%537µs ± 0%+39.44%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:1024-4481µs ± 0%602µs ± 0%+25.24%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0064-441.0µs ± 0%61.7µs ± 0%+50.44%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0128-442.6µs ± 0%55.2µs ± 0%+29.36%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0256-443.2µs ± 0%59.1µs ± 0%+36.67%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0512-449.3µs ± 0%65.1µs ± 0%+31.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:1024-461.2µs ± 0%71.3µs ± 0%+16.45%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0064-4308µs ± 0%422µs ± 0%+37.05%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0128-4313µs ± 0%457µs ± 0%+45.78%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0256-4325µs ± 0%423µs ± 0%+30.29%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0512-4376µs ± 0%506µs ± 0%+34.74%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:1024-4492µs ± 0%542µs ± 0%+10.09%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0064-4118µs ± 0%127µs ± 0%+7.30%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0128-4121µs ± 0%140µs ± 0%+16.11%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0256-4122µs ± 0%154µs ± 0%+25.76%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0512-4127µs ± 0%148µs ± 0%+16.42%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:1024-4140µs ± 0%171µs ± 0%+21.89%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0064-41.19ms ± 0%1.43ms ± 0%+19.93%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0128-41.22ms ± 0%1.42ms ± 0%+16.99%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0256-41.21ms ± 0%1.39ms ± 0%+14.18%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0512-41.24ms ± 0%1.57ms ± 0%+27.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:1024-41.39ms ± 0%1.63ms ± 0%+17.73%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0064-4116µs ± 0%123µs ± 0%+6.37%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0128-4113µs ± 0%128µs ± 0%+13.47%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0256-4118µs ± 0%140µs ± 0%+18.49%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0512-4122µs ± 0%145µs ± 0%+18.87%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:1024-4136µs ± 0%169µs ± 0%+24.06%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0064-41.15ms ± 0%1.21ms ± 0%+5.39%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0128-41.17ms ± 0%1.52ms ± 0%+30.39%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0256-41.20ms ± 0%1.29ms ± 0%+7.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0512-41.24ms ± 0%1.45ms ± 0%+17.25%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:1024-41.34ms ± 0%1.47ms ± 0%+10.00%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0064-48.11µs ± 0%10.27µs ± 0%+26.61%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0128-48.56µs ± 0%9.20µs ± 0%+7.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0256-49.30µs ± 0%11.21µs ± 0%+20.52%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0512-410.5µs ± 0%16.2µs ± 0%+54.81%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:1024-414.1µs ± 0%20.3µs ± 0%+43.69%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0064-484.2µs ± 0%113.2µs ± 0%+34.43%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0128-495.3µs ± 0%109.3µs ± 0%+14.66%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0256-493.1µs ± 0%120.7µs ± 0%+29.59%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0512-4113µs ± 0%168µs ± 0%+48.90%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:1024-4145µs ± 0%192µs ± 0%+32.46%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0064-4124µs ± 0%137µs ± 0%+10.60%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0128-4124µs ± 0%139µs ± 0%+11.57%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0256-4124µs ± 0%149µs ± 0%+20.24%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0512-4131µs ± 0%144µs ± 0%+9.91%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:1024-4127µs ± 0%145µs ± 0%+13.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0064-41.28ms ± 0%1.33ms ± 0%+3.76%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0128-41.20ms ± 0%1.40ms ± 0%+17.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0256-41.19ms ± 0%1.41ms ± 0%+17.86%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0512-41.32ms ± 0%1.60ms ± 0%+21.20%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:1024-41.33ms ± 0%1.53ms ± 0%+14.56%(p=1.000 n=1+1)
 
✨ See Unchanged Results...
time/opdelta
 
🐋 See Full Results...
develop.txtcurrent.txt
time/opdelta
pkg:collection goos:linux goarch:amd64
_Collection_UserSimple_CreateMany_Sync_0_10-410.5ms ± 0%11.5ms ± 0%+9.16%(p=1.000 n=1+1)
_Collection_UserSimple_CreateMany_Sync_0_100-4217ms ± 0%270ms ± 0%+24.34%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_10-49.91ms ± 0%13.45ms ± 0%+35.63%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_100-4105ms ± 0%117ms ± 0%+12.01%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_1000-41.05s ± 0%1.12s ± 0%+6.31%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_100-458.8ms ± 0%54.9ms ± 0%−6.61%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_1000-4572ms ± 0%473ms ± 0%−17.41%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_10000-45.85s ± 0%4.83s ± 0%−17.48%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_10_10-4348µs ± 0%398µs ± 0%+14.35%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_100_100-43.62ms ± 0%4.63ms ± 0%+28.01%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_1000-438.8ms ± 0%41.0ms ± 0%+5.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_10-4379µs ± 0%386µs ± 0%+1.78%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_100-43.75ms ± 0%3.96ms ± 0%+5.69%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_10_10-4244µs ± 0%294µs ± 0%+20.57%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_100_100-41.73ms ± 0%2.08ms ± 0%+19.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_1000-423.5ms ± 0%24.4ms ± 0%+3.75%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_10-4253µs ± 0%269µs ± 0%+6.31%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_100-41.81ms ± 0%1.93ms ± 0%+6.16%(p=1.000 n=1+1)
pkg:query/simple goos:linux goarch:amd64
_Query_UserSimple_Query_Sync_10-4344µs ± 0%378µs ± 0%+9.76%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_100-41.17ms ± 0%1.36ms ± 0%+16.30%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_1000-49.50ms ± 0%10.30ms ± 0%+8.40%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_10-4415µs ± 0%507µs ± 0%+22.14%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_100-41.29ms ± 0%1.56ms ± 0%+21.50%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_1000-410.0ms ± 0%12.1ms ± 0%+21.06%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_10-4376µs ± 0%487µs ± 0%+29.56%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_100-4434µs ± 0%560µs ± 0%+29.03%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_1000-4431µs ± 0%480µs ± 0%+11.33%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_10-4646µs ± 0%851µs ± 0%+31.78%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_100-4635µs ± 0%710µs ± 0%+11.83%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_1000-4629µs ± 0%673µs ± 0%+7.00%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_10-4277µs ± 0%359µs ± 0%+29.56%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_100-4274µs ± 0%360µs ± 0%+31.58%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_1000-4275µs ± 0%277µs ± 0%+0.64%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_10-4402µs ± 0%531µs ± 0%+31.95%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_100-41.36ms ± 0%1.62ms ± 0%+19.16%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_1000-412.1ms ± 0%12.9ms ± 0%+7.10%(p=1.000 n=1+1)
pkg:storage goos:linux goarch:amd64
_Storage_Simple_Read_Sync_1_10/ValueSize:0064-412.4µs ± 0%16.4µs ± 0%+32.47%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0128-412.3µs ± 0%15.9µs ± 0%+30.06%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0256-413.5µs ± 0%15.6µs ± 0%+15.67%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0512-415.5µs ± 0%19.5µs ± 0%+26.16%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:1024-419.3µs ± 0%30.3µs ± 0%+57.46%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0064-4119µs ± 0%158µs ± 0%+32.69%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0128-4127µs ± 0%155µs ± 0%+22.28%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0256-4136µs ± 0%156µs ± 0%+14.83%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0512-4155µs ± 0%172µs ± 0%+11.16%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:1024-4192µs ± 0%249µs ± 0%+29.88%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0064-414.4µs ± 0%16.9µs ± 0%+17.72%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0128-414.6µs ± 0%16.9µs ± 0%+15.51%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0256-415.3µs ± 0%19.1µs ± 0%+25.21%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0512-416.4µs ± 0%21.8µs ± 0%+32.85%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:1024-420.1µs ± 0%28.0µs ± 0%+38.92%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0064-4133µs ± 0%167µs ± 0%+24.83%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0128-4142µs ± 0%171µs ± 0%+20.48%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0256-4147µs ± 0%188µs ± 0%+27.79%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0512-4159µs ± 0%210µs ± 0%+31.72%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:1024-4194µs ± 0%246µs ± 0%+27.25%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0064-443.9µs ± 0%54.9µs ± 0%+25.14%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0128-444.6µs ± 0%57.5µs ± 0%+28.95%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0256-445.1µs ± 0%55.8µs ± 0%+23.73%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0512-452.0µs ± 0%65.2µs ± 0%+25.34%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:1024-463.3µs ± 0%80.0µs ± 0%+26.37%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0064-4315µs ± 0%404µs ± 0%+28.20%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0128-4325µs ± 0%484µs ± 0%+48.82%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0256-4342µs ± 0%521µs ± 0%+52.42%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0512-4385µs ± 0%537µs ± 0%+39.44%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:1024-4481µs ± 0%602µs ± 0%+25.24%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0064-441.0µs ± 0%61.7µs ± 0%+50.44%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0128-442.6µs ± 0%55.2µs ± 0%+29.36%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0256-443.2µs ± 0%59.1µs ± 0%+36.67%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0512-449.3µs ± 0%65.1µs ± 0%+31.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:1024-461.2µs ± 0%71.3µs ± 0%+16.45%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0064-4308µs ± 0%422µs ± 0%+37.05%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0128-4313µs ± 0%457µs ± 0%+45.78%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0256-4325µs ± 0%423µs ± 0%+30.29%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0512-4376µs ± 0%506µs ± 0%+34.74%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:1024-4492µs ± 0%542µs ± 0%+10.09%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0064-4118µs ± 0%127µs ± 0%+7.30%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0128-4121µs ± 0%140µs ± 0%+16.11%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0256-4122µs ± 0%154µs ± 0%+25.76%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0512-4127µs ± 0%148µs ± 0%+16.42%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:1024-4140µs ± 0%171µs ± 0%+21.89%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0064-41.19ms ± 0%1.43ms ± 0%+19.93%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0128-41.22ms ± 0%1.42ms ± 0%+16.99%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0256-41.21ms ± 0%1.39ms ± 0%+14.18%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0512-41.24ms ± 0%1.57ms ± 0%+27.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:1024-41.39ms ± 0%1.63ms ± 0%+17.73%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0064-4116µs ± 0%123µs ± 0%+6.37%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0128-4113µs ± 0%128µs ± 0%+13.47%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0256-4118µs ± 0%140µs ± 0%+18.49%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0512-4122µs ± 0%145µs ± 0%+18.87%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:1024-4136µs ± 0%169µs ± 0%+24.06%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0064-41.15ms ± 0%1.21ms ± 0%+5.39%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0128-41.17ms ± 0%1.52ms ± 0%+30.39%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0256-41.20ms ± 0%1.29ms ± 0%+7.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0512-41.24ms ± 0%1.45ms ± 0%+17.25%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:1024-41.34ms ± 0%1.47ms ± 0%+10.00%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0064-48.11µs ± 0%10.27µs ± 0%+26.61%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0128-48.56µs ± 0%9.20µs ± 0%+7.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0256-49.30µs ± 0%11.21µs ± 0%+20.52%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0512-410.5µs ± 0%16.2µs ± 0%+54.81%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:1024-414.1µs ± 0%20.3µs ± 0%+43.69%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0064-484.2µs ± 0%113.2µs ± 0%+34.43%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0128-495.3µs ± 0%109.3µs ± 0%+14.66%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0256-493.1µs ± 0%120.7µs ± 0%+29.59%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0512-4113µs ± 0%168µs ± 0%+48.90%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:1024-4145µs ± 0%192µs ± 0%+32.46%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0064-4124µs ± 0%137µs ± 0%+10.60%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0128-4124µs ± 0%139µs ± 0%+11.57%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0256-4124µs ± 0%149µs ± 0%+20.24%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0512-4131µs ± 0%144µs ± 0%+9.91%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:1024-4127µs ± 0%145µs ± 0%+13.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0064-41.28ms ± 0%1.33ms ± 0%+3.76%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0128-41.20ms ± 0%1.40ms ± 0%+17.44%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0256-41.19ms ± 0%1.41ms ± 0%+17.86%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0512-41.32ms ± 0%1.60ms ± 0%+21.20%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:1024-41.33ms ± 0%1.53ms ± 0%+14.56%(p=1.000 n=1+1)
 

@orpheuslummis
Copy link
Contributor Author

I suggest that integrating man page generation in packaging for specific systems to be implemented in future PRs.

fredcarle
fredcarle requested changes Jun 3, 2022
View reviewed changes
Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

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

Nice little utility :)

I would like to suggest moving this to /cmd/genman. The Go convention is to put command line tools/utils/apps under the cmd package. See https://github.com/kubernetes/kubernetes as an example.

@fredcarle
Copy link
Collaborator

thought: Currently we ignore build/defradb* so if we run genman, it will show up in git changes. It might be a good idea to change build/defradb* to build/*.

@orpheuslummis
Copy link
Contributor Author

Merci @fredcarle

@source-devs
Copy link

Benchmark Results

Summary

  • 113 Benchmarks successfully compared.
  • 1 Benchmarks were ✅ Better.
  • 112 Benchmarks were ❌ Worse .
  • 0 Benchmarks were ✨ Unchanged.
✅ See Better Results...
time/opdelta
_Collection_UserSimple_Read_Sync_10_10-4368µs ± 0%358µs ± 0%−2.53%(p=1.000 n=1+1)
 
❌ See Worse Results...
time/opdelta
_Collection_UserSimple_CreateMany_Sync_0_100-4222ms ± 0%290ms ± 0%+30.58%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_10-49.92ms ± 0%14.04ms ± 0%+41.53%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_100-4100ms ± 0%137ms ± 0%+37.53%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_1000-41.02s ± 0%1.27s ± 0%+24.84%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_100-445.7ms ± 0%50.4ms ± 0%+10.14%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_1000-4453ms ± 0%468ms ± 0%+3.33%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_10000-44.73s ± 0%4.80s ± 0%+1.36%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_100_100-43.97ms ± 0%4.21ms ± 0%+6.15%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_1000-441.2ms ± 0%47.3ms ± 0%+14.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_10-4361µs ± 0%378µs ± 0%+4.57%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_100-43.70ms ± 0%4.52ms ± 0%+22.22%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_10_10-4248µs ± 0%336µs ± 0%+35.44%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_100_100-41.76ms ± 0%1.96ms ± 0%+11.63%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_1000-423.6ms ± 0%24.4ms ± 0%+3.41%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_10-4260µs ± 0%276µs ± 0%+6.11%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_100-41.87ms ± 0%1.98ms ± 0%+5.61%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_100-41.17ms ± 0%1.45ms ± 0%+24.60%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_1000-49.94ms ± 0%10.55ms ± 0%+6.14%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_10-4422µs ± 0%501µs ± 0%+18.84%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_100-41.28ms ± 0%1.57ms ± 0%+22.26%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_1000-410.1ms ± 0%10.8ms ± 0%+6.40%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_10-4375µs ± 0%479µs ± 0%+27.89%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_100-4430µs ± 0%546µs ± 0%+26.86%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_1000-4428µs ± 0%448µs ± 0%+4.74%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_10-4641µs ± 0%738µs ± 0%+15.02%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_100-4638µs ± 0%735µs ± 0%+15.11%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_1000-4637µs ± 0%660µs ± 0%+3.69%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_10-4270µs ± 0%318µs ± 0%+17.92%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_100-4273µs ± 0%312µs ± 0%+14.50%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_1000-4272µs ± 0%279µs ± 0%+2.55%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_10-4402µs ± 0%466µs ± 0%+15.82%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_100-41.39ms ± 0%1.44ms ± 0%+3.27%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_1000-412.2ms ± 0%12.9ms ± 0%+5.35%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0128-413.1µs ± 0%15.0µs ± 0%+14.48%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0256-413.6µs ± 0%14.6µs ± 0%+7.82%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0512-415.4µs ± 0%16.7µs ± 0%+8.93%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:1024-419.0µs ± 0%21.8µs ± 0%+14.49%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0064-4133µs ± 0%156µs ± 0%+17.61%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0128-4125µs ± 0%162µs ± 0%+29.29%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0256-4136µs ± 0%217µs ± 0%+59.30%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0512-4152µs ± 0%193µs ± 0%+26.99%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:1024-4189µs ± 0%256µs ± 0%+35.09%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0064-414.9µs ± 0%19.2µs ± 0%+28.99%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0128-414.9µs ± 0%20.8µs ± 0%+39.43%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0256-416.2µs ± 0%18.0µs ± 0%+10.82%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0512-417.5µs ± 0%20.1µs ± 0%+14.93%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:1024-420.4µs ± 0%30.4µs ± 0%+49.26%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0064-4134µs ± 0%174µs ± 0%+30.42%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0128-4142µs ± 0%183µs ± 0%+29.20%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0256-4146µs ± 0%210µs ± 0%+44.33%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0512-4160µs ± 0%197µs ± 0%+23.09%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:1024-4199µs ± 0%234µs ± 0%+17.99%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0064-443.9µs ± 0%61.5µs ± 0%+40.09%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0128-447.6µs ± 0%55.9µs ± 0%+17.45%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0256-446.3µs ± 0%63.8µs ± 0%+37.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0512-452.5µs ± 0%67.6µs ± 0%+28.73%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:1024-466.0µs ± 0%82.6µs ± 0%+25.15%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0064-4350µs ± 0%425µs ± 0%+21.40%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0128-4352µs ± 0%465µs ± 0%+32.13%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0256-4371µs ± 0%459µs ± 0%+23.84%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0512-4406µs ± 0%494µs ± 0%+21.59%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:1024-4498µs ± 0%539µs ± 0%+8.28%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0064-442.7µs ± 0%56.9µs ± 0%+33.18%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0128-444.2µs ± 0%55.6µs ± 0%+25.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0256-446.3µs ± 0%61.4µs ± 0%+32.60%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0512-453.2µs ± 0%61.6µs ± 0%+15.83%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:1024-467.2µs ± 0%72.6µs ± 0%+8.07%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0064-4344µs ± 0%430µs ± 0%+25.20%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0128-4350µs ± 0%499µs ± 0%+42.47%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0256-4364µs ± 0%435µs ± 0%+19.46%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0512-4409µs ± 0%662µs ± 0%+61.61%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:1024-4476µs ± 0%658µs ± 0%+38.23%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0064-4117µs ± 0%161µs ± 0%+37.87%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0128-4117µs ± 0%144µs ± 0%+22.94%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0256-4120µs ± 0%154µs ± 0%+27.99%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0512-4123µs ± 0%167µs ± 0%+35.78%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:1024-4138µs ± 0%182µs ± 0%+31.66%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0064-41.18ms ± 0%1.37ms ± 0%+16.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0128-41.18ms ± 0%1.44ms ± 0%+22.06%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0256-41.21ms ± 0%1.49ms ± 0%+23.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0512-41.28ms ± 0%1.37ms ± 0%+7.16%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:1024-41.41ms ± 0%1.59ms ± 0%+12.88%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0064-4113µs ± 0%123µs ± 0%+9.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0128-4115µs ± 0%131µs ± 0%+14.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0256-4116µs ± 0%131µs ± 0%+13.15%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0512-4119µs ± 0%145µs ± 0%+22.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:1024-4131µs ± 0%168µs ± 0%+28.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0064-41.13ms ± 0%1.35ms ± 0%+19.51%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0128-41.14ms ± 0%1.35ms ± 0%+18.32%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0256-41.18ms ± 0%1.39ms ± 0%+17.64%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0512-41.21ms ± 0%1.33ms ± 0%+10.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:1024-41.35ms ± 0%1.59ms ± 0%+17.50%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0064-48.79µs ± 0%9.41µs ± 0%+7.13%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0128-48.71µs ± 0%10.32µs ± 0%+18.53%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0256-49.49µs ± 0%12.69µs ± 0%+33.63%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0512-411.1µs ± 0%15.2µs ± 0%+36.42%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:1024-414.4µs ± 0%18.5µs ± 0%+27.93%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0064-488.4µs ± 0%107.2µs ± 0%+21.30%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0128-490.5µs ± 0%116.1µs ± 0%+28.31%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0256-4102µs ± 0%117µs ± 0%+14.65%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0512-4115µs ± 0%125µs ± 0%+8.21%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:1024-4145µs ± 0%190µs ± 0%+30.50%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0064-4121µs ± 0%137µs ± 0%+13.60%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0128-4120µs ± 0%142µs ± 0%+18.46%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0256-4126µs ± 0%135µs ± 0%+7.01%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0512-4120µs ± 0%135µs ± 0%+12.86%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:1024-4130µs ± 0%164µs ± 0%+26.15%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0064-41.19ms ± 0%1.36ms ± 0%+13.84%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0128-41.18ms ± 0%1.35ms ± 0%+15.03%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0256-41.21ms ± 0%1.51ms ± 0%+25.04%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0512-41.26ms ± 0%1.59ms ± 0%+26.82%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:1024-41.30ms ± 0%1.53ms ± 0%+17.68%(p=1.000 n=1+1)
 
✨ See Unchanged Results...
time/opdelta
 
🐋 See Full Results...
develop.txtcurrent.txt
time/opdelta
pkg:collection goos:linux goarch:amd64
_Collection_UserSimple_CreateMany_Sync_0_10-411.2ms ± 0%11.7ms ± 0%+4.94%(p=1.000 n=1+1)
_Collection_UserSimple_CreateMany_Sync_0_100-4222ms ± 0%290ms ± 0%+30.58%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_10-49.92ms ± 0%14.04ms ± 0%+41.53%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_100-4100ms ± 0%137ms ± 0%+37.53%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Sync_0_1000-41.02s ± 0%1.27s ± 0%+24.84%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_100-445.7ms ± 0%50.4ms ± 0%+10.14%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_1000-4453ms ± 0%468ms ± 0%+3.33%(p=1.000 n=1+1)
_Collection_UserSimple_Create_Async_0_10000-44.73s ± 0%4.80s ± 0%+1.36%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_10_10-4368µs ± 0%358µs ± 0%−2.53%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_100_100-43.97ms ± 0%4.21ms ± 0%+6.15%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_1000-441.2ms ± 0%47.3ms ± 0%+14.83%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_10-4361µs ± 0%378µs ± 0%+4.57%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Sync_1000_100-43.70ms ± 0%4.52ms ± 0%+22.22%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_10_10-4248µs ± 0%336µs ± 0%+35.44%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_100_100-41.76ms ± 0%1.96ms ± 0%+11.63%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_1000-423.6ms ± 0%24.4ms ± 0%+3.41%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_10-4260µs ± 0%276µs ± 0%+6.11%(p=1.000 n=1+1)
_Collection_UserSimple_Read_Async_1000_100-41.87ms ± 0%1.98ms ± 0%+5.61%(p=1.000 n=1+1)
pkg:query/simple goos:linux goarch:amd64
_Query_UserSimple_Query_Sync_10-4341µs ± 0%396µs ± 0%+16.02%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_100-41.17ms ± 0%1.45ms ± 0%+24.60%(p=1.000 n=1+1)
_Query_UserSimple_Query_Sync_1000-49.94ms ± 0%10.55ms ± 0%+6.14%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_10-4422µs ± 0%501µs ± 0%+18.84%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_100-41.28ms ± 0%1.57ms ± 0%+22.26%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithFilter_Sync_1000-410.1ms ± 0%10.8ms ± 0%+6.40%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_10-4375µs ± 0%479µs ± 0%+27.89%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_100-4430µs ± 0%546µs ± 0%+26.86%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithLimitOffset_Sync_1000-4428µs ± 0%448µs ± 0%+4.74%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_10-4641µs ± 0%738µs ± 0%+15.02%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_100-4638µs ± 0%735µs ± 0%+15.11%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithMultiLookup_Sync_1000-4637µs ± 0%660µs ± 0%+3.69%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_10-4270µs ± 0%318µs ± 0%+17.92%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_100-4273µs ± 0%312µs ± 0%+14.50%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSingleLookup_Sync_1000-4272µs ± 0%279µs ± 0%+2.55%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_10-4402µs ± 0%466µs ± 0%+15.82%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_100-41.39ms ± 0%1.44ms ± 0%+3.27%(p=1.000 n=1+1)
_Query_UserSimple_Query_WithSort_Sync_1000-412.2ms ± 0%12.9ms ± 0%+5.35%(p=1.000 n=1+1)
pkg:storage goos:linux goarch:amd64
_Storage_Simple_Read_Sync_1_10/ValueSize:0064-412.2µs ± 0%16.1µs ± 0%+32.55%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0128-413.1µs ± 0%15.0µs ± 0%+14.48%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0256-413.6µs ± 0%14.6µs ± 0%+7.82%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:0512-415.4µs ± 0%16.7µs ± 0%+8.93%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_10/ValueSize:1024-419.0µs ± 0%21.8µs ± 0%+14.49%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0064-4133µs ± 0%156µs ± 0%+17.61%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0128-4125µs ± 0%162µs ± 0%+29.29%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0256-4136µs ± 0%217µs ± 0%+59.30%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:0512-4152µs ± 0%193µs ± 0%+26.99%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_1_100/ValueSize:1024-4189µs ± 0%256µs ± 0%+35.09%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0064-414.9µs ± 0%19.2µs ± 0%+28.99%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0128-414.9µs ± 0%20.8µs ± 0%+39.43%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0256-416.2µs ± 0%18.0µs ± 0%+10.82%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:0512-417.5µs ± 0%20.1µs ± 0%+14.93%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_10/ValueSize:1024-420.4µs ± 0%30.4µs ± 0%+49.26%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0064-4134µs ± 0%174µs ± 0%+30.42%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0128-4142µs ± 0%183µs ± 0%+29.20%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0256-4146µs ± 0%210µs ± 0%+44.33%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:0512-4160µs ± 0%197µs ± 0%+23.09%(p=1.000 n=1+1)
_Storage_Simple_Read_Sync_100_100/ValueSize:1024-4199µs ± 0%234µs ± 0%+17.99%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0064-443.9µs ± 0%61.5µs ± 0%+40.09%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0128-447.6µs ± 0%55.9µs ± 0%+17.45%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0256-446.3µs ± 0%63.8µs ± 0%+37.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:0512-452.5µs ± 0%67.6µs ± 0%+28.73%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_10/ValueSize:1024-466.0µs ± 0%82.6µs ± 0%+25.15%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0064-4350µs ± 0%425µs ± 0%+21.40%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0128-4352µs ± 0%465µs ± 0%+32.13%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0256-4371µs ± 0%459µs ± 0%+23.84%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:0512-4406µs ± 0%494µs ± 0%+21.59%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_0_100/ValueSize:1024-4498µs ± 0%539µs ± 0%+8.28%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0064-442.7µs ± 0%56.9µs ± 0%+33.18%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0128-444.2µs ± 0%55.6µs ± 0%+25.97%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0256-446.3µs ± 0%61.4µs ± 0%+32.60%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:0512-453.2µs ± 0%61.6µs ± 0%+15.83%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_10/ValueSize:1024-467.2µs ± 0%72.6µs ± 0%+8.07%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0064-4344µs ± 0%430µs ± 0%+25.20%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0128-4350µs ± 0%499µs ± 0%+42.47%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0256-4364µs ± 0%435µs ± 0%+19.46%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:0512-4409µs ± 0%662µs ± 0%+61.61%(p=1.000 n=1+1)
_Storage_Simple_WriteMany_Sync_100_100/ValueSize:1024-4476µs ± 0%658µs ± 0%+38.23%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0064-4117µs ± 0%161µs ± 0%+37.87%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0128-4117µs ± 0%144µs ± 0%+22.94%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0256-4120µs ± 0%154µs ± 0%+27.99%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:0512-4123µs ± 0%167µs ± 0%+35.78%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_10/ValueSize:1024-4138µs ± 0%182µs ± 0%+31.66%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0064-41.18ms ± 0%1.37ms ± 0%+16.34%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0128-41.18ms ± 0%1.44ms ± 0%+22.06%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0256-41.21ms ± 0%1.49ms ± 0%+23.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:0512-41.28ms ± 0%1.37ms ± 0%+7.16%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_0_100/ValueSize:1024-41.41ms ± 0%1.59ms ± 0%+12.88%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0064-4113µs ± 0%123µs ± 0%+9.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0128-4115µs ± 0%131µs ± 0%+14.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0256-4116µs ± 0%131µs ± 0%+13.15%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:0512-4119µs ± 0%145µs ± 0%+22.12%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_10/ValueSize:1024-4131µs ± 0%168µs ± 0%+28.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0064-41.13ms ± 0%1.35ms ± 0%+19.51%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0128-41.14ms ± 0%1.35ms ± 0%+18.32%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0256-41.18ms ± 0%1.39ms ± 0%+17.64%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:0512-41.21ms ± 0%1.33ms ± 0%+10.24%(p=1.000 n=1+1)
_Storage_Simple_Write_Sync_100_100/ValueSize:1024-41.35ms ± 0%1.59ms ± 0%+17.50%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0064-48.79µs ± 0%9.41µs ± 0%+7.13%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0128-48.71µs ± 0%10.32µs ± 0%+18.53%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0256-49.49µs ± 0%12.69µs ± 0%+33.63%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:0512-411.1µs ± 0%15.2µs ± 0%+36.42%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_10_10/ValueSize:1024-414.4µs ± 0%18.5µs ± 0%+27.93%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0064-488.4µs ± 0%107.2µs ± 0%+21.30%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0128-490.5µs ± 0%116.1µs ± 0%+28.31%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0256-4102µs ± 0%117µs ± 0%+14.65%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:0512-4115µs ± 0%125µs ± 0%+8.21%(p=1.000 n=1+1)
_Storage_Simple_Txn_Read_Sync_100_100/ValueSize:1024-4145µs ± 0%190µs ± 0%+30.50%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0064-4121µs ± 0%137µs ± 0%+13.60%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0128-4120µs ± 0%142µs ± 0%+18.46%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0256-4126µs ± 0%135µs ± 0%+7.01%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:0512-4120µs ± 0%135µs ± 0%+12.86%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_10_1_10/ValueSize:1024-4130µs ± 0%164µs ± 0%+26.15%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0064-41.19ms ± 0%1.36ms ± 0%+13.84%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0128-41.18ms ± 0%1.35ms ± 0%+15.03%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0256-41.21ms ± 0%1.51ms ± 0%+25.04%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:0512-41.26ms ± 0%1.59ms ± 0%+26.82%(p=1.000 n=1+1)
_Storage_Simple_Txn_Iterator_Sync_100_1_100/ValueSize:1024-41.30ms ± 0%1.53ms ± 0%+17.68%(p=1.000 n=1+1)
 

@orpheuslummis
Copy link
Contributor Author

This is now waiting for #501

@orpheuslummis orpheuslummis added the action/no-benchmark Skips the action that runs the benchmark. label Jun 6, 2022
shahzadlone
shahzadlone reviewed Jun 6, 2022
View reviewed changes
Makefile Outdated Show resolved Hide resolved
cli/defradb/cmd/genman.go Outdated Show resolved Hide resolved
cli/defradb/cmd/genman.go Outdated Show resolved Hide resolved
@orpheuslummis
Copy link
Contributor Author

This PR is as follows now:

  • Introduces the genmanpages utility that simply generates man pages and a modification to Makefile
  • make docs:manpages generates man pages to build/man/
  • make install:manpages on Linux copies man pages to /usr/share/man, otherwise errors
  • Generating and installing is done separately and not by default with make install

The reasoning:

  • go is usually installed user-locally, while man pages are installed system-globally. This implies that installing man pages requires root-type privileges while generating man pages requires using user-local go, so usually two different users need to perform the actions separately.
  • According to the Filesystem Hierarchy Standard https://www.pathname.com/fhs/pub/fhs-2.3.html#USRSHAREMANMANUALPAGES /usr/share/man/ is where man pages are conventionally - this is empirically true of macos, debian, arch linux, ...
  • On macos, copying man pages to /usr/share/man/man1/ results in "Operation not permitted" because of "System Integrity Protection", even though it's the standard path for man pages (as found by manpath).
  • A common alternative, such as what homebrew is doing, is to augment the user's MANPATH to include an alternative directory where man pages are installed. Systematically changing a user's MANPATH requires consent and is prone to error.
  • I suggest that later on, once we integrate with packaging systems (dpkg/apt, nix, brew, etc), we can more properly generate and install man pages.

Of course this is subject to change if there's a better path suggested.

  • optional TODO: when on linux and installing man pages not with root-type privileges, show error

Lodek
Lodek reviewed Jun 15, 2022
View reviewed changes
Copy link
Member

@Lodek Lodek left a comment

Choose a reason for hiding this comment

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

Looks awesome! Good job.

Not sure I should / can approve defra stuff but LGTM

@orpheuslummis
Copy link
Contributor Author

Looks awesome! Good job.

Not sure I should / can approve defra stuff but LGTM

In my opinion: It's reasonable for you to approve this as it's not deeply DefraDB-related and you probably have PR-related domain knowledge. Contribution boundaries for core devs are more guided by reason than by bureaucratical walls. That said, even though it is not an important change, I recommend to myself to only merge when most relevant stakeholders have approved, so in this case when a db-core team member will have approved and after some time has passed for possible criticism from the team to surface.

fredcarle
fredcarle approved these changes Jun 16, 2022
View reviewed changes
Copy link
Collaborator

@fredcarle fredcarle left a comment

Choose a reason for hiding this comment

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

LGTM 🤘

@shahzadlone
Copy link
Member

LGTM.

@orpheuslummis orpheuslummis merged commit bb08df0 into develop Jun 19, 2022
@orpheuslummis orpheuslummis deleted the orpheus/feat/cli-man-page branch June 19, 2022 10:51
shahzadlone pushed a commit to shahzadlone/defradb that referenced this pull request Feb 23, 2024
@orpheuslummis
chore: Add utility for generation of man pages (sourcenetwork#493)
1a3c9ca
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsimnz jsimnz jsimnz left review comments

@Lodek Lodek Lodek left review comments

@fredcarle fredcarle fredcarle approved these changes

@shahzadlone shahzadlone shahzadlone approved these changes

Assignees

@orpheuslummis orpheuslummis

Labels
action/no-benchmark Skips the action that runs the benchmark. area/cli Related to the CLI binary ci/build This is issue is about the build or CI system, and the administration of it.
Projects
None yet
Milestone
DefraDB v0.3
Development

Successfully merging this pull request may close these issues.

CLI: man pages
6 participants
@orpheuslummis @source-devs @fredcarle @shahzadlone @jsimnz @Lodek