builtins

Documentation

Index

• Variables
• func DeleteRelationshipsBuiltinImpl(bctx rego.BuiltinContext, terms []*ast.Term) (*ast.Term, error)
• func ReadRelationshipsBuiltinImpl(bctx rego.BuiltinContext, terms []*ast.Term) (*ast.Term, error)
• func Register()
• func WriteRelationshipsBuiltinImpl(bctx rego.BuiltinContext, writesTerm, touchesTerm, deletesTerm *ast.Term) (*ast.Term, error)
• type DeleteRelationshipsCacheKeyType
• type ErrorStruct
• type ReadRelationshipsCacheKeyType
• type Relationship
• type ZedToken

Variables

var DeleteRelationshipsBuiltinDecl = &rego.Function{
	Name: "spicedb.delete_relationships",
	Decl: types.NewFunction(
		types.Args(types.S, types.S, types.A, types.S, types.S),
		types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
}

var ReadRelationshipsBuiltinDecl = &rego.Function{
	Name: "spicedb.read_relationships",
	Decl: types.NewFunction(
		types.Args(types.S, types.S, types.A, types.S, types.S),
		types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
}

var WriteRelationshipsBuiltinDecl = &rego.Function{
	Name: "spicedb.write_relationships",
	Decl: types.NewFunction(
		types.Args(
			types.Named("writes",
				types.NewAny(
					types.NewArray(nil, types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
					types.NewSet(types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
				),
			),
			types.Named("updates",
				types.NewAny(
					types.NewArray(nil, types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
					types.NewSet(types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
				),
			),
			types.Named("deletes",
				types.NewAny(
					types.NewArray(nil, types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
					types.NewSet(types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
				),
			),
		),
		types.NewObject(nil, types.NewDynamicProperty(types.S, types.A))),
	Nondeterministic: true,
}

Functions

func DeleteRelationshipsBuiltinImpl

func DeleteRelationshipsBuiltinImpl(bctx rego.BuiltinContext, terms []*ast.Term) (*ast.Term, error)

LookupResourcesBuiltinImpl checks the given permission requests against spicedb.

func ReadRelationshipsBuiltinImpl

func ReadRelationshipsBuiltinImpl(bctx rego.BuiltinContext, terms []*ast.Term) (*ast.Term, error)

LookupResourcesBuiltinImpl checks the given permission requests against spicedb.

func Register

func Register()

func WriteRelationshipsBuiltinImpl

func WriteRelationshipsBuiltinImpl(bctx rego.BuiltinContext, writesTerm, touchesTerm, deletesTerm *ast.Term) (*ast.Term, error)

WriteRelationshipsBuiltinImpl writes/updates a set of given relationships against spicedb.

Types

type DeleteRelationshipsCacheKeyType

type DeleteRelationshipsCacheKeyType string

Use a custom cache key type to avoid collisions with other builtins caching data!!

type ErrorStruct

type ErrorStruct struct {
	Error string `json:"error"`
	Desc  string `json:"desc"`
}

type ReadRelationshipsCacheKeyType

type ReadRelationshipsCacheKeyType string

Use a custom cache key type to avoid collisions with other builtins caching data!!

type Relationship

type Relationship struct {
	ResourceType string `json:"resourceType"`
	ResourceId   string `json:"resourceId"`
	Relationship string `json:"relationship"`
	SubjectType  string `json:"subjectType"`
	SubjectId    string `json:"subjectId"`
}

type ZedToken

type ZedToken string