From 341f50d2d95ba1d69ad64ba8c0ec0ffa9a68d063 Mon Sep 17 00:00:00 2001 From: Ricardo Ander-Egg <37962604+polyrand@users.noreply.github.com> Date: Fri, 22 Jan 2021 21:50:46 +0100 Subject: [PATCH] Add fts offset docs. The limit can be passed as a string to the query builder to have an offset. I have tested it using the shorthand `limit=f"15, 30"`, the standard syntax should work too. --- docs/python-api.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/python-api.rst b/docs/python-api.rst index c656045..d9f7df5 100644 --- a/docs/python-api.rst +++ b/docs/python-api.rst @@ -1600,8 +1600,8 @@ The ``.search()`` method also accepts the following optional parameters: ``columns`` array of strings Columns to return. Defaults to all columns. -``limit`` integer - Number of results to return. Defaults to all results. +``limit`` integer or string + Number of results to return. Defaults to all results. You can offset the limit by using a string with the shorthand ``limit=f"15, 30"`` or ``limit="30 OFFSET 15"``. Where 15 is the offset and 30 the limit. To return just the title and published columns for three matches for ``"dog"`` ordered by ``published`` with the most recent first, use the following: