Package org.gorpipe.spark.platform

Class GorQuery

  • public class GorQuery
extends java.lang.Object

    • Field Detail

      • FLAG_PRESERVE

        public static final java.lang.String FLAG_PRESERVE
        Execution flag - don't overwrite outfile (skip query). Affects initial query only.
        See Also:
        Constant Field Values

      • FLAG_HIGH_PRIORITY

        public static final java.lang.String FLAG_HIGH_PRIORITY
        Execution flag - High priority. If set, overrides partition priority.
        See Also:
        Constant Field Values

      • FLAG_FORCE

        public static final java.lang.String FLAG_FORCE
        Execution flag - force overwrite on all subqueries.
        See Also:
        Constant Field Values

      • REQUEST_ID_FIELD

        public static final java.lang.String REQUEST_ID_FIELD
        See Also:
        Constant Field Values

      • fieldsToEncode

        public static final java.util.Set<java.lang.String> fieldsToEncode

    • Constructor Detail

      • GorQuery

        public GorQuery()

      • GorQuery

        public GorQuery​(java.util.Map<java.lang.String,​java.lang.String> parms)

    • Method Detail

      • getQuery

        public java.lang.String getQuery()

      • setQuery

        public void setQuery​(java.lang.String query)

      • getOriginalQuery

        public java.lang.String getOriginalQuery()

      • setOriginalQuery

        public void setOriginalQuery​(java.lang.String query)

      • getQuerySource

        public java.lang.String getQuerySource()

      • setQuerySource

        public void setQuerySource​(java.lang.String requestID)

      • getRequestId

        public java.lang.String getRequestId()

      • setRequestId

        public void setRequestId​(java.lang.String requestID)

      • setPartition

        public void setPartition​(java.lang.String partition)

      • getPartition

        public java.lang.String getPartition()

      • getOutfile

        public java.lang.String getOutfile()

      • setOutfile

        public void setOutfile​(java.lang.String outfile)

      • getProjectId

        public int getProjectId()

      • setProjectId

        public void setProjectId​(int prjId)

      • getFlags

        public java.lang.String getFlags()

      • setFlags

        public void setFlags​(java.lang.String flags)
        Set flags: P - preserve, dont overwrite outfile

      • toMap

        public java.util.Map<java.lang.String,​java.lang.String> toMap()

      • isFlagSet

        public boolean isFlagSet​(java.lang.String flag)

      • setFlag

        public void setFlag​(java.lang.String flag)

      • getProjectRoot

        public java.lang.String getProjectRoot()

      • setProjectRoot

        public void setProjectRoot​(java.lang.String projectRoot)

      • getFingerprint

        public java.lang.String getFingerprint()

      • setExtension

        public void setExtension​(java.lang.String ext)
        Set desired extension
        Parameters:
        ext - Extension with . (e.g. ".gor" or ".gorz")

      • blankNull

        public static java.lang.String blankNull​(java.lang.String s)

      • getExtension

        public java.lang.String getExtension()

      • setFingerprint

        public void setFingerprint​(java.lang.String fingerprint)

      • getLockName

        public java.lang.String getLockName()

      • getProject

        public java.lang.String getProject()

      • setProject

        public void setProject​(java.lang.String projectName)

      • useCache

        public boolean useCache()

      • getOutfilePath

        public java.lang.String getOutfilePath()

      • setSecurityContextKey

        public void setSecurityContextKey​(java.lang.String securityContextKey)

      • getSecurityContextKey

        public java.lang.String getSecurityContextKey()

      • getUser

        public java.lang.String getUser()

      • setUser

        public void setUser​(java.lang.String userName)

      • getQueryTimeout

        public long getQueryTimeout()

      • setQueryTimeout

        public void setQueryTimeout​(long milliseconds)

      • getTime

        public java.lang.Long getTime()
        Submission time (if available) in seconds from Jan 1st 1970 (i.e. like System.currentTimeMillis()/1000)

      • setTime

        public void setTime​(java.lang.Long time)

      • hasQueryStatistics

        public boolean hasQueryStatistics()

      • setResultCacheExpirationMs

        public void setResultCacheExpirationMs​(long milliseconds)
        Sets the time in ms from now that the query result could be evicted from cache.
        Parameters:
        milliseconds -

      • getResultCacheExpirationMs

        public long getResultCacheExpirationMs()
        Gets the time in ms from now that the query result could be evicted from cache. Until then it's highly unlikely, but possible to be evicted

      • setExecutionStartTime

        public void setExecutionStartTime​(long milliseconds)
        Set the execution start time in ms, when the query execution engine started executing this query
        Parameters:
        milliseconds -

      • getExecutionStartTime

        public long getExecutionStartTime()
        Set the execution start time in ms, when the query execution engine started executing this query
        Returns:

      • setExecutionEndTime

        public void setExecutionEndTime​(long milliseconds)
        Set the execution end time in ms, when the query execution engine stopped executing this query
        Parameters:
        milliseconds -

      • getExecutionEndTime

        public long getExecutionEndTime()
        Set the execution end time in ms, when the query execution engine stopped executing this query
        Returns:

      • setByteCount

        public void setByteCount​(long bytes)
        Set the number of bytes the query returned
        Parameters:
        bytes -

      • getByteCount

        public long getByteCount()
        Get the number of bytes the query returned
        Returns:

      • setLineCount

        public void setLineCount​(long lines)
        Set the number of lines the query returned
        Parameters:
        lines -

      • getLineCount

        public long getLineCount()
        Get the number of lines the query returned
        Returns:

      • setColumnCount

        public void setColumnCount​(int columns)
        Set the number of Columns the query returned
        Parameters:
        columns -

      • isStringInt

        public static boolean isStringInt​(java.lang.String s)
        Parameters:
        s -
        Returns:
        returns true if the String is an int number.

      • isStringLong

        public static boolean isStringLong​(java.lang.String s)
        Parameters:
        s -
        Returns:
        returns true if the String is a long number.

      • getColumnCount

        public int getColumnCount()
        Get the number of Columns the query returned
        Returns:

      • hasColumnCount

        public boolean hasColumnCount()

      • hasLineCount

        public boolean hasLineCount()

      • hasByteCount

        public boolean hasByteCount()

      • hasExecutionEndTime

        public boolean hasExecutionEndTime()

      • hasExecutionStartTime

        public boolean hasExecutionStartTime()

      • hasResultCacheExpirationMs

        public boolean hasResultCacheExpirationMs()

      • overwriteExisting

        public boolean overwriteExisting()
        Tell if existing results (if present) should be overwritten. By default - cached results are reused, specified outfile is overwritten. If Force flag is set - all results are overwritten. If Preserve flag is set - it controls whether outfile specified in query is overwritten or not.