MagpieContext

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def about: MagpieInfo

Return information about the current Magpie session.
Return information about the current Magpie session.
returns
Magpie info
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exec(command: String): Any

Execute a single command and return the result.
Execute a single command and return the result. Alias for execute.
command
command string to execute
returns
command result

See also
execute
def execute(command: String): Any

Execute a single command and return the result.
Execute a single command and return the result.
Commands return one of:
- Unit
- String (JSON)
- com.silectis.magpie.runtime.MagpieRows
```
mc.execute("save result as table people")
```
command
command string to execute
returns
command result
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getTableDataFrame(table: String): DataFrame

Get the data frame for a Magpie table, optionally qualified by schema.
Get the data frame for a Magpie table, optionally qualified by schema.
```
val df = mc.getTableDataFrame("people")
df.show()
```
table
table name
returns
table data frame
def getTokens(input: String): Seq[String]

Returns the tokens that are potentially substitutable in the provided command.
Returns the tokens that are potentially substitutable in the provided command.
input
a string containing 0 or more substitution tokens in the format "$#{type:name}". The legacy/shorthand format for variables is also supported ("$#varname")
returns
A de-duplicated list of tokens that are present 1 or more times in the provided command in the format "type:name". Variable tokens in the command that use the shorthand form are expanded to "variable:varname". Tokens are always lowercase

Attributes
protected
Definition Classes
SubstitutionUtils
def hasTokens(input: String): Boolean

Checks if the provided input contains any tokens
Checks if the provided input contains any tokens
input
The string to test
returns
True if the input string contains 1 or more replacable tokens

Attributes
protected
Definition Classes
SubstitutionUtils
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpret(command: String): Unit

Execute the provided command and render the result visually
Execute the provided command and render the result visually
For example, to render the first 100 rows of the table people:
```
mc.interpret("show 100 from people")
```
command
command to execute
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def profile(df: DataFrame): Unit

Profile a data frame and render the profile visually
Profile a data frame and render the profile visually
```
mc.profile(df)
```
df
data frame
def replaceSubstitutesWithPlaceholders(input: String): String

Replaces any substitute tokens in the given string with the token's name
Replaces any substitute tokens in the given string with the token's name
input
a string containing 0 or more tokens
returns
a String with the tokens replaced by the name of the substitute reference by the token

Attributes
protected
Definition Classes
SubstitutionUtils
def result: DataFrame

Get the last result as a spark data frame
Get the last result as a spark data frame
```
mc.sql("select * from people")
val people = mc.result.collect()
```
returns
result data frame
val secrets: SecretContext

SecretContext with methods for interacting with Magpie Secrets
def sql(sql: String): DataFrame

Execute a SQL command, returning the resulting data frame.
Execute a SQL command, returning the resulting data frame.
```
val df = mc.sql("select distinct name from people")
```
sql
SQL statement
returns
data frame result
def substituteInCommand(command: String, substitutes: Seq[Substitute]): SubstitutionResult

Inserts the provided substitutes into the provided command string.
Inserts the provided substitutes into the provided command string. Script comments will be stripped from the returned string.
Will throw a MagpieParsingException if no suitable substitute exists for a token
command
A string containing 0 or more substitute tokens, which may be in full or variable shorthand notation (See SubstitutionUtils.getTokens() for more details on token syntax)
substitutes
A sequence of unencrypted substitute objects
returns
A String with the substitute tokens replaced by their corresponding values

Attributes
protected
Definition Classes
SubstitutionUtils
def substituteInText(text: String, substitutes: Seq[Substitute]): SubstitutionResult

Inserts the provided substitutes into the provided text string
Inserts the provided substitutes into the provided text string
Will throw a MagpieParsingException if no suitable substitute exists for a token
text
A string containing 0 or more substitute tokens, which may be in full or variable shorthand notation (See SubstitutionUtils.getTokens() for more details on token syntax)
substitutes
A sequence of unencrypted substitute objects
returns
A String with the substitute tokens replaced by their corresponding values

Attributes
protected
Definition Classes
SubstitutionUtils
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toCamelCase(s: String): String

Converts CapitalCamelCase to camelCase
Converts CapitalCamelCase to camelCase
s
to string to be converted
returns
a camelCase string

Attributes
protected
Definition Classes
MagpieStringUtils
def toString(): String

Definition Classes
AnyRef → Any
def toSubstitute(s: Secret): Substitute

Definition Classes
SubstitutionUtils
def toSubstitute(v: Variable): Substitute

Definition Classes
SubstitutionUtils
val variables: VariableContext

VariableContext with methods for interacting with Magpie Variables
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def clearVariable(name: String): Unit

Unset a particular variable in the context.
Unset a particular variable in the context.
name
variable name

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Moved to mc.variables.remove()
def clearVariables(): Unit

Clear all variables in the context.
Clear all variables in the context.

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Moved to mc.variables.clear()
def getVariable(name: String): Any

Get the value of a variable.
Get the value of a variable.
name
variable name
returns
variable value

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Moved to mc.variables.get()
def hasVariable(name: String): Boolean

Determine whether a variable is defined on the context.
Determine whether a variable is defined on the context.
name
variable name
returns
whether the variable is defined

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Moved to mc.variables.exists()
def printVariables(): String

Get a listing of all variables defined on the context and their values.
Get a listing of all variables defined on the context and their values.
returns
variable listing

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Use mc.variables.list() instead
def setVariable(name: String, value: Any): Unit

Set a variable to the given value in the context.
Set a variable to the given value in the context.
name
variable name
value
variable value

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.21.0) Moved to mc.variables.set()
def substituteVariables(input: String): String

Substitute any variables present in the input string with current values stored in the context.
Substitute any variables present in the input string with current values stored in the context.
An exception is thrown if any variables are not able to be matched.
Note: substitution is performed automatically on arguments passed to MagpieContext.execute, MagpieContext.exec, and MagpieContext.sql.
input
input string
returns
string with variables substituted for their values

Definition Classes
LegacyVariableContext
Annotations
@deprecated
Deprecated
(Since version v1.20.0) Variables are automatically substituted by the .exec, .execute, and .sql methods

Related Doc: package magpie

final class MagpieContext extends LegacyVariableContext

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def about: MagpieInfo

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exec(command: String): Any

def execute(command: String): Any

def finalize(): Unit

final def getClass(): Class[_]

def getTableDataFrame(table: String): DataFrame

def getTokens(input: String): Seq[String]

def hasTokens(input: String): Boolean

def hashCode(): Int

def interpret(command: String): Unit

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def profile(df: DataFrame): Unit

def replaceSubstitutesWithPlaceholders(input: String): String

def result: DataFrame

val secrets: SecretContext

def sql(sql: String): DataFrame

def substituteInCommand(command: String, substitutes: Seq[Substitute]): SubstitutionResult

def substituteInText(text: String, substitutes: Seq[Substitute]): SubstitutionResult

final def synchronized[T0](arg0: ⇒ T0): T0

def toCamelCase(s: String): String

def toString(): String

def toSubstitute(s: Secret): Substitute

def toSubstitute(v: Variable): Substitute

val variables: VariableContext

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def clearVariable(name: String): Unit

def clearVariables(): Unit

def getVariable(name: String): Any

def hasVariable(name: String): Boolean

def printVariables(): String

def setVariable(name: String, value: Any): Unit

def substituteVariables(input: String): String

Inherited from LegacyVariableContext

Inherited from MagpieStringUtils

Inherited from SubstitutionUtils

Inherited from AnyRef

Inherited from Any

Ungrouped