export = CollectionController; /** * @class CollectionController */ declare class CollectionController extends NativeController { constructor(); defaultScrollTTL: string; /** * Updates the mapping of the collection * * @param {Request} request * @returns {Promise.} */ updateMapping(request: Request): Promise; /** * Get the collection mapping * * @param {Request} request * @returns {Promise.} */ getMapping(request: Request): Promise; /** * Get the collection settings * * @param {Request} request * @returns {Promise.} */ getSettings(request: Request): Promise; /** * Get the collection validation specifications * * @param {Request} request * @returns {Promise.} */ getSpecifications(request: Request): Promise; /** * Search for collection validation specifications * * @param {Request} request * @returns {Promise.} */ searchSpecifications(request: Request): Promise; /** * Scroll over a paginated search results * * @param {Request} request * @returns {Promise.} */ scrollSpecifications(request: Request): Promise; /** * Replace the specifications of a collection * * @param {Request} request * @returns {Promise.} */ updateSpecifications(request: Request): Promise; /** * Add a specification collections * * @param {Request} request * @returns {Promise.} */ deleteSpecifications(request: Request): Promise; /** * Validate a specification * * @param {Request} request * @returns {Promise.} */ validateSpecifications(request: Request): Promise; /** * Reset a collection by removing all documents while keeping the existing mapping * * @param {KuzzleRequest} request * @returns {Promise.} */ truncate(request: KuzzleRequest): Promise; /** * @param {Request} request * @returns {Promise.} */ list(request: Request): Promise; /** * @param {Request} request * @returns {Promise.} */ exists(request: Request): Promise; /** * Creates a new collection with the specifed mappings and settings. * Only update the mappings and settings if the collection exists. * * @param {Request} request * @returns {Promise.} */ create(request: Request): Promise; /** * Updates a collection mappings and settings. * * @param {Request} request * @returns {Promise.} */ update(request: Request): Promise; /** * Refresh a collection * * @param {Request} request * @returns {Promise.} */ refresh(request: Request): Promise; /** * Deletes a collection * * @param {String} index * @param {String} collection * * @returns {Promise.} */ delete(request: any): Promise; /** * Uses from and size to paginate response results * If type is "all", stored collections are prioritary * * @param {Number} from * @param {Number} size * @param {Object} response * @returns {Object} { collections, from, size } */ _paginateCollections(from: number, size: number, response: any): any; /** * Return only the mapping properties we want to output in our API * @param {Object} mapping - raw ES mapping * @returns {Object} */ _filterMappingResponse(mapping: any): any; } import { NativeController } from "./baseController";