Forum Discussion
It was emailed from Khoros Support notifications on Wednesday 9th August. Here's the content of the email:
What’s changing?
This update pertains to changes coming in release 23.12 that will affect how customers use the LIMIT and OFFSET values with API v2.
1. LIMIT:
Starting with Community release 23.12, we will enforce a maximum value of 1K to the LIMIT. The default will continue to be 25. Exceeding the maximum 1K LIMIT will result in an error.
2. OFFSET:
Starting with Community release 23.12, we will enforce a maximum value of 1K to the OFFSET. All queries with OFFSET values greater than 1K will fail with an error that the specified OFFSET exceeds the maximum allowed OFFSET.
About LIMIT, OFFSET, & CURSOR
Community API v2 supports the OFFSET and CURSOR mechanisms to page through data in a result set from a LiQL query. The CURSOR method scales more efficiently and works best for large result sets. The OFFSET method is more straightforward and works well for small data sets and for testing LiQL queries. Queries to the messages, users, boards, and categories collections often return larger result sets, and the CURSOR method will be required to obtain deeper data sets starting in 23.12.
LIMIT: the number of records to include as you page through the result set.
- Example: SELECT author.id FROM messages WHERE board.name = 'wireless' LIMIT 10
OFFSET: the number of records to skip before returning results.
- Example: SELECT author.id FROM messages WHERE board.name = 'wireless' LIMIT 10 OFFSET 10
CURSOR: the number of records to skip before returning results, using a string-based mechanism.
- Example: SELECT author.id FROM messages WHERE board.name = 'wireless' LIMIT 10 CURSOR ‘MjuM3wYjBB…’
What's driving these changes?
In order to maintain the integrity and scalability of community resources, these new thresholds are being implemented to reinforce best practices for obtaining deeper result sets using the more efficient CURSOR method.
What changes need to be made?
If you use LIMIT or OFFSET with a value higher than 1,000, you will need to lower that value to meet the aforementioned thresholds.
When are these changes being made?
The changes are slated for release 23.12, which is tentatively scheduled to be made available in January 2024.
You can find more details regarding LiQL pagination here. Should you have any questions, please do not hesitate to contact Khoros Support.Thank you for being a Khoros customer!
- The Khoros Team
Hmm that's troubling for us as well. I was under the impression that the LIMIT was already a maximum of 1000, so I've already been developing with that in mind.
However, like you say, pagination becomes difficult with a cap on OFFSET. We have custom message lists on our forum page, and with some of our boards having 10s of thousands of posts this will break our pagination.
I think the only way to do this with cursor is to limit it to next/prev. I don't see how something like the below is possible without larger offsets.
Related Content
- 3 years ago
- 8 months ago
- 18 days ago
- 5 years ago