Packages

package runtime

Type Members

  1. case class MagpieRows(schema: StructType, rows: Array[Row] = Array(), totalCount: Option[Long] = None) extends MagpieResultSet with SparkSchemaUtils with Product with Serializable

    A collection of rows returned from a magpie command, optionally including the total count of the source data set.

    A collection of rows returned from a magpie command, optionally including the total count of the source data set.

    schema

    the schema of the source data set

    rows

    the spark rows returned by the command, with columns converted to strings for display

    totalCount

    the total size of the source data set for the command

  2. class MagpieRuntimeException extends MagpieException with ShowStackTrace

    A generic exception thrown when a problem occurs during command execution.

  3. class MagpieServiceException extends MagpieRuntimeException
  4. class SecretContext extends MagpieStringUtils

    A context object for accessing Magpie Secrets.

    A context object for accessing Magpie Secrets.

    Available via the secrets field on the MagpieContext

    Example usage:

    scala> mc.secrets.list()
    res0: Seq[String] = List(api_key, password)
    
    scala> mc.secrets.exists("api_key")
    res1: Boolean = true
    
    scala> mc.secrets.get("api_key")
    res2: String = my_api_key_contents
  5. class VariableContext extends MagpieStringUtils

    A context object that stores and provides access to variables.

    A context object that stores and provides access to variables.

    Available via the variables field on the MagpieContext

    Example usage:

    scala> mc.variables.set("my_var", 5)
    
    scala> mc.variables.get("my_var")
    res1: Integer = 5
    
    scala> mc.variables.exists("my_var")
    res2: Boolean = mtrue
    
    scala> mc.variables.clear()

Ungrouped