group_experimental.go

package tiledb

import (
	"encoding/json"
	"errors"
	"fmt"
	"unsafe"
)

/*


	#include <tiledb/tiledb_experimental.h>
	#include <tiledb/tiledb_serialization.h>
	#include <stdlib.h>
*/
import "C"

// Group represents a wrapped TileDB embedded group
type Group struct {
	group   *C.tiledb_group_t
	uri     string
	context *Context
	config  *Config
}

// NewGroup allocates an embedded group.
func NewGroup(tdbCtx *Context, uri string) (*Group, error) {
	curi := C.CString(uri)
	defer C.free(unsafe.Pointer(curi))
	group := Group{context: tdbCtx, uri: uri}
	ret := C.tiledb_group_alloc(group.context.tiledbContext, curi, &group.group)
	if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error creating tiledb group: %s", group.context.LastError())
	}
	freeOnGC(&group)

	return &group, nil
}

// Deserialize deserializes the group from the given buffer.
func (g *Group) Deserialize(buffer *Buffer, serializationType SerializationType, clientSide bool) error {
	var cClientSide C.int32_t
	if clientSide {
		cClientSide = 1
	} else {
		cClientSide = 0
	}

	b, err := buffer.dataCopy()
	if err != nil {
		return errors.New("failed to retrieve bytes from buffer")
	}

	// cstrings are null terminated. Go's are not, add it as a suffix
	if err := buffer.SetBuffer(append(b, []byte("\u0000")...)); err != nil {
		return errors.New("failed to add null terminator to buffer")
	}

	ret := C.tiledb_deserialize_group(g.context.tiledbContext, buffer.tiledbBuffer, C.tiledb_serialization_type_t(serializationType), cClientSide, g.group)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error deserializing group: %s", g.context.LastError())
	}

	return nil
}

// Create creates a new TileDB group.
func (g *Group) Create() error {
	curi := C.CString(g.uri)
	defer C.free(unsafe.Pointer(curi))

	ret := C.tiledb_group_create(g.context.tiledbContext, curi)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error in creating group: %s", g.context.LastError())
	}
	return nil
}

func (g *Group) Open(queryType QueryType) error {
	ret := C.tiledb_group_open(g.context.tiledbContext, g.group, C.tiledb_query_type_t(queryType))
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error opening tiledb group for querying: %s", g.context.LastError())
	}
	return nil
}

func (g *Group) Free() {
	if g.group != nil {
		g.Close()
		C.tiledb_group_free(&g.group)
	}
}

func (g *Group) Close() error {
	ret := C.tiledb_group_close(g.context.tiledbContext, g.group)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error closing tiledb group: %s", g.context.LastError())
	}
	return nil
}

func (g *Group) SetConfig(config *Config) error {
	ret := C.tiledb_group_set_config(g.context.tiledbContext, g.group, config.tiledbConfig)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error setting config on group: %s", g.context.LastError())
	}
	g.config = config
	return nil
}

func (g *Group) Config() (*Config, error) {
	var config Config
	ret := C.tiledb_group_get_config(g.context.tiledbContext, g.group, &config.tiledbConfig)
	if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error getting config from query: %s", g.context.LastError())
	}
	freeOnGC(&config)

	if g.config == nil {
		g.config = &config
	}

	return &config, nil
}

func (g *Group) AddMember(uri, name string, isRelativeURI bool) error {
	curi := C.CString(uri)
	defer C.free(unsafe.Pointer(curi))

	cname := C.CString(name)
	defer C.free(unsafe.Pointer(cname))

	var cRelative C.uint8_t
	if isRelativeURI {
		cRelative = 1
	}

	ret := C.tiledb_group_add_member(g.context.tiledbContext, g.group, curi, cRelative, cname)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error adding member to group: %s", g.context.LastError())
	}
	return nil
}

// GroupMetadata defines metadata for the group
type GroupMetadata struct {
	Key      string
	KeyLen   uint32
	Datatype Datatype
	ValueNum uint
	Value    interface{}
}

// MarshalJSON implements the Marshaller interface for GroupMetadata
func (g GroupMetadata) MarshalJSON() ([]byte, error) {
	switch v := g.Value.(type) {
	case []byte:
		return json.Marshal(string(v))
	default:
		return json.Marshal(v)
	}
}

