All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.data.redis.connection.RedisScriptingCommands Maven / Gradle / Ivy

There is a newer version: 3.2.5
Show newest version
/*
 * Copyright 2012-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.redis.connection;

import java.util.List;

import org.springframework.lang.Nullable;

/**
 * Scripting commands.
 *
 * @author Costin Leau
 * @author Christoph Strobl
 * @author David Liu
 * @author Mark Paluch
 */
public interface RedisScriptingCommands {

	/**
	 * Flush lua script cache.
	 *
	 * @see Redis Documentation: SCRIPT FLUSH
	 */
	void scriptFlush();

	/**
	 * Kill current lua script execution.
	 *
	 * @see Redis Documentation: SCRIPT KILL
	 */
	void scriptKill();

	/**
	 * Load lua script into scripts cache, without executing it.
* Execute the script by calling {@link #evalSha(byte[], ReturnType, int, byte[]...)}. * * @param script must not be {@literal null}. * @return {@literal null} when used in pipeline / transaction. * @see Redis Documentation: SCRIPT LOAD */ @Nullable String scriptLoad(byte[] script); /** * Check if given {@code scriptShas} exist in script cache. * * @param scriptShas * @return one entry per given scriptSha in returned {@link List} or {@literal null} when used in pipeline / * transaction. * @see Redis Documentation: SCRIPT EXISTS */ @Nullable List scriptExists(String... scriptShas); /** * Evaluate given {@code script}. * * @param script must not be {@literal null}. * @param returnType must not be {@literal null}. * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. * @see Redis Documentation: EVAL */ @Nullable T eval(byte[] script, ReturnType returnType, int numKeys, byte[]... keysAndArgs); /** * Evaluate given {@code scriptSha}. * * @param scriptSha must not be {@literal null}. * @param returnType must not be {@literal null}. * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. * @see Redis Documentation: EVALSHA */ @Nullable T evalSha(String scriptSha, ReturnType returnType, int numKeys, byte[]... keysAndArgs); /** * Evaluate given {@code scriptSha}. * * @param scriptSha must not be {@literal null}. * @param returnType must not be {@literal null}. * @param numKeys * @param keysAndArgs must not be {@literal null}. * @return script result. {@literal null} when used in pipeline / transaction. * @since 1.5 * @see Redis Documentation: EVALSHA */ @Nullable T evalSha(byte[] scriptSha, ReturnType returnType, int numKeys, byte[]... keysAndArgs); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy