Разбиение на страницы
Краткий обзор
- Разберитесь, как 'nodes', 'pageInfo' и 'totalCount' формируют структуру ответа с пагинацией.
- Узнайте, как получить первую страницу и использовать курсоры для перехода вперед или назад.
- Посмотрите, как получить общее количество элементов в коллекции, не загружая сами элементы.
API Altium 365 использует пагинацию на основе курсоров в соответствии со спецификацией соединений Relay. Запросы к коллекциям возвращают объект типа connection, содержащий список узлов, метаданные пагинации и курсоры для перемещения вперёд или назад по результатам.
Структура соединения
Ответ с пагинацией имеет следующую структуру:
query {
someCollection {
nodes { # the items on this page
...
}
pageInfo { # pagination metadata
hasNextPage
hasPreviousPage
startCursor
endCursor
}
totalCount # total number of items (all pages)
}
}
Получение страниц
Используйте аргументы first и after для перехода вперёд по страницам коллекции:
query {
desProjects(first: 20, after: "{cursor}") {
nodes {
id
name
}
pageInfo {
hasNextPage
endCursor
}
}
}
-
first– количество возвращаемых элементов (размер страницы) -
after– курсор, указывающий на конец предыдущей страницы; не указывайте его в первом запросе
Значение endCursor из pageInfo становится значением after для следующей страницы. Продолжайте, пока hasNextPage не примет значение false.
Для перехода назад по страницам используйте last и before вместе с startCursor.
Первый запрос
Для первой страницы не указывайте аргумент after:
query {
desProjects(first: 20) {
nodes {
id
name
updatedAt
}
pageInfo {
hasNextPage
endCursor
}
totalCount
}
}
Используйте totalCount, чтобы определить ожидаемое количество страниц до начала постраничного получения данных.
Подсчёт без получения элементов
Если вам нужно только общее количество элементов, можно полностью исключить nodes:
query {
desProjects {
totalCount
}
}