// PutMetadata puts a metadata key-value item to an open group. The group must
// be opened in WRITE mode, otherwise the function will error out.
func (g *Group) PutMetadata(key string, value interface{}) error {
	switch value := value.(type) {
	case int:
		return groupPutScalarMetadata(g, tileDBInt, key, value)
	case []int:
		return groupPutSliceMetadata(g, tileDBInt, key, value)
	case int8:
		return groupPutScalarMetadata(g, TILEDB_INT8, key, value)
	case []int8:
		return groupPutSliceMetadata(g, TILEDB_INT8, key, value)
	case int16:
		return groupPutScalarMetadata(g, TILEDB_INT16, key, value)
	case []int16:
		return groupPutSliceMetadata(g, TILEDB_INT16, key, value)
	case int32:
		return groupPutScalarMetadata(g, TILEDB_INT32, key, value)
	case []int32:
		return groupPutSliceMetadata(g, TILEDB_INT32, key, value)
	case uint:
		return groupPutScalarMetadata(g, tileDBUint, key, value)
	case []uint:
		return groupPutSliceMetadata(g, tileDBUint, key, value)
	case int64:
		return groupPutScalarMetadata(g, TILEDB_INT64, key, value)
	case []int64:
		return groupPutSliceMetadata(g, TILEDB_INT64, key, value)
	case uint8:
		return groupPutScalarMetadata(g, TILEDB_UINT8, key, value)
	case []uint8:
		return groupPutSliceMetadata(g, TILEDB_UINT8, key, value)
	case uint16:
		return groupPutScalarMetadata(g, TILEDB_UINT16, key, value)
	case []uint16:
		return groupPutSliceMetadata(g, TILEDB_UINT16, key, value)
	case uint32:
		return groupPutScalarMetadata(g, TILEDB_UINT32, key, value)
	case []uint32:
		return groupPutSliceMetadata(g, TILEDB_UINT32, key, value)
	case uint64:
		return groupPutScalarMetadata(g, TILEDB_UINT64, key, value)
	case []uint64:
		return groupPutSliceMetadata(g, TILEDB_UINT64, key, value)
	case float32:
		return groupPutScalarMetadata(g, TILEDB_FLOAT32, key, value)
	case []float32:
		return groupPutSliceMetadata(g, TILEDB_FLOAT32, key, value)
	case float64:
		return groupPutScalarMetadata(g, TILEDB_FLOAT64, key, value)
	case []float64:
		return groupPutSliceMetadata(g, TILEDB_FLOAT64, key, value)
	case bool:
		return groupPutScalarMetadata(g, TILEDB_BOOL, key, value)
	case []bool:
		return groupPutSliceMetadata(g, TILEDB_BOOL, key, value)
	case string:
		valPtr := unsafe.Pointer(C.CString(value))
		defer C.free(valPtr)
		return groupPutMetadata(g, TILEDB_STRING_UTF8, key, valPtr, len(value))
	}
	return fmt.Errorf("can't write %q metadata: unrecognized value type %T", key, value)
}

func groupPutSliceMetadata[T scalarType](g *Group, dt Datatype, key string, value []T) error {
	if len(value) == 0 {
		return fmt.Errorf("length of %q metadata %T value must be nonzero", key, value)
	}
	return groupPutMetadata(g, dt, key, slicePtr(value), len(value))
}

func groupPutScalarMetadata[T scalarType](g *Group, dt Datatype, key string, value T) error {
	return groupPutMetadata(g, dt, key, unsafe.Pointer(&value), 1)
}

func groupPutMetadata(g *Group, dt Datatype, key string, valuePtr unsafe.Pointer, count int) error {
	cKey := C.CString(key)
	defer C.free(unsafe.Pointer(cKey))
	ret := C.tiledb_group_put_metadata(
		g.context.tiledbContext,
		g.group,
		cKey,
		C.tiledb_datatype_t(dt),
		C.uint(count),
		valuePtr,
	)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("could not add metadata to group: %w", g.context.LastError())
	}
	return nil
}

func (g *Group) RemoveMember(uri string) error {
	curi := C.CString(uri)
	defer C.free(unsafe.Pointer(curi))
	ret := C.tiledb_group_remove_member(g.context.tiledbContext, g.group, curi)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error removing member from group: %s", g.context.LastError())
	}
	return nil
}

