context.go

package tiledb

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

import (
	"errors"
	"fmt"
	"runtime"
	"unsafe"
)

// Context A TileDB context wraps a TileDB storage manager “instance.” Most
// objects and functions will require a Context.
// Internal error handling is also defined by the Context;
// the default error handler throws a TileDBError with a specific message.
type Context struct {
	tiledbContext *C.tiledb_ctx_t
}

// NewContext creates a TileDB context with the given configuration.
// If the configuration passed is nil, it is created with the default config.
func NewContext(config *Config) (*Context, error) {
	var context Context
	var ret C.int32_t
	if config != nil {
		ret = C.tiledb_ctx_alloc(config.tiledbConfig, &context.tiledbContext)
	} else {
		ret = C.tiledb_ctx_alloc(nil, &context.tiledbContext)
	}
	if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("error creating tiledb context: %w", context.LastError())
	}
	freeOnGC(&context)

	err := context.setDefaultTags()
	if err != nil {
		return nil, fmt.Errorf("error creating tiledb context: %w", err)
	}

	if config != nil {
		runtime.KeepAlive(config)
	}
	return &context, nil
}

// NewContextFromMap creates a TileDB context with the given configuration.
// If the configuration passed is nil, it is created with the default config.
// This is a shortcut for creating a *Config from the given map and
// using it to create a new context.
func NewContextFromMap(cfgMap map[string]string) (*Context, error) {
	if cfgMap == nil {
		return NewContext(nil)
	}
	config, err := NewConfig()
	if err != nil {
		return nil, err
	}
	for k, v := range cfgMap {
		if err := config.Set(k, v); err != nil {
			// The value is not included in the error message in case it is sensitive,
			// like a password or access key.
			return nil, fmt.Errorf("error setting config value %q: %w", k, err)
		}
	}
	return NewContext(config)
}

// Free releases the internal TileDB core data that was allocated on the C heap.
// It is automatically called when this object is garbage collected, but can be
// called earlier to manually release memory if needed. Free is idempotent and
// can safely be called many times on the same object; if it has already
// been freed, it will not be freed again.
func (c *Context) Free() {
	if c.tiledbContext != nil {
		C.tiledb_ctx_free(&c.tiledbContext)
	}
}

// CancelAllTasks cancels all currently executing tasks on the context.
func (c *Context) CancelAllTasks() error {
	ret := C.tiledb_ctx_cancel_tasks(c.tiledbContext)
	if ret != C.TILEDB_OK {
		return errors.New("failed to cancel tasks")
	}
	return nil
}

// Config retrieves a copy of the config from context.
func (c *Context) Config() (*Config, error) {
	config := Config{}
	ret := C.tiledb_ctx_get_config(c.tiledbContext, &config.tiledbConfig)

	if ret == C.TILEDB_OOM {
		return nil, fmt.Errorf("Out of Memory error in GetConfig")
	} else if ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Unknown error in GetConfig")
	}
	freeOnGC(&config)

	return &config, nil
}

// LastError returns the last error from this context.
func (c *Context) LastError() error {
	var err *C.tiledb_error_t
	ret := C.tiledb_ctx_get_last_error(c.tiledbContext, &err)
	if ret == C.TILEDB_OOM {
		return fmt.Errorf("Out of Memory error in tiledb_ctx_get_last_error")
	} else if ret != C.TILEDB_OK {
		return fmt.Errorf("Unknown error in tiledb_ctx_get_last_error")
	}

	if err != nil {
		var msg *C.char
		defer C.tiledb_error_free(&err)
		ret := C.tiledb_error_message(err, &msg)
		if ret == C.TILEDB_OOM {
			return fmt.Errorf("Out of Memory error in tiledb_error_message")
		} else if ret != C.TILEDB_OK {
			return fmt.Errorf("Unknown error in tiledb_error_message")
		}

		return fmt.Errorf("%s", C.GoString(msg))
	}
	return nil
}

// IsSupportedFS returns true if the given filesystem backend is supported.
func (c *Context) IsSupportedFS(fs FS) (bool, error) {
	var isSupported C.int32_t
	ret := C.tiledb_ctx_is_supported_fs(c.tiledbContext, C.tiledb_filesystem_t(fs), &isSupported)

	if ret != C.TILEDB_OK {
		return false, fmt.Errorf("Error in checking FS support")
	}

	if isSupported == 0 {
		return false, nil
	}

	return true, nil
}

// SetTag sets the context tag.
func (c *Context) SetTag(key string, value string) error {
	ckey := C.CString(key)
	defer C.free(unsafe.Pointer(ckey))
	cvalue := C.CString(value)
	defer C.free(unsafe.Pointer(cvalue))

	ret := C.tiledb_ctx_set_tag(c.tiledbContext, ckey, cvalue)

	if ret != C.TILEDB_OK {
		return fmt.Errorf("Error in setting tag")
	}

	return nil
}

func (c *Context) setDefaultTags() error {
	err := c.SetTag("x-tiledb-api-language", "go")
	if err != nil {
		return err
	}

	err = c.SetTag("x-tiledb-api-language-version", "0.8.0")
	if err != nil {
		return err
	}

	err = c.SetTag("x-tiledb-api-sys-platform", fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH))
	if err != nil {
		return err
	}

	return nil
}

// Stats gets stats for a context as json bytes.
func (c *Context) Stats() ([]byte, error) {
	var stats *C.char
	if ret := C.tiledb_ctx_get_stats(c.tiledbContext, &stats); ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error getting stats from context: %w", c.LastError())
	}

	s := C.GoString(stats)
	if ret := C.tiledb_stats_free_str(&stats); ret != C.TILEDB_OK {
		return nil, fmt.Errorf("Error freeing string from dumping stats to string")
	}

	if s == "" {
		return []byte("{}"), nil
	}

	return []byte(s), nil
}