Method Invoke

db/functions/function.go:146–197

Creates an Invocation of a UserFunction.

(database *db.Database, args map[string]any, mutationAllowed bool, ctx context.Context)

// Creates an Invocation of a UserFunction.
func (fn *functionImpl) Invoke(database *db.Database, args map[string]any, mutationAllowed bool, ctx context.Context) (db.UserFunctionInvocation, error) {
	if ctx == nil {
		return nil, fmt.Errorf("missing context to UserFunction.Invoke")
	}

	if err := db.CheckTimeout(ctx); err != nil {
		return nil, err
	}

	if args == nil {
		args = map[string]any{}
	}
	if fn.checkArgs {
		if err := fn.checkArguments(args); err != nil {
			return nil, err
		}
	}

	// Check that the user is authorized:
	if fn.Allow != nil || !fn.allowByDefault {
		if err := fn.authorize(database.User(), args); err != nil {
			return nil, err
		}
	}

	if (!fn.Mutating || !mutationAllowed) && ctx.Value(readOnlyKey) == nil {
		// Add a value to the Context to indicate that mutations aren't allowed:
		var why string
		if !fn.Mutating {
			why = fmt.Sprintf("%s %q", fn.typeName, fn.name)
		} else {
			why = "a read-only API call"
		}
		ctx = context.WithValue(ctx, readOnlyKey, why)
	}

	if fn.isN1QL() {
		return &n1qlInvocation{
			functionImpl: fn,
			db:           database,
			args:         args,
			ctx:          ctx,
		}, nil
	} else {
		return &jsInvocation{
			functionImpl: fn,
			db:           database,
			ctx:          ctx,
			args:         args,
		}, nil
	}
}

//////// FUNCTION PARAMETERS/ARGUMENTS: