spicedbx

package

v0.4.0 Latest Latest Go to latest Published: Apr 5, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package spicedbx is the wrapper around spicedb client interaction

Package spicedbx is the wrapper around the spicedb client

This section is empty.

View Source

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

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

GenerateSchema generates the spicedb schema from the template

func GeneratedSchema(namespace string) string

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

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

Healthcheck reads the schema to check if the connection is working

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

NewClient returns a new spicedb/authzed client

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

Config values for a SpiceDB connection