-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Refactor] Introduce flint-commons for models and interfaces (#373)
* [Refactor] Introduce flint-data for model and interface Signed-off-by: Louis Chu <[email protected]> * Uppercase for constant Signed-off-by: Louis Chu <[email protected]> * Address comments Signed-off-by: Louis Chu <[email protected]> * Rename package Signed-off-by: Louis Chu <[email protected]> --------- Signed-off-by: Louis Chu <[email protected]>
- Loading branch information
Showing
11 changed files
with
346 additions
and
218 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
flint-commons/src/main/scala/org/opensearch/flint/data/ContextualDataStore.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.flint.data | ||
|
|
||
| /** | ||
| * Provides a mutable map to store and retrieve contextual data using key-value pairs. | ||
| */ | ||
| trait ContextualDataStore { | ||
|
|
||
| /** Holds the contextual data as key-value pairs. */ | ||
| var context: Map[String, Any] = Map.empty | ||
|
|
||
| /** | ||
| * Adds a key-value pair to the context map. | ||
| */ | ||
| def setContextValue(key: String, value: Any): Unit = { | ||
| context += (key -> value) | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves the value associated with a key from the context map. | ||
| */ | ||
| def getContextValue(key: String): Option[Any] = { | ||
| context.get(key) | ||
| } | ||
| } |
87 changes: 87 additions & 0 deletions
87
flint-commons/src/main/scala/org/opensearch/flint/data/FlintStatement.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package org.opensearch.flint.data | ||
|
|
||
| import org.json4s.{Formats, NoTypeHints} | ||
| import org.json4s.JsonAST.JString | ||
| import org.json4s.native.JsonMethods.parse | ||
| import org.json4s.native.Serialization | ||
|
|
||
| object StatementStates { | ||
| val RUNNING = "running" | ||
| val SUCCESS = "success" | ||
| val FAILED = "failed" | ||
| val WAITING = "waiting" | ||
| } | ||
|
|
||
| /** | ||
| * Represents a statement processed in the Flint job. | ||
| * | ||
| * @param state | ||
| * The current state of the statement. | ||
| * @param query | ||
| * SQL-like query string that the statement will execute. | ||
| * @param statementId | ||
| * Unique identifier for the type of statement. | ||
| * @param queryId | ||
| * Unique identifier for the query. | ||
| * @param submitTime | ||
| * Timestamp when the statement was submitted. | ||
| * @param error | ||
| * Optional error message if the statement fails. | ||
| * @param statementContext | ||
| * Additional context for the statement as key-value pairs. | ||
| */ | ||
| class FlintStatement( | ||
| var state: String, | ||
| val query: String, | ||
| // statementId is the statement type doc id | ||
| val statementId: String, | ||
| val queryId: String, | ||
| val submitTime: Long, | ||
| var error: Option[String] = None, | ||
| statementContext: Map[String, Any] = Map.empty[String, Any]) | ||
| extends ContextualDataStore { | ||
| context = statementContext | ||
|
|
||
| def running(): Unit = state = StatementStates.RUNNING | ||
| def complete(): Unit = state = StatementStates.SUCCESS | ||
| def fail(): Unit = state = StatementStates.FAILED | ||
| def isRunning: Boolean = state == StatementStates.RUNNING | ||
| def isComplete: Boolean = state == StatementStates.SUCCESS | ||
| def isFailed: Boolean = state == StatementStates.FAILED | ||
| def isWaiting: Boolean = state == StatementStates.WAITING | ||
|
|
||
| // Does not include context, which could contain sensitive information. | ||
| override def toString: String = | ||
| s"FlintStatement(state=$state, query=$query, statementId=$statementId, queryId=$queryId, submitTime=$submitTime, error=$error)" | ||
| } | ||
|
|
||
| object FlintStatement { | ||
|
|
||
| implicit val formats: Formats = Serialization.formats(NoTypeHints) | ||
|
|
||
| def deserialize(statement: String): FlintStatement = { | ||
| val meta = parse(statement) | ||
| val state = (meta \ "state").extract[String] | ||
| val query = (meta \ "query").extract[String] | ||
| val statementId = (meta \ "statementId").extract[String] | ||
| val queryId = (meta \ "queryId").extract[String] | ||
| val submitTime = (meta \ "submitTime").extract[Long] | ||
| val maybeError: Option[String] = (meta \ "error") match { | ||
| case JString(str) => Some(str) | ||
| case _ => None | ||
| } | ||
|
|
||
| new FlintStatement(state, query, statementId, queryId, submitTime, maybeError) | ||
| } | ||
|
|
||
| def serialize(flintStatement: FlintStatement): String = { | ||
| // we only need to modify state and error | ||
| Serialization.write( | ||
| Map("state" -> flintStatement.state, "error" -> flintStatement.error.getOrElse(""))) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.