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.

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

docs: fix grammar #135

Merged
merged 1 commit into from Aug 7, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/admin/anticache.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sophia implements the mode by introducing so-called index *Temperature*. The Tem
are the most frequently accessed for read (hot). These nodes are periodically elected and promoted to
be put **in-memory**. Previously elected nodes are unloaded if they do not fit into memory limit.

Following variable can be set to enable anti-cache mode and set the memory limit: **db.database_name.storage**
Following variables can be set to enable anti-cache mode and set the memory limit: **db.database_name.storage**
and **memory.anticache**.

```C
Expand Down
2 changes: 1 addition & 1 deletion documentation/admin/backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ examined to see if backup process is in progress or being succesfully completed.

Additionally, **scheduler.event\_on\_backup** can be enabled
which will result in asynchronous notifications using **scheduler.on\_event** function and
[sp_poll()](../api/sp_poll.md). This might be helpful for a *event loop* integration.
[sp_poll()](../api/sp_poll.md). This might be helpful for an *event loop* integration.

Backups being made as a part of a common database workflow. It is possible to change backup
priorities using [compaction redzone](../conf/compaction.md) settings.
Expand Down
4 changes: 2 additions & 2 deletions documentation/admin/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ another one or more databases. Caching database is used to store records
which are read from main database. Caching database can be placed in [RAM](ram.md) or
Flash, while main database can be stored on HDD. Caching database has the same storage
format as a main database, it is also involved in [Compaction](compaction.md).
It must has an exact index [keys types](database.md) as the main database.
It must have an exact index [keys types](database.md) as the main database.

Following variable can be set to put a database into a cache mode:
**db.database_name.cache_mode**. To assign a caching database for main database
Expand Down Expand Up @@ -92,5 +92,5 @@ Cursor operation [sp\_cursor()](../api/sp_cursor.md) does not use caching databa
can separately be used with caching or main database.

*Please note*: since [sp\_get()](../api/sp_get.md) statements are not involved in Write-Ahead Log,
some of a latest updates may be lost in cache database after recovery. These are records
some of the latest updates may be lost in cache database after recovery. These are records
which yet remain in-memory and yet being dumped to disk by compaction.
2 changes: 1 addition & 1 deletion documentation/conf/compaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Compaction
|---|---|---|
| compaction.redzone | int | To create a new redzone, write a percent value into *compaction* namespace. |
| compaction.redzone.mode | int | Set compaction mode. Mode 1: branch-less mode (strict 2-level storage), 2: checkpoint, 3: branch + compaction (default). |
| compaction.redzone.compact\_wm | int | Compaction operation starts when a number of node branches reaches this watermark. Cant be less than two. |
| compaction.redzone.compact\_wm | int | Compaction operation starts when a number of node branches reaches this watermark. Cannot be less than two. |
| compaction.redzone.compact\_mode | int | Set read-intensive or write-intensive compaction strategy mode. 0 - by number of branches, 1 - by temperature. |
| compaction.redzone.branch\_prio | int | Priority of branch operation. Priority is measured by a maximum number of executing workers. |
| compaction.redzone.branch\_wm | int | Branch operation starts when a size of in-memory key index reaches this watermark value. Measured in bytes. |
Expand Down
8 changes: 4 additions & 4 deletions documentation/conf/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Performance
| performance.cursor\_read\_disk | string, ro | Average disk reads by Cursor operation. |
| performance.cursor\_read\_cache | string, ro | Average cache reads by Cursor operation. |
| performance.cursor\_ops | string, ro | Average number of keys read by Cursor operation. |
| performance.req\_queue | int, ro | Number of waiting request in async queue. |
| performance.req\_ready | int, ro | Number of ready request in async queue. |
| performance.req\_active | int, ro | Number of active request in async queue. |
| performance.reqs | int, ro | Current number of request in async queue. |
| performance.req\_queue | int, ro | Number of waiting requests in async queue. |
| performance.req\_ready | int, ro | Number of ready requests in async queue. |
| performance.req\_active | int, ro | Number of active requests in async queue. |
| performance.reqs | int, ro | Current number of requests in async queue. |
6 changes: 3 additions & 3 deletions documentation/conf/scheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Scheduler
| scheduler.threads | int | Set a number of worker threads. |
| scheduler.id.trace | string, ro | Get a worker trace. |
| scheduler.zone | int, ro | Currently active compaction redzone. |
| scheduler.checkpoint\_active | int,ro | Shows if checkpoint operation is in progress. |
| scheduler.checkpoint\_active | int, ro | Shows if checkpoint operation is in progress. |
| scheduler.checkpoint\_lsn | int, ro | LSN of currently active checkpoint operation. |
| scheduler.checkpoint\_lsn\_last | int, ro | LSN of the last completed checkpoint operation. |
| scheduler.checkpoint | function | Force to start background checkpoint. Does not block. |
| scheduler.anticache\_active | int,ro | Shows if anti-cache operation is in progress. |
| scheduler.anticache\_active | int, ro | Shows if anti-cache operation is in progress. |
| scheduler.anticache\_asn | int, ro | ASN of currently active anti-cache operation. |
| scheduler.anticache\_asn\_last | int, ro | ASN of the last completed Anti-Cache operation. |
| scheduler.anticache | function | Force to start background anti-cache. Does not block. |
| scheduler.snapshot\_active | int,ro | Shows if snapshot operation is in progress. |
| scheduler.snapshot\_active | int, ro | Shows if snapshot operation is in progress. |
| scheduler.snapshot\_ssn | int, ro | SSN of currently active snapshot operation. |
| scheduler.snapshot\_ssn\_last | int, ro | SSN of the last completed snapshot operation. |
| scheduler.snapshot | function | Force to start background snapshot operation. Does not block. |
Expand Down
4 changes: 2 additions & 2 deletions documentation/tutorial/how_it_works.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ performed in following structures:
3. each node branch: strictly starting from the last one

Branch format is highly optimized to reduce disk access during reads. Internally each
Branch consist of **Region Index** and **Sorted Regions**.
Branch consists of **Region Index** and **Sorted Regions**.

So basically, this structures splits whole Branch range of keys into smaller
So basically, these structures split whole Branch range of keys into smaller
regions. Region Index holds information about every Regions stored in the
Branch, their min/max values and meta-data.

Expand Down