spicedb

Documentation

Index

• Variables
• type Config
• type RelationRepository
  • func NewRelationRepository(spiceDB *SpiceDB, fullyConsistent bool, tracing bool) *RelationRepository
  • func (r RelationRepository) Add(ctx context.Context, rel relation.Relation) error
  • func (r RelationRepository) BatchCheck(ctx context.Context, relations []relation.Relation) ([]relation.CheckPair, error)
  • func (r RelationRepository) Check(ctx context.Context, rel relation.Relation) (bool, error)
  • func (r RelationRepository) Delete(ctx context.Context, rel relation.Relation) error
  • func (r RelationRepository) ListRelations(ctx context.Context, rel relation.Relation) ([]relation.Relation, error)
  • func (r RelationRepository) LookupResources(ctx context.Context, rel relation.Relation) ([]string, error)
  • func (r RelationRepository) LookupSubjects(ctx context.Context, rel relation.Relation) ([]string, error)
• type SchemaRepository
  • func NewSchemaRepository(logger log.Logger, spiceDB *SpiceDB) *SchemaRepository
  • func (r SchemaRepository) WriteSchema(ctx context.Context, schema string) error
• type SpiceDB
  • func New(config Config, logger log.Logger, clientMetrics *prometheus.ClientMetrics) (*SpiceDB, error)
  • func (s *SpiceDB) Check() error

Variables

var (
	ErrWritingSchema = errors.New("error in writing schema to spicedb")
)

Types

type Config

type Config struct {
	Host         string `yaml:"host"`
	Port         string `yaml:"port" default:"50051"`
	PreSharedKey string `yaml:"pre_shared_key" mapstructure:"pre_shared_key"`

	// FullyConsistent ensures APIs although slower than usual will result in responses always most consistent
	FullyConsistent bool `yaml:"fully_consistent" mapstructure:"fully_consistent" default:"false"`

	// CheckTrace enables tracing in check api for spicedb, it adds considerable
	// latency to the check calls and shouldn't be enabled in production
	CheckTrace bool `yaml:"check_trace" mapstructure:"check_trace" default:"false"`
}

type RelationRepository

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

func NewRelationRepository

func NewRelationRepository(spiceDB *SpiceDB, fullyConsistent bool, tracing bool) *RelationRepository

func (RelationRepository) Add

func (r RelationRepository) Add(ctx context.Context, rel relation.Relation) error

func (RelationRepository) BatchCheck

func (r RelationRepository) BatchCheck(ctx context.Context, relations []relation.Relation) ([]relation.CheckPair, error)

func (RelationRepository) Check

func (r RelationRepository) Check(ctx context.Context, rel relation.Relation) (bool, error)

func (RelationRepository) Delete

func (r RelationRepository) Delete(ctx context.Context, rel relation.Relation) error

func (RelationRepository) ListRelations

func (r RelationRepository) ListRelations(ctx context.Context, rel relation.Relation) ([]relation.Relation, error)

ListRelations shouldn't be used in high TPS flows as consistency requirements are set high

func (RelationRepository) LookupResources

func (r RelationRepository) LookupResources(ctx context.Context, rel relation.Relation) ([]string, error)

func (RelationRepository) LookupSubjects

func (r RelationRepository) LookupSubjects(ctx context.Context, rel relation.Relation) ([]string, error)

type SchemaRepository

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

func NewSchemaRepository

func NewSchemaRepository(logger log.Logger, spiceDB *SpiceDB) *SchemaRepository

func (SchemaRepository) WriteSchema

func (r SchemaRepository) WriteSchema(ctx context.Context, schema string) error

type SpiceDB

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

func New

func New(config Config, logger log.Logger, clientMetrics *prometheus.ClientMetrics) (*SpiceDB, error)

func (*SpiceDB) Check

func (s *SpiceDB) Check() error