@Description("Performs consistency check on given index") String checkConsistency(@Name("indexPath") String indexPath, @Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;
@Description("run") @Impact(ImpactOption.INFO) void run(@Name("timeout") @Description("how long?") long timeout); }
/** * Get the estimated number of nodes below a given path. * * @param path the path * @return the estimated number of nodes, or -1 if unknown (if not index is * available) */ @Description("Get the estimated number of nodes below a given path.") long getEstimatedNodeCount( @Description("the path") @Name("path") String path);
boolean importIndex( @Name("indexDirPath") @Description("Path on server file system where index content generated by oak-run is present") String indexDirPath, @Name("ignoreLocalLock") @Description("Useful for importing generated content during startup when IndexMBean instances" + " might not be available") boolean ignoreLocalLock ) throws IOException, CommitFailedException; }
/** * Initiate a data store garbage collection operation. * * @param markOnly whether to only mark references and not sweep in the mark and sweep operation. * @return the status of the operation right after it was initiated */ CompositeData startBlobGC(@Name("markOnly") @Description("Set to true to only mark references and not sweep in the mark and sweep operation. " + "This mode is to be used when the underlying BlobStore is shared between multiple " + "different repositories. For all other cases set it to false to perform full garbage collection") boolean markOnly);
boolean importIndex( @Name("indexDirPath") @Description("Path on server file system where index content generated by oak-run is present") String indexDirPath, @Name("ignoreLocalLock") @Description("Useful for importing generated content during startup when IndexMBean instances" + " might not be available") boolean ignoreLocalLock ) throws IOException, CommitFailedException; }
/** * Get the estimated number of nodes below a given path. * * @param path the path * @return the estimated number of nodes, or -1 if unknown (if not index is * available) */ @Description("Get the estimated number of nodes below a given path.") long getEstimatedNodeCount( @Description("the path") @Name("path") String path);
@Description("Retrieves the fields, and number of documents for each field, for an index. " + "This allows to investigate what is stored in the index.") String[] getFieldInfo( @Name("indexPath") @Description("The index path (empty for all indexes)") String indexPath ) throws IOException;
boolean importIndex( @Name("indexDirPath") @Description("Path on server file system where index content generated by oak-run is present") String indexDirPath, @Name("ignoreLocalLock") @Description("Useful for importing generated content during startup when IndexMBean instances" + " might not be available") boolean ignoreLocalLock ) throws IOException, CommitFailedException; }
/** * Initiate a data store garbage collection operation. * * @param markOnly whether to only mark references and not sweep in the mark and sweep operation. * @return the status of the operation right after it was initiated */ CompositeData startBlobGC(@Name("markOnly") @Description("Set to true to only mark references and not sweep in the mark and sweep operation. " + "This mode is to be used when the underlying BlobStore is shared between multiple " + "different repositories. For all other cases set it to false to perform full garbage collection") boolean markOnly);
@Description("Performs consistency check on given index") String checkConsistency(@Name("indexPath") String indexPath, @Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;
/** * Initiate a data store garbage collection operation. * * @param markOnly whether to only mark references and not sweep in the mark and sweep operation. * @return the status of the operation right after it was initiated */ CompositeData startBlobGC(@Name("markOnly") @Description("Set to true to only mark references and not sweep in the mark and sweep operation. " + "This mode is to be used when the underlying BlobStore is shared between multiple " + "different repositories. For all other cases set it to false to perform full garbage collection") boolean markOnly);
/** * Splits the current indexing tasks into 2, indexes that are passed in as * an input will have their 'async' property updated to * {@code newIndexTaskName}. * * Note that this call will *not* bootstrap a new indexing task for the * given name. */ void splitIndexingTask( @Name("paths") @Description("Comma separated list of paths of the index definitions") String paths, @Name("newIndexTaskName") @Description("The indexing task name set on the async property") String newIndexTaskName);
/** * Splits the current indexing tasks into 2, indexes that are passed in as * an input will have their 'async' property updated to * {@code newIndexTaskName}. * * Note that this call will *not* bootstrap a new indexing task for the * given name. */ void splitIndexingTask( @Name("paths") @Description("Comma separated list of paths of the index definitions") String paths, @Name("newIndexTaskName") @Description("The indexing task name set on the async property") String newIndexTaskName);
/** * Get the estimated number of nodes below a given path. * * @param path the path * @return the estimated number of nodes, or -1 if unknown (if not index is * available) */ @Description("Get the estimated number of nodes below a given path.") long getEstimatedNodeCount( @Description("the path") @Name("path") String path);
@Description("Performs consistency check for all Lucene indexes and reports true if all indexes are found " + "to be valid. False if any one of them was not found to be valid") boolean checkConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;
@Description("Performs consistency check for all Lucene indexes and reports in simple format") String[] checkAndReportConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;
@Description("Performs consistency check for all Lucene indexes and reports true if all indexes are found " + "to be valid. False if any one of them was not found to be valid") boolean checkConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;
/** * Splits the current indexing tasks into 2, indexes that are passed in as * an input will have their 'async' property updated to * {@code newIndexTaskName}. * * Note that this call will *not* bootstrap a new indexing task for the * given name. */ void splitIndexingTask( @Name("paths") @Description("Comma separated list of paths of the index definitions") String paths, @Name("newIndexTaskName") @Description("The indexing task name set on the async property") String newIndexTaskName);
@Description("Performs consistency check for all Lucene indexes and reports in simple format") String[] checkAndReportConsistencyOfAllIndexes(@Name("fullCheck") @Description("If set to true a full check would be performed which can be slow as " + "it reads all index files. If set to false a quick check is performed to " + "check if all blobs referred in index files are present in BlobStore") boolean fullCheck) throws IOException;