Class CreateIndexStatementBuilder.CreateIndexStatement

    • Field Detail

      • f_sCache

        protected final String f_sCache
        The name of the cache the index will be added to.
    • Constructor Detail

      • CreateIndexStatement

        public CreateIndexStatement​(String sCache,
                                    ValueExtractor extractor)
        Construct a CreateIndexStatement that will create an index on the specified cache using the specified ValueExtractor.
        Parameters:
        sCache - the name of the cache to create the index on
        extractor - the ValueExtractor to use to create the index
    • Method Detail

      • execute

        public StatementResult execute​(ExecutionContext ctx)
        Description copied from interface: Statement
        Execute a CohQL query or command and return the relevant result.
        Parameters:
        ctx - the context to use
        Returns:
        a StatementResult containing the results of executing the statement
      • showPlan

        public void showPlan​(PrintWriter out)
        Description copied from interface: Statement
        Output to the provided PrintWriter a human readable trace of the actions that will be taken by this statement if or when executed.
        Parameters:
        out - the PrintWriter to write the trace to
      • sanityCheck

        public void sanityCheck​(ExecutionContext ctx)
        Description copied from interface: Statement
        Perform sanity checks on the statement that will be executed.

        Implementations can fail sanity checking by throwing an unchecked exception (RuntimeException).

        Specified by:
        sanityCheck in interface Statement
        Overrides:
        sanityCheck in class AbstractStatement
        Parameters:
        ctx - the context to use