func (g *Group) GetMemberCount() (uint64, error) {
	var count C.uint64_t
	ret := C.tiledb_group_get_member_count(g.context.tiledbContext, g.group, &count)
	if ret != C.TILEDB_OK {
		return 0, fmt.Errorf("Error retrieving member count in group: %s", g.context.LastError())
	}
	return uint64(count), nil
}

func (g *Group) GetMemberFromIndex(index uint64) (string, string, ObjectTypeEnum, error) {
	var curi *C.tiledb_string_t

	var cname *C.tiledb_string_t

	var objectTypeEnum C.tiledb_object_t
	ret := C.tiledb_group_get_member_by_index_v2(g.context.tiledbContext, g.group, C.uint64_t(index), &curi, &objectTypeEnum, &cname)
	if ret != C.TILEDB_OK {
		return "", "", TILEDB_INVALID, fmt.Errorf("Error getting member by index for group: %s", g.context.LastError())
	}
	defer C.tiledb_string_free(&curi)
	defer C.tiledb_string_free(&cname)

	uri, err := stringHandleToString(curi)
	if err != nil {
		return "", "", TILEDB_INVALID, err
	}

	name, err := stringHandleToString(cname)
	if err != nil {
		return "", "", TILEDB_INVALID, err
	}

	return uri, name, ObjectTypeEnum(objectTypeEnum), nil
}

func (g *Group) GetMemberByName(name string) (string, string, ObjectTypeEnum, error) {
	var curi *C.tiledb_string_t

	cname := C.CString(name)
	defer C.free(unsafe.Pointer(cname))

	var objectTypeEnum C.tiledb_object_t
	ret := C.tiledb_group_get_member_by_name_v2(g.context.tiledbContext, g.group, cname, &curi, &objectTypeEnum)
	if ret != C.TILEDB_OK {
		return "", "", TILEDB_INVALID, fmt.Errorf("Error getting member by index for group: %s", g.context.LastError())
	}
	defer C.tiledb_string_free(&curi)

	uri, err := stringHandleToString(curi)
	if err != nil {
		return "", "", TILEDB_INVALID, err
	}

	if name == "" {
		return "", "", TILEDB_INVALID, fmt.Errorf("Error getting name for member %s: name is empty", name)
	}

	name = C.GoString(cname)

	return uri, name, ObjectTypeEnum(objectTypeEnum), nil
}

func (g *Group) GetMetadata(key string) (Datatype, uint, interface{}, error) {
	ckey := C.CString(key)
	defer C.free(unsafe.Pointer(ckey))

	var cType C.tiledb_datatype_t
	var cValueNum C.uint
	var cvalue unsafe.Pointer

	ret := C.tiledb_group_get_metadata(g.context.tiledbContext, g.group, ckey, &cType, &cValueNum, &cvalue)
	if ret != C.TILEDB_OK {
		return 0, 0, nil, fmt.Errorf("Error getting metadata from group: %s, key: %s", g.context.LastError(), key)
	}

	valueNum := uint(cValueNum)
	if valueNum == 0 {
		return 0, 0, nil, fmt.Errorf("Error getting metadata from group, key: %s does not exist", key)
	}

	datatype := Datatype(cType)
	value, err := datatype.GetValue(valueNum, cvalue)
	if err != nil {
		return 0, 0, nil, fmt.Errorf("%s, key: %s", err.Error(), key)
	}

	return datatype, valueNum, value, nil
}

func (g *Group) DeleteMetadata(key string) error {
	ckey := C.CString(key)
	defer C.free(unsafe.Pointer(ckey))

	ret := C.tiledb_group_delete_metadata(g.context.tiledbContext, g.group, ckey)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error deleting metadata from group: %s", g.context.LastError())
	}
	return nil
}

func (g *Group) GetMetadataNum() (uint64, error) {
	var cNum C.uint64_t

	ret := C.tiledb_group_get_metadata_num(g.context.tiledbContext, g.group, &cNum)
	if ret != C.TILEDB_OK {
		return 0, fmt.Errorf("Error getting number of metadata from group: %s", g.context.LastError())
	}

	return uint64(cNum), nil
}

func (g *Group) GetMetadataFromIndex(index uint64) (*GroupMetadata, error) {
	return g.GetMetadataFromIndexWithValueLimit(index, nil)
}

