com.illumon.iris.db.util.IrisDbPythonSession

All Implemented Interfaces:: ScriptSession

public class IrisDbPythonSession
extends Object
implements ScriptSession

A ScriptSession that uses a JPy cpython interpreter internally. This is used for persistent queries or the DB console; Python code running remotely uses WorkerPythonEnvironment for it's supporting structures.

Field Summary

Fields

Modifier and Type Field Description

static String SCRIPT_TYPE

Constructor Summary

Constructors
Constructor	Description
`IrisDbPythonSession(com.fishlib.io.logger.Logger log, Database database, boolean runInitScripts)`	Create a Python ScriptSession.
`IrisDbPythonSession(PythonScope<?> scope)`	Creates a Python "`ScriptSession`", for use where we should only be reading from the scope, such as an IPython kernel session.

Method Summary

Modifier and Type	Method	Description
`void`	`clearScriptPathLoader()`	Removes the currently configured script path loader from this script.
`void`	`evaluate(String command)`	Evaluates command in the context of the current ScriptSession.
`void`	`evaluate(String command, String scriptName)`	Evaluates command in the context of the current ScriptSession.
`Object`	`getVariable(String name)`	Retrieve a variable from the script session's bindings.
`<T> T`	`getVariable(String name, T defaultValue)`	Retrieve a variable from the script session's bindings.
`Set<String>`	`getVariableNames()`	Retrieves all of the variable names present in the session's scope
`Map<String,Object>`	`getVariables()`	Retrieves all of the variables present in the session's scope (e.g., Groovy binding, Python globals()).
`boolean`	`hasVariableName(String name)`	Check if the scope has the given variable name
`void`	`onPersistentQueryInitializationBegin(Supplier<ScriptPathLoader> pathLoader, ScriptPathLoaderState scriptLoaderState)`	Called before PersistentQuery initialization, should setup sourcing from the controller (as required).
`void`	`onPersistentQueryInitializationEnd()`	Called after PersistentQuery initialization.
`String`	`scriptType()`
`void`	`setScriptPathLoader(Supplier<ScriptPathLoader> scriptPathLoader, boolean caching)`	Sets the scriptPathLoader that is in use for this session.
`boolean`	`setUseOriginalScriptLoaderState(boolean useOriginal)`	Informs the session whether or not we should be using the original ScriptLoaderState for source commands.
`void`	`setVariable(String name, Object value)`	Inserts a value into the script's scope.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.illumon.iris.db.util.ScriptSession

sanitizeThrowable

Field Details
- SCRIPT_TYPE
  
  public static String SCRIPT_TYPE
Constructor Details
- IrisDbPythonSession
  
  public IrisDbPythonSession(com.fishlib.io.logger.Logger log, Database database, boolean runInitScripts) throws IOException
  
  Create a Python ScriptSession.
  
  Parameters:
  
  log - the log to use for script session errors, info; as well as the Python interpreter's stdout/stderr
  
  database - the database to insert into the script session's bindings.
  
  runInitScripts - if init scripts should be executed
  
  Throws:
  
  IOException - if an IO error occurs running initialization scripts
- IrisDbPythonSession
  
  public IrisDbPythonSession(PythonScope<?> scope)
  
  Creates a Python "ScriptSession", for use where we should only be reading from the scope, such as an IPython kernel session.
Method Details
- getVariable
  
  public Object getVariable(String name) throws QueryScope.MissingVariableException
  
  Description copied from interface: ScriptSession
  
  Retrieve a variable from the script session's bindings.
  
  Specified by:
  
  getVariable in interface ScriptSession
  
  Parameters:
  
  name - the variable to retrieve
  
  Returns:
  
  the variable
  
  Throws:
  
  QueryScope.MissingVariableException - if the variable does not exist
- getVariable
  
  public <T> T getVariable(String name, T defaultValue)
  
  Description copied from interface: ScriptSession
  
  Retrieve a variable from the script session's bindings. If the variable is not present, return defaultValue. If the variable is present, but is not of type (T), a ClassCastException may result.
  
  Specified by:
  
  getVariable in interface ScriptSession
  
  Type Parameters:
  
  T - the type of the variable
  
  Parameters:
  
  name - the variable to retrieve
  
  defaultValue - the value to use when no value is present in the session's scope
  
  Returns:
  
  the value of the variable, or defaultValue if not present
