Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Add Documentation for Local Doxygen Use #1624

Merged
merged 4 commits into from
Aug 13, 2021
Merged

Add Documentation for Local Doxygen Use #1624

merged 4 commits into from
Aug 13, 2021

Conversation

turingcompl33t
Copy link
Contributor

I failed CI recently because my PR had a couple of undocumented APIs. This PR adds information on the Doxygen "target" to the top-level README to draw attention to this requirement.

@turingcompl33t turingcompl33t added feature Adds a requested feature ready-for-ci Indicate that this build should be run through CI. ready-for-review This PR passes all checks and is ready to be reviewed. Mark PRs with this. labels Jun 24, 2021
@noisepage-checks
Copy link

Minor Decrease in Performance

Be warned: this PR may have decreased the throughput of the system slightly.

tps (%change) benchmark_type wal_device details
2.04% tpcc RAM disk
Detailsmaster tps=22133.45, commit tps=22585.45, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=RAM disk, max_connection_threads=32
2.43% tpcc None
Detailsmaster tps=29366.47, commit tps=30079.86, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=None, max_connection_threads=32
-2.37% tpcc HDD
Detailsmaster tps=22297.92, commit tps=21769.4, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=HDD, max_connection_threads=32
5.79% tatp RAM disk
Detailsmaster tps=6470.69, commit tps=6845.17, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=RAM disk, max_connection_threads=32
-1.45% tatp None
Detailsmaster tps=7429.54, commit tps=7321.53, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=None, max_connection_threads=32
6.78% tatp HDD
Detailsmaster tps=6382.95, commit tps=6815.53, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=HDD, max_connection_threads=32

@codecov
Copy link

codecov bot commented Jun 24, 2021 •
edited
Loading

Codecov Report

Merging #1624 (cc24329) into master (25b264e) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1624      +/-   ##
==========================================
+ Coverage   81.11%   81.14%   +0.02%     
==========================================
  Files         761      761              
  Lines       55258    55258              
==========================================
+ Hits        44825    44838      +13     
+ Misses      10433    10420      -13
Impacted Files Coverage Δ
src/include/execution/sql/chaining_hash_table.h 91.91% <0.00%> (-1.02%) ⬇️
src/execution/sql/vector.cpp 85.76% <0.00%> (-0.34%) ⬇️
src/execution/sema/sema_builtin.cpp 60.45% <0.00%> (-0.18%) ⬇️
src/storage/arrow_serializer.cpp 86.87% <0.00%> (+0.62%) ⬆️
src/include/storage/index/bplustree.h 91.95% <0.00%> (+0.85%) ⬆️
src/catalog/database_catalog.cpp 93.71% <0.00%> (+0.96%) ⬆️
src/storage/index/hash_index.cpp 91.13% <0.00%> (+1.26%) ⬆️
src/include/common/container/concurrent_bitmap.h 93.33% <0.00%> (+1.66%) ⬆️
...lude/parser/expression/constant_value_expression.h 94.64% <0.00%> (+3.57%) ⬆️
src/include/metrics/query_trace_metric.h 96.61% <0.00%> (+6.77%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 25b264e...cc24329. Read the comment docs.

@noisepage-checks
Copy link

Performance Boost!

Nice job! This PR has increased the throughput of the system.

Could not find any performance results to compare for this commit.

1 similar comment
@noisepage-checks
Copy link

Performance Boost!

Nice job! This PR has increased the throughput of the system.

Could not find any performance results to compare for this commit.

@mbutrovich
Copy link
Contributor

It's in the old Pull Request Process wiki page that didn't get a corresponding entry in the doc folder. Do you think you could just bring that page over?

https://github.com/cmu-db/noisepage/wiki/Pull-Request-Process

@mbutrovich mbutrovich added in-progress This PR is being actively worked on and not ready to be reviewed or merged. Mark PRs with this. and removed ready-for-ci Indicate that this build should be run through CI. ready-for-review This PR passes all checks and is ready to be reviewed. Mark PRs with this. labels Jul 16, 2021
@turingcompl33t turingcompl33t added ready-for-review This PR passes all checks and is ready to be reviewed. Mark PRs with this. and removed in-progress This PR is being actively worked on and not ready to be reviewed or merged. Mark PRs with this. labels Aug 10, 2021
@turingcompl33t
Copy link
Contributor Author

It's in the old Pull Request Process wiki page that didn't get a corresponding entry in the doc folder. Do you think you could just bring that page over?

https://github.com/cmu-db/noisepage/wiki/Pull-Request-Process

This was a good call. I just brought over the PR process doc from the Wiki like Matt suggested and included the Doxygen command with the rest of the "before submitting your PR" content.

@turingcompl33t turingcompl33t added the ready-for-ci Indicate that this build should be run through CI. label Aug 13, 2021
@noisepage-checks
Copy link

Minor Decrease in Performance

Be warned: this PR may have decreased the throughput of the system slightly.

tps (%change) benchmark_type wal_device details
-0.43% tpcc RAM disk
Detailsmaster tps=23070.67, commit tps=22970.47, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=RAM disk, max_connection_threads=32
-2.59% tpcc None
Detailsmaster tps=30175.57, commit tps=29393.35, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=None, max_connection_threads=32
1.17% tpcc HDD
Detailsmaster tps=21604.76, commit tps=21858.03, query_mode=extended, benchmark_type=tpcc, scale_factor=32.0000, terminals=32, client_time=60, weights={'Payment': 43, 'Delivery': 4, 'NewOrder': 45, 'StockLevel': 4, 'OrderStatus': 4}, wal_device=HDD, max_connection_threads=32
4.35% tatp RAM disk
Detailsmaster tps=6501.3, commit tps=6784.41, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=RAM disk, max_connection_threads=32
0.45% tatp None
Detailsmaster tps=7233.86, commit tps=7266.67, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=None, max_connection_threads=32
6.49% tatp HDD
Detailsmaster tps=6262.88, commit tps=6669.39, query_mode=extended, benchmark_type=tatp, scale_factor=1.0000, terminals=16, client_time=60, weights={'GetAccessData': 35, 'UpdateLocation': 14, 'GetNewDestination': 10, 'GetSubscriberData': 35, 'DeleteCallForwarding': 2, 'InsertCallForwarding': 2, 'UpdateSubscriberData': 2}, wal_device=HDD, max_connection_threads=32

@mbutrovich mbutrovich merged commit 54036a8 into cmu-db:master Aug 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
No reviews
Assignees
No one assigned
Labels
feature Adds a requested feature ready-for-ci Indicate that this build should be run through CI. ready-for-review This PR passes all checks and is ready to be reviewed. Mark PRs with this.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@turingcompl33t @mbutrovich