github.com/dolthub/dolt/go@v0.40.5-0.20240520175717-68db7794bea6/store/val/doc.go (about)

     1  // Copyright 2021 Dolthub, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  /*
    16  Package val includes:
    17    - Serialization between flatbuffer byte encodings and runtime Go-types
    18    - Tuple interfaces that support lazy access to specific row fields
    19  
    20  Node key and value pairs are written as Tuples. Fields in tuples move to
    21  and from disk using the Encoding types embedded in TupleDesc companions.
    22  There are mappings between Dolt-side Encoding and SQL-side types, and only
    23  Encoding operates at the NodeStore layer. Refer to val/codec.go for more
    24  details.
    25  
    26  The main feature of the new flatbuffer format is that individual fields can be
    27  written and accessed directly via offsets, removing the need to materialize
    28  entire tuples prior to SQL exec operations.
    29  */
    30  package val