shared

Documentation

Index

• Variables
• func NewMaxDepthExceededError(allowedMaximumDepth uint32, isCheckRequest bool) error
• func RewriteError(ctx context.Context, err error, config *ConfigForErrors) error
• type AppliedSchemaChanges
  • func ApplySchemaChanges(ctx context.Context, rwt datastore.ReadWriteTransaction, ...) (*AppliedSchemaChanges, error)
  • func ApplySchemaChangesOverExisting(ctx context.Context, rwt datastore.ReadWriteTransaction, ...) (*AppliedSchemaChanges, error)
• type ConfigForErrors
• type ErrSchemaWriteDataValidation
  • func AsValidationError(err error) *ErrSchemaWriteDataValidation
  • func NewSchemaWriteDataValidationError(message string, args ...any) ErrSchemaWriteDataValidation
  • func (err ErrSchemaWriteDataValidation) GRPCStatus() *status.Status
  • func (err ErrSchemaWriteDataValidation) MarshalZerologObject(e *zerolog.Event)
• type MaxDepthExceededError
  • func (err MaxDepthExceededError) GRPCStatus() *status.Status
• type ValidatedSchemaChanges
  • func ValidateSchemaChanges(ctx context.Context, compiled *compiler.CompiledSchema, additiveOnly bool) (*ValidatedSchemaChanges, error)
• type WithServiceSpecificInterceptors
  • func (wssi WithServiceSpecificInterceptors) StreamInterceptor() grpc.StreamServerInterceptor
  • func (wssi WithServiceSpecificInterceptors) UnaryInterceptor() grpc.UnaryServerInterceptor
• type WithStreamServiceSpecificInterceptor
  • func (wsssi WithStreamServiceSpecificInterceptor) StreamInterceptor() grpc.StreamServerInterceptor
• type WithUnaryServiceSpecificInterceptor
  • func (wussi WithUnaryServiceSpecificInterceptor) UnaryInterceptor() grpc.UnaryServerInterceptor

Variables

var ErrServiceReadOnly = mustMakeStatusReadonly()

ErrServiceReadOnly is an extended GRPC error returned when a service is in read-only mode.

Functions

func NewMaxDepthExceededError

func NewMaxDepthExceededError(allowedMaximumDepth uint32, isCheckRequest bool) error

NewMaxDepthExceededError creates a new MaxDepthExceededError.

func RewriteError

func RewriteError(ctx context.Context, err error, config *ConfigForErrors) error

Types

type AppliedSchemaChanges

type AppliedSchemaChanges struct {
	// TotalOperationCount holds the total number of "dispatch" operations performed by the schema
	// being applied.
	TotalOperationCount uint32

	// NewObjectDefNames contains the names of the newly added object definitions.
	NewObjectDefNames []string

	// RemovedObjectDefNames contains the names of the removed object definitions.
	RemovedObjectDefNames []string

	// NewCaveatDefNames contains the names of the newly added caveat definitions.
	NewCaveatDefNames []string

	// RemovedCaveatDefNames contains the names of the removed caveat definitions.
	RemovedCaveatDefNames []string
}

AppliedSchemaChanges holds information about the applied schema changes.

func ApplySchemaChanges

func ApplySchemaChanges(ctx context.Context, rwt datastore.ReadWriteTransaction, validated *ValidatedSchemaChanges) (*AppliedSchemaChanges, error)

ApplySchemaChanges applies schema changes found in the validated changes struct, via the specified ReadWriteTransaction.

func ApplySchemaChangesOverExisting

func ApplySchemaChangesOverExisting(
	ctx context.Context,
	rwt datastore.ReadWriteTransaction,
	validated *ValidatedSchemaChanges,
	existingCaveats []*core.CaveatDefinition,
	existingObjectDefs []*core.NamespaceDefinition,
) (*AppliedSchemaChanges, error)

ApplySchemaChangesOverExisting applies schema changes found in the validated changes struct, against existing caveat and object definitions given.

type ConfigForErrors

type ConfigForErrors struct {
	MaximumAPIDepth uint32
}

type ErrSchemaWriteDataValidation

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

ErrSchemaWriteDataValidation occurs when a schema cannot be applied due to leaving data unreferenced.

func AsValidationError

func AsValidationError(err error) *ErrSchemaWriteDataValidation

func NewSchemaWriteDataValidationError

func NewSchemaWriteDataValidationError(message string, args ...any) ErrSchemaWriteDataValidation

NewSchemaWriteDataValidationError creates a new error representing that a schema write cannot be completed due to existing data that would be left unreferenced.

func (ErrSchemaWriteDataValidation) GRPCStatus

func (err ErrSchemaWriteDataValidation) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

func (ErrSchemaWriteDataValidation) MarshalZerologObject

func (err ErrSchemaWriteDataValidation) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog object marshalling.

type MaxDepthExceededError

type MaxDepthExceededError struct {

	// AllowedMaximumDepth is the configured allowed maximum depth.
	AllowedMaximumDepth uint32
	// contains filtered or unexported fields
}

MaxDepthExceededError is an error returned when the maximum depth for dispatching has been exceeded.

func (MaxDepthExceededError) GRPCStatus

func (err MaxDepthExceededError) GRPCStatus() *status.Status

GRPCStatus implements retrieving the gRPC status for the error.

type ValidatedSchemaChanges

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

ValidatedSchemaChanges is a set of validated schema changes that can be applied to the datastore.

func ValidateSchemaChanges

func ValidateSchemaChanges(ctx context.Context, compiled *compiler.CompiledSchema, additiveOnly bool) (*ValidatedSchemaChanges, error)

ValidateSchemaChanges validates the schema found in the compiled schema and returns a ValidatedSchemaChanges, if fully validated.

type WithServiceSpecificInterceptors

type WithServiceSpecificInterceptors struct {
	Unary  grpc.UnaryServerInterceptor
	Stream grpc.StreamServerInterceptor
}

WithServiceSpecificInterceptors is a helper to add both a unary and stream interceptor or interceptor chain to a service.

func (WithServiceSpecificInterceptors) StreamInterceptor

func (wssi WithServiceSpecificInterceptors) StreamInterceptor() grpc.StreamServerInterceptor

StreamInterceptor implements servicespecific.ExtraStreamInterceptor

func (WithServiceSpecificInterceptors) UnaryInterceptor

func (wssi WithServiceSpecificInterceptors) UnaryInterceptor() grpc.UnaryServerInterceptor

UnaryInterceptor implements servicespecific.ExtraUnaryInterceptor

type WithStreamServiceSpecificInterceptor

type WithStreamServiceSpecificInterceptor struct {
	Stream grpc.StreamServerInterceptor
}

WithStreamServiceSpecificInterceptor is a helper to add a stream interceptor or interceptor chain to a service.

func (WithStreamServiceSpecificInterceptor) StreamInterceptor

func (wsssi WithStreamServiceSpecificInterceptor) StreamInterceptor() grpc.StreamServerInterceptor

StreamInterceptor implements servicespecific.ExtraStreamInterceptor

type WithUnaryServiceSpecificInterceptor

type WithUnaryServiceSpecificInterceptor struct {
	Unary grpc.UnaryServerInterceptor
}

WithUnaryServiceSpecificInterceptor is a helper to add a unary interceptor or interceptor chain to a service.

func (WithUnaryServiceSpecificInterceptor) UnaryInterceptor

func (wussi WithUnaryServiceSpecificInterceptor) UnaryInterceptor() grpc.UnaryServerInterceptor

UnaryInterceptor implements servicespecific.ExtraUnaryInterceptor