collection_keys.go

// Copyright 2022 Democratized Data Foundation
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.

package base

import (
	"fmt"

	"github.com/sourcenetwork/defradb/client"
	"github.com/sourcenetwork/defradb/core"
	"github.com/sourcenetwork/defradb/errors"
)

// MakeIndexPrefix generates a key prefix for the given collection/index descriptions
func MakeCollectionKey(col client.CollectionDescription) core.DataStoreKey {
	return core.DataStoreKey{
		CollectionId: col.IDString(),
	}
}

// MakeIndexKey generates a key for the target dockey, using the collection/index description
func MakeDocKey(col client.CollectionDescription, docKey string) core.DataStoreKey {
	return core.DataStoreKey{
		CollectionId: col.IDString(),
		DocKey:       docKey,
	}
}

func MakePrimaryIndexKeyForCRDT(
	c client.CollectionDescription,
	ctype client.CType,
	key core.DataStoreKey,
	fieldName string,
) (core.DataStoreKey, error) {
	switch ctype {
	case client.COMPOSITE:
		return MakeCollectionKey(c).WithInstanceInfo(key).WithFieldId(core.COMPOSITE_NAMESPACE), nil
	case client.LWW_REGISTER:
		fieldKey := getFieldKey(c, key, fieldName)
		return MakeCollectionKey(c).WithInstanceInfo(fieldKey), nil
	}
	return core.DataStoreKey{}, errors.New("invalid CRDT type")
}

func getFieldKey(
	c client.CollectionDescription,
	key core.DataStoreKey,
	fieldName string,
) core.DataStoreKey {
	if !c.Schema.IsEmpty() {
		return key.WithFieldId(fmt.Sprint(c.Schema.GetFieldKey(fieldName)))
	}
	return key.WithFieldId(fieldName)
}