Skip to content

Commit

Permalink
Adjust docs for PR planetarium#1194
Browse files Browse the repository at this point in the history
  • Loading branch information
dahlia committed Apr 16, 2021
1 parent 2301630 commit 502d1e7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Released on March 30, 2021.
of the database, according to its epoch unit, which is its Unix timestamp.
Every epoch is divided by certain seconds, configured by `RocksDBStore()`
constructor's `txEpochUnitSeconds` and `blockEpochUnitSeconds` parameters
(86400 by default). [[#1183], [#1194]]
(86,400 by default). [[#1183], [#1194]]
- (Libplanet.RocksDBStore) Continue on partitioning of database,
`RocksDBStore()` is manage database connection by LRU Cache.
The max size of connection cache is configured by `RocksDBStore()`
Expand Down
13 changes: 7 additions & 6 deletions Libplanet.RocksDBStore/RocksDBStore.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@
namespace Libplanet.RocksDBStore
{
/// <summary>
/// The <a href="https://rocksdb.org/">RocksDB</a> <see cref="IStore"/> implementation.
/// This stores data in the RocksDB.
/// The <a href="https://rocksdb.org/">RocksDB</a> <see cref="IStore"/> implementation,
/// which is more production-ready than <see cref="DefaultStore"/>.
/// This stores data in the RocksDB with multiple partitions under the hood.
/// </summary>
/// <seealso cref="IStore"/>
public class RocksDBStore : BaseStore
Expand Down Expand Up @@ -76,10 +77,10 @@ public class RocksDBStore : BaseStore
/// option.</param>
/// <param name="maxLogFileSize">The number to configure <c>max_log_file_size</c>
/// RocksDB option.</param>
/// <param name="txEpochUnitSeconds">The number of Transaction to store in DB
/// for each epoch. 86400 by default.</param>
/// <param name="blockEpochUnitSeconds">The number of block to store in DB
/// for each epoch. 86400 by default.</param>
/// <param name="txEpochUnitSeconds">The interval between epochs of DB partions containing
/// transactions. 86,400 seconds by default.</param>
/// <param name="blockEpochUnitSeconds">The interval between epochs of DB partions
/// containing blocks. 86,400 seconds by default.</param>
/// <param name="dbConnectionCacheSize">The capacity of the block and transaction
/// RocksDB connection cache. 100 by default.</param>
public RocksDBStore(
Expand Down

0 comments on commit 502d1e7

Please sign in to comment.