- evaluate
  
  public void evaluate(String command)
  
  Description copied from interface: ScriptSession
  
  Evaluates command in the context of the current ScriptSession.
  
  Specified by:
  
  evaluate in interface ScriptSession
  
  Parameters:
  
  command - the command to evaluate
- evaluate
  
  public void evaluate(String command, String scriptName)
  
  Description copied from interface: ScriptSession
  
  Evaluates command in the context of the current ScriptSession.
  
  Specified by:
  
  evaluate in interface ScriptSession
  
  Parameters:
  
  command - the command to evaluate
  
  scriptName - an optional script name, which may be ignored by the implementation, or used improve error messages or for other internal purposes
- getVariables
  
  public Map<String,Object> getVariables()
  
  Description copied from interface: ScriptSession
  
  Retrieves all of the variables present in the session's scope (e.g., Groovy binding, Python globals()).
  
  Specified by:
  
  getVariables in interface ScriptSession
  
  Returns:
  
  an unmodifiable map with variable names as the keys, and the Objects as the result
- getVariableNames
  
  public Set<String> getVariableNames()
  
  Description copied from interface: ScriptSession
  
  Retrieves all of the variable names present in the session's scope
  
  Specified by:
  
  getVariableNames in interface ScriptSession
  
  Returns:
  
  an unmodifiable set of variable names
- hasVariableName
  
  public boolean hasVariableName(String name)
  
  Description copied from interface: ScriptSession
  
  Check if the scope has the given variable name
  
  Specified by:
  
  hasVariableName in interface ScriptSession
  
  Parameters:
  
  name - the variable name
  
  Returns:
  
  True iff the scope has the given variable name
- setVariable
  
  public void setVariable(String name, Object value)
  
  Description copied from interface: ScriptSession
  
  Inserts a value into the script's scope.
  
  Specified by:
  
  setVariable in interface ScriptSession
  
  Parameters:
  
  name - the variable name to set
  
  value - the new value of the variable
- scriptType
  
  public String scriptType()
  
  Specified by:
  
  scriptType in interface ScriptSession
  
  Returns:
  
  a textual description of this script session's language for use in messages.
- onPersistentQueryInitializationBegin
  
  public void onPersistentQueryInitializationBegin(Supplier<ScriptPathLoader> pathLoader, ScriptPathLoaderState scriptLoaderState)
  
  Description copied from interface: ScriptSession
  
  Called before PersistentQuery initialization, should setup sourcing from the controller (as required).
  
  Specified by:
  
  onPersistentQueryInitializationBegin in interface ScriptSession
- onPersistentQueryInitializationEnd
  
  public void onPersistentQueryInitializationEnd()
  
  Description copied from interface: ScriptSession
  
  Called after PersistentQuery initialization.
  
  Specified by:
  
  onPersistentQueryInitializationEnd in interface ScriptSession
- setScriptPathLoader
  
  public void setScriptPathLoader(Supplier<ScriptPathLoader> scriptPathLoader, boolean caching)
  
  Description copied from interface: ScriptSession
  
  Sets the scriptPathLoader that is in use for this session.
  
  Specified by:
  
  setScriptPathLoader in interface ScriptSession
  
  Parameters:
  
  scriptPathLoader - a supplier of a script path loader
  
  caching - whether the source operation should cache results
- clearScriptPathLoader
  
  public void clearScriptPathLoader()
  
  Description copied from interface: ScriptSession
  
  Removes the currently configured script path loader from this script.
  
  Specified by:
  
  clearScriptPathLoader in interface ScriptSession
- setUseOriginalScriptLoaderState
  
  public boolean setUseOriginalScriptLoaderState(boolean useOriginal)
  
  Description copied from interface: ScriptSession
  
  Informs the session whether or not we should be using the original ScriptLoaderState for source commands.
  
  Specified by:
  
  setUseOriginalScriptLoaderState in interface ScriptSession
  
  Parameters:
  
  useOriginal - whether to use the script loader state at persistent query initialization

Class IrisDbPythonSession

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.illumon.iris.db.util.ScriptSession

Field Details

Constructor Details

Method Details