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

Commit

Permalink
Merge pull request #1722 from pilosa/minor-docs-updates
Browse files Browse the repository at this point in the history
Minor docs updates
  • Loading branch information
alanbernstein committed Nov 6, 2018
2 parents 2ddde5f + 7e6a2e4 commit 2e7d44b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
11 changes: 5 additions & 6 deletions docs/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ nav = [
"Time Quantum",
"Attribute",
"Shard",
"View",
]
+++

Expand All @@ -26,7 +25,7 @@ Pilosa lays out data first in rows, so queries which get all the set bits in one

Please note that Pilosa is most performant when row and column IDs are sequential starting from 0. You can deviate from this to some degree, but setting a bit with column ID 2<sup>63</sup> on a single-node cluster, for example, will not work well due to memory limitations.

![basic data model diagram](/img/docs/data-model.svg)
![basic data model diagram](/img/docs/data-model.png)
*Basic data model diagram*

### Index
Expand Down Expand Up @@ -89,14 +88,14 @@ This is one major component of Pilosa's ability to combine relationships from mu

Ranked Fields maintain a sorted cache of column counts by Row ID (yielding the top rows by columns with a bit set in each). This cache facilitates the TopN query. The cache size defaults to 50,000 and can be set at Field creation.

![ranked field diagram](/img/docs/field-ranked.svg)
![ranked field diagram](/img/docs/field-ranked.png)
*Ranked field diagram*

#### LRU

The LRU cache maintains the most recently accessed Rows.

![lru field diagram](/img/docs/field-lru.svg)
![lru field diagram](/img/docs/field-lru.png)
*LRU field diagram*

### Time Quantum
Expand Down Expand Up @@ -161,7 +160,7 @@ Set(2, B=1)
Set(3, B=6)
```

![BSI field diagram](/img/docs/field-bsi.svg)
![BSI field diagram](/img/docs/field-bsi.png)
*BSI field diagram*

Check out this [blog post](/blog/range-encoded-bitmaps/) for some more details about BSI in Pilosa.
Expand All @@ -186,7 +185,7 @@ Set(3, A=8, 2017-05-18T00:00)
Set(3, A=8, 2017-05-19T00:00)
```

![time quantum field diagram](/img/docs/field-time-quantum.svg)
![time quantum field diagram](/img/docs/field-time-quantum.png)
*Time quantum fueld diagram*

#### Mutex
Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ nav = []

<strong id="topn">[TopN](../query-language/#topn):</strong> A [PQL](#pql) query that returns a list of rows, sorted by the count of [columns](#column) set in the [row](#row), within a specified [field](#field).

<strong id="view">[View](../data-model/#view):</strong> Views separate the different data layouts within a [Field](#field). The primary view is standard, which represents the typical [row](#row)/[column](#column) data. Time based field views are automatically generated for each [time quantum](#time-quantum). Views are internally managed by Pilosa, and never exposed directly via the API. This simplifies the functional interface by separating it from the physical data representation.
<strong id="view">View:</strong> Views separate the different data layouts within a [Field](#field). The primary view is standard, which represents the typical [row](#row)/[column](#column) data. Time based field views are automatically generated for each [time quantum](#time-quantum). Views are internally managed by Pilosa, and never exposed directly via the API. This simplifies the functional interface by separating it from the physical data representation.

0 comments on commit 2e7d44b

Please sign in to comment.