Skip to content

Overview

This documentation is geared towards describing the structure of the HSE API and the specifics of each entry point's operation. Refer to https://hse-project.github.io for a conceptual overview of HSE.

Terminology

  • KVS - Key-value store, containing zero or more key-value pairs

  • KVDB - Key-value database, comprised of one or more KVSs and defining a transaction domain

  • key - A byte string used to uniquely identify values for storage, retrieval, and deletion in a KVS

  • segmented key - A key that is logically divided into N segments (N >= 2), arranged to group related key-value pairs when keys are sorted lexicographically

  • key prefix - For segmented keys, the first K segments (1 <= K < N)

  • key prefix length - The length of a key prefix (bytes)

Updated on 17 November 2022 at 15:10:57 CST