org.springframework.data.mongodb.core

Interface ScriptOperations

public interface ScriptOperations

Script operations on DB level. Allows interaction with server side JavaScript functions.

Since:

1.7

Author:

Christoph Strobl, Oliver Gierke

Method Summary

Modifier and Type	Method and Description
Object	call(String scriptName, Object... args) Call the JavaScript by its name.
Object	execute(ExecutableMongoScript script, Object... args) Executes the script by either calling it via its name or directly sending it.
boolean	exists(String scriptName) Checks DB for existence of ServerSideJavaScript with given name.
Set<String>	getScriptNames() Returns names of JavaScript functions that can be called.
NamedMongoScript	register(ExecutableMongoScript script) Store given ExecutableMongoScript generating a syntheitcal name so that it can be called by it subsequently.
NamedMongoScript	register(NamedMongoScript script) Registers the given NamedMongoScript in the database.

Method Detail

register

NamedMongoScript register(ExecutableMongoScript script)

Store given ExecutableMongoScript generating a syntheitcal name so that it can be called by it subsequently.

Parameters:

script - must not be null.

Returns:

NamedMongoScript with name under which the JavaScript function can be called.

register

NamedMongoScript register(NamedMongoScript script)

Registers the given NamedMongoScript in the database.

Parameters:

script - the NamedMongoScript to be registered.

Returns:

execute

@Nullable
Object execute(ExecutableMongoScript script,
                         Object... args)

Executes the script by either calling it via its name or directly sending it.

Parameters:

script - must not be null.

args - arguments to pass on for script execution.

Returns:

the script evaluation result.

Throws:

DataAccessException

call

@Nullable
Object call(String scriptName,
                      Object... args)

Call the JavaScript by its name.

Parameters:

scriptName - must not be null or empty.

args -

Returns:

exists

boolean exists(String scriptName)

Checks DB for existence of ServerSideJavaScript with given name.

Parameters:

scriptName - must not be null or empty.

Returns:

false if no ServerSideJavaScript with given name exists.

getScriptNames

Set<String> getScriptNames()

Returns names of JavaScript functions that can be called.

Returns:

empty Set if no scripts found.