[v17] MB-27666: Nested Fields

.github/workflows/tests.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ${{ matrix.platform }}
     steps:
     - name: Install Go
-      uses: actions/setup-go@v1
+      uses: actions/setup-go@v5
       with:
         go-version: ${{ matrix.go-version }}
     - name: Checkout code

build.go

@@ -24,7 +24,7 @@ import (
 	index "github.com/blevesearch/bleve_index_api"
 )
 
-const Version uint32 = 17
+const Version uint32 = 16
 
 const Type string = "zap"
 
@@ -170,6 +170,7 @@ func InitSegmentBase(mem []byte, memCRC uint32, chunkMode uint32, numDocs uint64
 		invIndexCache:       newInvertedIndexCache(),
 		vecIndexCache:       newVectorIndexCache(),
 		synIndexCache:       newSynonymIndexCache(),
+		nstIndexCache:       newNestedIndexCache(),
 		// following fields gets populated by loadFields
 		fieldsMap:     make(map[string]uint16),
 		fieldsOptions: make(map[string]index.FieldIndexingOptions),
@@ -189,5 +190,11 @@ func InitSegmentBase(mem []byte, memCRC uint32, chunkMode uint32, numDocs uint64
 		return nil, err
 	}
 
+	// initialize any of the caches if needed
+	err = sb.nstIndexCache.initialize(sb.numDocs, sb.getEdgeListOffset(), sb.mem)
+	if err != nil {
+		return nil, err
+	}
+
 	return sb, nil
 }

cmd/zap/cmd/edge.go

@@ -0,0 +1,76 @@
+//  Copyright (c) 2025 Couchbase, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 		http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cmd
+
+import (
+	"encoding/binary"
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+// edgeListCmd represents the edge command
+var edgeListCmd = &cobra.Command{
+	Use:   "edgeList",
+	Short: "prints the edge list for nested documents",
+	Long:  `The edgeList command will print the edge list for nested documents in the segment.`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		edgeListAddr, err := segment.EdgeListAddr()
+		if err != nil {
+			return fmt.Errorf("error getting edge list: %v", err)
+		}
+		data := segment.Data()
+		// read edge list
+		// pos stores the current read position
+		pos := edgeListAddr
+		// read number of nested documents which is also the number of edges
+		numEdges, read := binary.Uvarint(data[pos : pos+binary.MaxVarintLen64])
+		if read <= 0 {
+			return fmt.Errorf("error reading number of edges in nested edge list")
+		}
+		pos += uint64(read)
+		// if no edges or no nested documents, return
+		if numEdges == 0 {
+			fmt.Println("no nested documents present")
+			return nil
+		}
+		// edgeList as a map[node]parent
+		edgeList := make(map[uint64]uint64, numEdges)
+		for i := uint64(0); i < numEdges; i++ {
+			child, read := binary.Uvarint(data[pos : pos+binary.MaxVarintLen64])
+			if read <= 0 {
+				return fmt.Errorf("error reading child doc id in nested edge list")
+			}
+			pos += uint64(read)
+			parent, read := binary.Uvarint(data[pos : pos+binary.MaxVarintLen64])
+			if read <= 0 {
+				return fmt.Errorf("error reading parent doc id in nested edge list")
+			}
+			pos += uint64(read)
+			edgeList[child] = parent
+		}
+		// print number of edges / nested documents
+		fmt.Printf("number of edges / nested documents: %d\n", len(edgeList))
+		fmt.Printf("child document number -> parent document number\n")
+		for child, parent := range edgeList {
+			fmt.Printf("%d -> %d\n", child, parent)
+		}
+		return nil
+	},
+}
+
+func init() {
+	RootCmd.AddCommand(edgeListCmd)
+}