From 04b17847ceac18f28f4b9d69950a7a90ef3892fd Mon Sep 17 00:00:00 2001 From: Alan Bernstein Date: Tue, 6 Mar 2018 18:14:22 -0600 Subject: [PATCH] Clean up glossary --- docs/glossary.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/glossary.md b/docs/glossary.md index 50906a0cf..998bda86b 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -20,9 +20,7 @@ nav = [] Attribute: Attributes can be associated to both rows and columns. This metadata is kept separately from the core binary matrix in a BoltDB store. -PQL: Pilosa Query Language - -Index: The Index represents a data namespace. +PQL: [Pilosa Query Language](/docs/query-language). Frame: Frames are used to segment rows into different categories - row ids are namespaced by frame such that the same row id in a different frame refers to a different row. For Ranked frames, rows are kept in sorted order within the frame. @@ -38,7 +36,7 @@ nav = [] Anti-entropy: A periodic process that compares each slice and its replicas across the cluster to repair inconsistencies. -Node: An individual running instance of Pilosa server which belongs to a cluster. +Node: An individual running instance of Pilosa server which belongs to a cluster. Cluster: A cluster consists of one or more nodes which share a cluster configuration. The cluster also defines how data is replicated throughout and how internode communication is coordinated. Pilosa does not have a leader node, all data is evenly distributed, and any node can respond to queries. @@ -46,13 +44,12 @@ nav = [] Tanimoto: Used for similarity queries on Pilosa data. The Tanimoto Coefficient is the ratio of the intersecting set to the union set as the measure of similarity. -Protobuf:: [Protocol Buffers](https://developers.google.com/protocol-buffers/) is a binary serialization format which Pilosa uses for internal messages, and can be used by clients as an alternative to JSON. +Protobuf: [Protocol Buffers](https://developers.google.com/protocol-buffers/) is a binary serialization format which Pilosa uses for internal messages, and can be used by clients as an alternative to JSON. TOML: We use [TOML](https://github.com/toml-lang/toml) for our configuration file format. -Jump Consistent Hash: A fast, minimal memory, consistent hash algorithm that evenly distributes the workload even when the number of buckets changes. -https://arxiv.org/pdf/1406.2294v1.pdf +Jump Consistent Hash: A fast, minimal memory, [consistent hash algorithm](https://arxiv.org/pdf/1406.2294v1.pdf) that evenly distributes the workload even when the number of buckets changes. -Partition: The consistent hash is compiled with a maximum number of partitions or locations on the unit circle that keys are mapped to. Partitions are then evenly mapped to physical nodes. To add nodes to the cluster you simply need to remap the partitions, and associated data across the new cluster topography. +Partition: The consistent hash is compiled with a maximum number of partitions or locations on the unit circle that keys are mapped to. Partitions are then evenly mapped to physical nodes. To add nodes to the cluster you simply need to remap the partitions, and associate data across the new cluster topography. -Replica: A copy of a [fragment] on a different host from the original. The "cluster.replicas" configuration parameter determines how many replicas of a fragment exist in the cluster (including the original, so a value of 1 means no extra copies are made). +Replica: A copy of a [fragment](#fragment) on a different host from the original. The "cluster.replicas" configuration parameter determines how many replicas of a fragment exist in the cluster (including the original, so a value of 1 means no extra copies are made).