Method Iterate

db/functions/n1ql_function.go:52–84

()

}

func (fn *n1qlInvocation) Iterate() (sgbucket.QueryResultIterator, error) {
	var userArg n1qlUserArgument
	if user := fn.db.User(); user != nil {
		userArg.Name = base.Ptr(user.Name())
		userArg.Email = base.Ptr(user.Email())
		userArg.Channels = user.Channels().AllKeys()
		userArg.Roles = user.RoleNames().AllKeys()
	}
	if fn.n1qlArgs == nil {
		fn.n1qlArgs = map[string]any{}
	}
	fn.n1qlArgs["args"] = fn.args
	fn.n1qlArgs["user"] = &userArg

	// Run the N1QL query:
	// TODO: Multi-collection support for user functions is not implemented.
	iter, err := db.N1QLQueryWithStats(fn.ctx, fn.db.Bucket.DefaultDataStore(), db.QueryTypeUserFunctionPrefix+fn.name, fn.Code, fn.n1qlArgs,
		base.RequestPlus, false, fn.db.DbStats, fn.db.Options.SlowQueryWarningThreshold)

	if err != nil {
		// Return a friendlier error:
		var qe *gocb.QueryError
		if errors.As(err, &qe) {
			base.WarnfCtx(fn.ctx, "Error running query %q: %v", fn.name, err)
			return nil, base.HTTPErrorf(http.StatusInternalServerError, "Query %q: %s", fn.name, qe.Errors[0].Message)
		} else {
			base.WarnfCtx(fn.ctx, "Unknown error running query %q: %T %#v", fn.name, err, err)
			return nil, base.HTTPErrorf(http.StatusInternalServerError, "Unknown error running query %q (see logs)", fn.name)
		}
	}
	// Do a final timeout check, so the caller will know not to do any more work if time's up:
	return iter, db.CheckTimeout(fn.ctx)
}

func (fn *n1qlInvocation) Run(ctx context.Context) (any, error) {
	rows, err := fn.Iterate()