func (g *Group) GetMetadataFromIndexWithValueLimit(index uint64, limit *uint) (*GroupMetadata, error) {
	var cKey *C.char

	var cIndex C.uint64_t = C.uint64_t(index)
	var cType C.tiledb_datatype_t
	var cKeyLen C.uint32_t
	var cValueNum C.uint
	var cvalue unsafe.Pointer

	ret := C.tiledb_group_get_metadata_from_index(g.context.tiledbContext,
		g.group, cIndex, &cKey, &cKeyLen, &cType, &cValueNum, &cvalue)
	if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error getting metadata from group: %s, index: %d", g.context.LastError(), index)
	}

	valueNum := uint(cValueNum)
	if valueNum == 0 {
		return nil, fmt.Errorf("Error getting metadata from group, Index: %d does not exist", index)
	}

	datatype := Datatype(cType)
	if limit != nil && valueNum > *limit {
		valueNum = *limit
	}
	value, err := datatype.GetValue(valueNum, cvalue)
	if err != nil {
		return nil, fmt.Errorf("%s, Index: %d", err.Error(), index)
	}

	groupMetadata := GroupMetadata{
		Key:      C.GoStringN(cKey, C.int(cKeyLen)),
		KeyLen:   uint32(cKeyLen),
		Datatype: datatype,
		ValueNum: valueNum,
		Value:    value,
	}

	return &groupMetadata, nil
}

func (g *Group) Dump(recurse bool) (string, error) {
	var cOutput *C.char
	defer C.free(unsafe.Pointer(cOutput))

	var cRecurse C.uint8_t
	if recurse {
		cRecurse = 1
	}

	ret := C.tiledb_group_dump_str(g.context.tiledbContext, g.group, &cOutput, cRecurse)
	if ret != C.TILEDB_OK {
		return "", fmt.Errorf("Error dumping group contents: %s", g.context.LastError())
	}

	return C.GoString(cOutput), nil
}

// SerializeGroupMetadata gets and serializes the group metadata
func SerializeGroupMetadata(g *Group, serializationType SerializationType) ([]byte, error) {
	buffer := Buffer{context: g.context}
	freeOnGC(&buffer)

	ret := C.tiledb_serialize_group_metadata(g.context.tiledbContext, g.group, C.tiledb_serialization_type_t(serializationType), &buffer.tiledbBuffer)
	if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error serializing group metadata: %s", g.context.LastError())
	}

	return buffer.Serialize(serializationType)
}

// DeserializeGroupMetadata deserializes group metadata
func DeserializeGroupMetadata(g *Group, buffer *Buffer, serializationType SerializationType) error {
	b, err := buffer.dataCopy()
	if err != nil {
		return errors.New("failed to retrieve bytes from buffer")
	}
	// cstrings are null terminated. Go's are not, add it as a suffix
	if err := buffer.SetBuffer(append(b, []byte("\u0000")...)); err != nil {
		return errors.New("failed to add null terminator to buffer")
	}

	ret := C.tiledb_deserialize_group_metadata(g.context.tiledbContext, g.group, C.tiledb_serialization_type_t(serializationType), buffer.tiledbBuffer)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error deserializing group metadata: %s", g.context.LastError())
	}

	return nil
}

// GetIsRelativeURIByName returns whether a named member of the group has a uri relative to the group
func (g *Group) GetIsRelativeURIByName(name string) (bool, error) {
	cName := C.CString(name)
	defer C.free(unsafe.Pointer(cName))

	var isRelative C.uint8_t
	ret := C.tiledb_group_get_is_relative_uri_by_name(g.context.tiledbContext, g.group, cName, &isRelative)
	if ret != C.TILEDB_OK {
		return false, fmt.Errorf("Error getting if member %s has a relative uri: %s", name, g.context.LastError())
	}
	return isRelative > 0, nil
}

// Delete deletes written data from an open group. The group must be opened in MODIFY_EXCLUSIVE mode,
// otherwise the function will error out.
// Set recursive true if all data inside the group is to be deleted.
func (g *Group) Delete(recursive bool) error {
	curi := C.CString(g.uri)
	defer C.free(unsafe.Pointer(curi))

	var cRecursive C.uint8_t
	if recursive {
		cRecursive = 1
	}

	ret := C.tiledb_group_delete_group(g.context.tiledbContext, g.group, curi, cRecursive)
	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error deleting group: %s", g.context.LastError())
	}
	return nil
}