spicedbx

Documentation

Overview

Package spicedbx is the wrapper around spicedb client interaction

Package spicedbx is the wrapper around the spicedb client

Index

• Variables
• func GenerateSchema(namespace string, resourceTypes []types.ResourceType) (string, error)
• func GeneratedSchema(namespace string) string
• func Healthcheck(client *authzed.Client) func(ctx context.Context) error
• func NewClient(cfg Config, enableTracing bool) (*authzed.Client, error)
• type Config

Variables

var (
	// ErrorNoNamespace is returned when no namespace is provided with a query
	ErrorNoNamespace = errors.New("no namespace provided")
)

Functions

func GenerateSchema

func GenerateSchema(namespace string, resourceTypes []types.ResourceType) (string, error)

GenerateSchema generates the spicedb schema from the template

func GeneratedSchema

func GeneratedSchema(namespace string) string

GeneratedSchema produces a namespaced SpiceDB schema based on the default IAPL policy.

func Healthcheck

func Healthcheck(client *authzed.Client) func(ctx context.Context) error

Healthcheck reads the schema to check if the connection is working

func NewClient

func NewClient(cfg Config, enableTracing bool) (*authzed.Client, error)

NewClient returns a new spicedb/authzed client

Types

type Config

type Config struct {
	Endpoint   string
	Key        string
	Insecure   bool
	VerifyCA   bool `mapstruct:"verifyca"`
	Prefix     string
	PolicyFile string
}

Config values for a SpiceDB connection