github.com/m3db/m3@v1.5.0/src/m3ninx/generated/proto/fswriter/fswriter.proto (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  syntax = "proto3";
    22  package fswriter;
    23  
    24  enum SegmentType {
    25    FST_SEGMENT_TYPE = 0;
    26  }
    27  
    28  enum FSTSegmentFileType {
    29    DOCUMENTS_INDEX     = 0;
    30    DOCUMENTS_DATA      = 1;
    31    POSTINGS_DATA       = 2;
    32    FST_TERMS           = 3;
    33    FST_FIELDS          = 4;
    34  }
    35  
    36  enum PostingsFormat {
    37    PILOSAV1_POSTINGS_FORMAT = 0;
    38  }
    39  
    40  message Metadata {
    41    PostingsFormat postingsFormat = 1;
    42    int64          numDocs        = 2;
    43  }
    44  
    45  // additional metadata stored per Field in the corpus.
    46  message FieldData {
    47    // postingsOffset for the pl corresponding to the union of all documents
    48    // which have a given field.
    49    uint64 fieldPostingsListOffset = 1;
    50  }