gf/contrib/nosql/redis/redis_group_script.go

// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.

package redis

import (
	"context"

	"github.com/gogf/gf/v2/container/gvar"
	"github.com/gogf/gf/v2/database/gredis"
	"github.com/gogf/gf/v2/util/gconv"
)

// GroupScript provides script functions for redis.
type GroupScript struct {
	Operation gredis.AdapterOperation
}

// GroupScript creates and returns GroupScript.
func (r *Redis) GroupScript() gredis.IGroupScript {
	return GroupScript{
		Operation: r.AdapterOperation,
	}
}

// Eval invokes the execution of a server-side Lua script.
//
// https://redis.io/commands/eval/
func (r GroupScript) Eval(ctx context.Context, script string, numKeys int64, keys []string, args []any) (*gvar.Var, error) {
	var s = []any{script, numKeys}
	s = append(s, gconv.Interfaces(keys)...)
	s = append(s, args...)
	v, err := r.Operation.Do(ctx, "Eval", s...)
	return v, err
}

// EvalSha evaluates a script from the server's cache by its SHA1 digest.
//
// The server caches scripts by using the SCRIPT LOAD command.
// The command is otherwise identical to EVAL.
//
// https://redis.io/commands/evalsha/
func (r GroupScript) EvalSha(ctx context.Context, sha1 string, numKeys int64, keys []string, args []any) (*gvar.Var, error) {
	var s = []any{sha1, numKeys}
	s = append(s, gconv.Interfaces(keys)...)
	s = append(s, args...)
	v, err := r.Operation.Do(ctx, "EvalSha", s...)
	return v, err
}

// ScriptLoad loads a script into the scripts cache, without executing it.
//
// It returns the SHA1 digest of the script added into the script cache.
//
// https://redis.io/commands/script-load/
func (r GroupScript) ScriptLoad(ctx context.Context, script string) (string, error) {
	v, err := r.Operation.Do(ctx, "Script", "Load", script)
	return v.String(), err
}

// ScriptExists returns information about the existence of the scripts in the script cache.
//
// It returns an array of integers that correspond to the specified SHA1 digest arguments.
// For every corresponding SHA1 digest of a script that actually exists in the script cache,
// a 1 is returned, otherwise 0 is returned.
//
// https://redis.io/commands/script-exists/
func (r GroupScript) ScriptExists(ctx context.Context, sha1 string, sha1s ...string) (map[string]bool, error) {
	var (
		s         []any
		sha1Array = append([]any{sha1}, gconv.Interfaces(sha1s)...)
	)
	s = append(s, "Exists")
	s = append(s, sha1Array...)
	result, err := r.Operation.Do(ctx, "Script", s...)
	if err != nil {
		return nil, err
	}
	var (
		m           = make(map[string]bool)
		resultArray = result.Vars()
	)
	for i := 0; i < len(sha1Array); i++ {
		m[gconv.String(sha1Array[i])] = resultArray[i].Bool()
	}
	return m, err
}

// ScriptFlush flush the Lua scripts cache.
//
// https://redis.io/commands/script-flush/
func (r GroupScript) ScriptFlush(ctx context.Context, option ...gredis.ScriptFlushOption) error {
	var usedOption any
	if len(option) > 0 {
		usedOption = option[0]
	}
	var s []any
	s = append(s, "Flush")
	s = append(s, mustMergeOptionToArgs(
		[]any{}, usedOption,
	)...)
	_, err := r.Operation.Do(ctx, "Script", s...)
	return err
}

// ScriptKill kills the currently executing EVAL script, assuming no write operation was yet performed
// by the script.
//
// https://redis.io/commands/script-kill/
func (r GroupScript) ScriptKill(ctx context.Context) error {
	_, err := r.Operation.Do(ctx, "Script", "Kill")
	return err
}