io.github.honhimw.ms.api.PaginationSettings Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of meilisearch-rest-client Show documentation

Reactive meilisearch rest client powered by reactor-netty-http.

There is a newer version: 1.11.0.0

Show newest version

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.honhimw.ms.api;

import io.github.honhimw.ms.model.Pagination;
import io.github.honhimw.ms.model.TaskInfo;
import io.github.honhimw.ms.api.annotation.Operation;

/**
 * Pagination
 * 
 * To protect your database from malicious scraping, Meilisearch has a default limit of 1000 results per search. This setting allows you to configure the maximum number of results returned per search.
 * 

 * maxTotalHits takes priority over search parameters such as limit, offset, hitsPerPage, and page.
 * 

 * For example, if you set maxTotalHits to 100, you will not be able to access search results beyond 100 no matter the value configured for offset.
 * 

 * To learn more about paginating search results with Meilisearch, refer to our dedicated guide.
 *
 * @author hon_him
 * @see Pagination
 * @since 2024-01-03
 */

public interface PaginationSettings {

    /**
     * Get the pagination settings of an index.
     *
     * @return current index pagination
     */
    @Operation(method = "GET", paths = "/indexes/{index_uid}/settings/pagination")
    Pagination get();

    /**
     * Partially update the pagination settings for an index.
     * 
WARNING
     *      * Setting maxTotalHits to a value higher than the default will negatively impact search performance. Setting maxTotalHits to values over 20000 may result in queries taking seconds to complete.
     * 
     *
     * @param pagination new pagination settings
     * @return update task
     */
    @Operation(method = "PATCH", paths = "/indexes/{index_uid}/settings/pagination")
    TaskInfo update(Pagination pagination);

    /**
     * Partially update the pagination settings for an index.
     * @param maxTotalHits new maxTotalHits in pagination
     * @return update task
     */
    @Operation(method = "PATCH", paths = "/indexes/{index_uid}/settings/pagination")
    default TaskInfo update(int maxTotalHits) {
        Pagination pagination = new Pagination();
        pagination.setMaxTotalHits(maxTotalHits);
        return update(pagination);
    }

    /**
     * Reset an index's faceting settings to their default value.
     * Setting sortFacetValuesBy to null( --data-binary '{ "sortFacetValuesBy": null }'), will restore it to the default value ("*": "alpha").
     *
     * @return reset task
     */
    @Operation(method = "DELETE", paths = "/indexes/{index_uid}/settings/pagination")
    TaskInfo reset();

}