seaweedfs/weed/s3api/iceberg/name_mapping.go

package iceberg

import (
	"encoding/json"
	"slices"

	"github.com/apache/iceberg-go"
	"github.com/apache/iceberg-go/table"
)

// nameMappingFromSchema derives the spec's field-id-to-names mapping from a
// table schema, mirroring Java's MappingUtil.create. List elements and map
// keys/values use the canonical "element"/"key"/"value" names.
func nameMappingFromSchema(schema *iceberg.Schema) iceberg.NameMapping {
	return mappedFieldsOf(schema.Fields())
}

func mappedFieldsOf(fields []iceberg.NestedField) []iceberg.MappedField {
	mapped := make([]iceberg.MappedField, 0, len(fields))
	for _, field := range fields {
		id := field.ID
		mapped = append(mapped, iceberg.MappedField{
			Names:   []string{field.Name},
			FieldID: &id,
			Fields:  mappedFieldsOfType(field.Type),
		})
	}
	return mapped
}

func mappedFieldsOfType(typ iceberg.Type) []iceberg.MappedField {
	switch t := typ.(type) {
	case *iceberg.StructType:
		return mappedFieldsOf(t.FieldList)
	case *iceberg.ListType:
		return mappedFieldsOf([]iceberg.NestedField{t.ElementField()})
	case *iceberg.MapType:
		return mappedFieldsOf([]iceberg.NestedField{t.KeyField(), t.ValueField()})
	default:
		return nil
	}
}

// refreshDefaultNameMapping keeps schema.name-mapping.default in sync with
// the current schema across commits, so schema evolution does not strand
// readers of field-id-less data files on the creation-time mapping. The
// stored mapping is merged rather than replaced: per field-id, names already
// present are kept alongside the current schema name, so files written under
// a renamed column's old name (and user-added aliases) stay resolvable.
// Returns the (possibly patched) serialized metadata.
func refreshDefaultNameMapping(raw []byte, updated table.Metadata) []byte {
	if updated == nil {
		return raw
	}
	updatedSchema := updated.CurrentSchema()
	if updatedSchema == nil || len(updatedSchema.Fields()) == 0 {
		return raw
	}
	mapping := nameMappingFromSchema(updatedSchema)

	existing := updated.Properties()[table.DefaultNameMappingKey]
	if existing != "" {
		var existingMapping iceberg.NameMapping
		if err := json.Unmarshal([]byte(existing), &existingMapping); err != nil {
			// Not a mapping we can merge; leave whatever the user stored.
			return raw
		}
		mapping = mergeMappedFields(existingMapping, mapping)
	}
	wantJSON, err := json.Marshal(mapping)
	if err != nil {
		return raw
	}
	want := string(wantJSON)
	if existing == want {
		return raw
	}

	var metadata map[string]json.RawMessage
	if err := json.Unmarshal(raw, &metadata); err != nil {
		return raw
	}
	properties := map[string]json.RawMessage{}
	if rawProperties, ok := metadata["properties"]; ok {
		if err := json.Unmarshal(rawProperties, &properties); err != nil {
			return raw
		}
	}
	valueJSON, err := json.Marshal(want)
	if err != nil {
		return raw
	}
	properties[table.DefaultNameMappingKey] = valueJSON
	propertiesJSON, err := json.Marshal(properties)
	if err != nil {
		return raw
	}
	metadata["properties"] = propertiesJSON
	patched, err := json.Marshal(metadata)
	if err != nil {
		return raw
	}
	return patched
}

// mergeMappedFields folds the names of an existing mapping into the mapping
// derived from the current schema. Fields are matched by field-id per nesting
// level; entries whose ids left the schema are dropped, since current readers
// cannot project those fields anyway. A name can belong to only one field per
// level (Java readers reject ambiguous mappings), so a historical name that
// the current schema assigns to a different field-id stays with its new owner
// instead of being duplicated onto the old one — which also keeps mappings
// clean when a commit replaces the schema with reassigned field ids.
func mergeMappedFields(existing, derived []iceberg.MappedField) []iceberg.MappedField {
	byID := make(map[int]*iceberg.MappedField, len(existing))
	for i := range existing {
		byID[existing[i].ID()] = &existing[i]
	}
	nameOwner := make(map[string]int)
	for _, d := range derived {
		for _, name := range d.Names {
			nameOwner[name] = d.ID()
		}
	}
	for i := range derived {
		prior, ok := byID[derived[i].ID()]
		if !ok {
			continue
		}
		for _, name := range prior.Names {
			if ownerID, taken := nameOwner[name]; taken && ownerID != derived[i].ID() {
				continue
			}
			if !slices.Contains(derived[i].Names, name) {
				derived[i].Names = append(derived[i].Names, name)
				nameOwner[name] = derived[i].ID()
			}
		}
		derived[i].Fields = mergeMappedFields(prior.Fields, derived[i].Fields)
	}
	return derived
}