Packages

class Processor extends AnyRef

Sclera statement processor

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Processor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Processor(schemaDbms: String, schemaDb: String, schemaDbConfig: List[(String, String)], tempDbms: String, tempDb: String, tempDbConfig: List[(String, String)], checkSchema: Boolean)

    schemaDbms

    DBMS to be used to store Sclera's schema tables

    schemaDb

    Designated database in the schema DBMS specified above

    schemaDbConfig

    Configuration for the schema DBMS connection

    tempDbms

    DBMS to be used to store temporary tables

    tempDb

    Designated database in the temporary DBMS specified above

    tempDbConfig

    Configuration for the temporary DBMS connection

    checkSchema

    Check schema during initialization

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addTable(tableId: TableId, tableOpt: Option[Table]): Unit

    Add an external table to the schema

    Add an external table to the schema

    tableId

    The id to be assigned to the table

    tableOpt

    Specification of the table to be added, if different from that provided by the underlying system

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def baseTables(locIdOpt: Option[LocationId]): List[(SchemaTable, DbObjectDuration)]

    List of base tables at a location (all locations if not specified)

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def close(): Unit

    Clean up and free allocated resources

  9. def createDbObject(sqlDbObj: SqlDbObject, duration: DbObjectDuration): SchemaObject

    Create a database object

    Create a database object

    sqlDbObj

    Specification of the database object to be created

    duration

    Preferred duration of the object, temporary or permanent

  10. def createExt(dataTarget: ExternalTarget, relExpr: RelExpr): Unit

    Create an external target and populate with the result of evaluating the relational expression

    Create an external target and populate with the result of evaluating the relational expression

    dataTarget

    External target to be created and populated

    relExpr

    Relational expression to be evaluated

  11. def createIndex(stmt: SqlCreateIndex, dur: DbObjectDuration = Persistent): Unit

    Create an index

    Create an index

    stmt

    Specification of the index

    dur

    Duration of the index, temporary or permanent

  12. def createMLObject(libOpt: Option[String], sqlMLObj: SqlMLObject, trainRelExpr: RelExpr, duration: DbObjectDuration): SchemaMLObject

    Create a machine learning object

    Create a machine learning object

    libOpt

    The underlying machine learning library, use the default library if not specified

    sqlMLObj

    Specification of the object to be created

    trainRelExpr

    Relational expression -- is evaluated and the result is used for training the object

    duration

    Preferred duration of the object, temporary or permanent

  13. def createTable(name: String, relExpr: RelExpr, duration: DbObjectDuration, locIdOpt: Option[LocationId]): SchemaTable

    Create a table containing the result of evaluating a relational expression.

    Create a table containing the result of evaluating a relational expression.

    duration

    Preferred duration of the table, temporary or permanent

    locIdOpt

    Preferred location on which to create the table, use the most convenient location if None. Evaluation * takes care of cross-location data transfer when needed.

    returns

    Schema entry of the created table

  14. def createTable(table: Table, duration: DbObjectDuration, locIdOpt: Option[LocationId]): SchemaTable

    Create an empty table

    Create an empty table

    table

    Specification of the table to be created

    duration

    Preferred duration of the table, temporary or permanent

    locIdOpt

    Location on which to create the table, use default location if None.

    returns

    Schema entry of the created table

  15. def createTable(table: Table, duration: DbObjectDuration, locIdOpt: Option[LocationId], relExprOpt: Option[RelExpr]): SchemaTable

    Create a table and populate with the result of evaluating a relational expression.

    Create a table and populate with the result of evaluating a relational expression.

    table

    Specification of the table to be created

    duration

    Preferred duration of the table, temporary or permanent

    locIdOpt

    Location on which to create the table, use default location if None.

    relExprOpt

    If specified, evaluate the expression and populate the table with the result

    returns

    Schema entry of the created table

  16. def createTableFromExpr(preparedRelExpr: RelExpr, tableName: String, duration: DbObjectDuration): SchemaTable

    Create a table containing the result of evaluating a prepared relational expression.

    Create a table containing the result of evaluating a prepared relational expression. Convenience method, not to be called directly by applications.

  17. def createTableFromTuples(dataColumns: List[Column], dataRows: Iterator[TableRow], dstLocId: LocationId, dstTableName: String, dstTableDuration: DbObjectDuration): SchemaTable

    Create a table containing the rows provided by the given iterator.

    Create a table containing the rows provided by the given iterator.

    dataColumns

    Columns metadata for the rows

    dataRows

    Iterator providing the rows for the table

    dstLocId

    Location of the created table

    dstTableName

    Name of the created table

    dstTableDuration

    Duration of the table -- temporary or permanent

    returns

    Schema entry of the created table

  18. def createView(name: String, expr: LogicalExpr, duration: DbObjectDuration): SchemaView

    Create a view

    Create a view

    name

    Name of the view to be created

    expr

    Logical expression underlying the view to be created

    duration

    Duration of the view -- temporary or permanent

    returns

    Schema entry of the created view

  19. def dataCacheLocation: Location

    Designated location for the data cache (needed for query evaluation)

  20. def delete(tableId: TableId, predExpr: ScalExpr = BoolConst(true)): Unit

    Delete rows from a table

    Delete rows from a table

    tableId

    Table from which the rows are to be deleted

    predExpr

    Predicate specifying the rows to be deleted -- if not specified, all rows in the table are deleted

  21. def drop(id: String): Unit

    Drop the object with the given id from the schema

  22. def drop(id: SchemaObjectId): Unit

    Drop the object with the given id from the schema

  23. def dropIndex(stmt: SqlDropIndex): Unit

    Drop the specified index

  24. def dropTemporaryObjects(): Unit

    Drop all temporary duration objects in the schema

  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. def executeNativeStatement(locId: LocationId, stmtStr: String): Unit

    Execute a native statement at the specified location

    Execute a native statement at the specified location

    locId

    Location at which to execute the given statement

    stmtStr

    The statement to be executed (not interpreted by Sclera)

  28. def explain(relExpr: RelExpr): TableResult

    A list of rows explaining the evaluation plan for the given relational expression, structured as a query result

  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def handleAdminQueryStatement(aqstmt: SqlAdminQueryStatement): TableResult

    Handle a parsed admin query statement

    Handle a parsed admin query statement

    aqstmt

    Parsed admin statement

    returns

    Result of evaluating the statement

  31. def handleAdminStatement(astmt: SqlAdminStatement): Unit

    Handle a parsed admin statement

    Handle a parsed admin statement

    astmt

    Parsed admin statement

  32. def handleListQuery[T](relExpr: RelExpr, f: (TableRow) => T): List[T]

    Handle a query specified as a relational expression.

    Handle a query specified as a relational expression. The result should be finite for the call to complete.

    relExpr

    Relational expression to be evaluated

    f

    Function to handle each row of the returned result

    returns

    The list of the values returned by the function f on each row

  33. def handleQuery[T](query: RelExpr, f: (TableResult) => T): T

    Handle a query specified as a relational expression

    Handle a query specified as a relational expression

    query

    Relational expression to be evaluated

    f

    Function to handle the returned result. The result should not be closed by the function, it will be closed automatically when done.

  34. def handleQueryStatement[T](qstmt: SqlRelQueryStatement, f: (TableResult) => T): T

    Handle a parsed query statement

    Handle a parsed query statement

    qstmt

    Parsed query statement

    f

    Function to handle the returned result. The result should not be closed by the function, it will be closed automatically when done.

  35. def handleSingletonQuery[T](relExpr: RelExpr, f: (TableRow) => T): Option[T]

    Handle a singleton query specified as a relational expression.

    Handle a singleton query specified as a relational expression. The query result should have at most one row.

    relExpr

    Relational expression to be evaluated

    f

    Function to handle the returned result. The result should not be closed by the function, it will be closed automatically when done.

    returns

    If the result is empty then None, otherwise the value computed by function f on the result row, wrapped in Some.

  36. def handleStatement(ustr: String): Unit

    Handle an update or admin statement

    Handle an update or admin statement

    ustr

    Statement string

  37. def handleStatement[T](qstr: String, f: (TableResult) => T): T

    Handle a query statement

    Handle a query statement

    qstr

    Query string

    f

    Function to handle the returned result. The result should not be closed by the function, it will be closed automatically when done.

  38. def handleUpdateStatement(ustmt: SqlUpdateStatement): Option[Int]

    Handle a parsed update statement

    Handle a parsed update statement

    ustmt

    Parsed update statement

    returns

    Number of rows affected, if available

  39. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def init(): Unit

    Initialize

  41. def insert(tableRef: TableRefTarget, dataColumns: List[Column], dataRows: Iterator[TableRow]): Unit

    Insert rows into a table

    Insert rows into a table

    tableRef

    Table into which the rows are to be inserted

    dataColumns

    Column metadata for the rows to be inserted

    dataRows

    Iterator providing the rows to be inserted

  42. def insert(tableRef: TableRefTarget, relExpr: RelExpr): Unit

    Evaluate a relational expression and insert the result into a table

    Evaluate a relational expression and insert the result into a table

    tableRef

    Table into which the result is to be inserted

    relExpr

    Relational expression to be evaluated

  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def listLocations: TableResult

    List of all the locations, structured as a query result

  45. def listObjects(dbObjects: List[(SchemaObject, DbObjectDuration)], format: Format): TableResult

    List the given objects in the given format

    List the given objects in the given format

    dbObjects

    List of objects with their duration

    format

    Output format

    returns

    The list in the specified format, structured as a query result

  46. def locationDbHandler(locationId: LocationId): DbHandler

    Handler for the specified location

  47. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. val normalizer: Normalizer

    Statement normalizer

  49. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. val parser: SqlParser

    ScleraSQL and admin statement parser

  52. val planExplain: PlanExplain

    Statement execution plan explainer (needed for EXPLAIN commands)

  53. def planQuery(expr: RelExpr, maxRowsOpt: Option[Int] = None): RelEvalPlan

    Plan the given query, with a limit on number of result rows if specified (needed by the JDBC driver)

  54. def planQuery(s: SqlRelQueryStatement, maxRowsOpt: Option[Int]): RelEvalPlan

    Plan the given query (needed by the JDBC driver)

  55. val planner: Planner

    Statement execution planner

  56. def queryResult(preparedRelExpr: RelExpr): TableResult

    Evaluate a prepared relational expression.

    Evaluate a prepared relational expression. Convenience method, not to be called directly by applications.

  57. def remainingTables(locIdOpt: Option[LocationId]): List[(SchemaTable, DbObjectDuration)]

    Tables at a location (all locations if not specified) not yet added to the schema

  58. def removeTable(tableId: TableId): Unit

    Remove the specified table from the schema

  59. val scalExprEvaluator: ScalExprEvaluator

    Scalar expression evaluator

  60. lazy val schema: Schema

    Associated schema object

  61. val schemaDb: String
  62. def showConfig: TableResult

    The list of configuration parameters, structured as a query result

  63. def showOptions: TableResult

    The list of configuration options, structured as a query result

  64. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  65. def toString(): String
    Definition Classes
    AnyRef → Any
  66. def updateBatch(stmts: List[SqlUpdateTable]): Unit

    Execute a batch of update statements

  67. def updateTable(stmt: SqlUpdateTable): Unit

    Update the rows of a table

  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped