github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/kv/kvclient/kvcoord/doc.go (about)

     1  // Copyright 2014 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  /*
    12  Package kvcoord provides a key-value API to an underlying cockroach
    13  datastore. Cockroach itself provides a single, monolithic, sorted key
    14  value map, distributed over multiple nodes. Each node holds a set of
    15  key ranges. Package kv translates between the monolithic, logical map
    16  which Cockroach clients experience to the physically distributed key
    17  ranges which comprise the whole.
    18  
    19  Package kv implements the logic necessary to locate appropriate nodes
    20  based on keys being read or written. In some cases, requests may span
    21  a range of keys, in which case multiple RPCs may be sent out.
    22  */
    23  package kvcoord