sql

Documentation

Overview

Package sql is a client package for WASM functions running within a Tarmac server.

This package provides a user-friendly SQL database interface with underlying databases configured within Tarmac. Guest WASM functions running inside Tarmac can import and call this SQL interface.

Index

• type Config
• type SQL
  • func New(cfg Config) (*SQL, error)
  • func (sql *SQL) Query(q string) ([]byte, error)

Types

type Config

type Config struct {
	// Namespace controls the function namespace to use for host callbacks. The default value is "default" which is the global namespace.
	// Users can provide an alternative namespace by specifying this field.
	Namespace string

	// HostCall is used internally for host callbacks. This is mainly here for testing.
	HostCall func(string, string, string, []byte) ([]byte, error)
}

Config provides users with the ability to specify namespaces, function handlers and other key information required to execute the function.

type SQL

type SQL struct {
	// contains filtered or unexported fields
}

SQL provides an interface to the underlying SQL datastores within Tarmac.

func New

func New(cfg Config) (*SQL, error)

New returns a new instance of SQL initialized with Config.

func (*SQL) Query

func (sql *SQL) Query(q string) ([]byte, error)

Query will execute the specified SQL query and return a byte array containing a JSON representation of the SQL data.