rest_framework.pagination.CursorPagination

class documentation

class CursorPagination(BasePagination): (source)

View In Hierarchy

The cursor pagination implementation is necessarily complex. For an overview of the position/offset style we use, see this post: https://cra.mr/2011/03/08/building-cursors-for-the-disqus-api

Method decode_cursor Given a request with a cursor, return a `Cursor` instance.
Method encode_cursor Given a Cursor instance, return an url with encoded cursor.
Method get_html_context Undocumented
Method get_next_link Undocumented
Method get_ordering Return a tuple of strings, that may be used in an `order_by` method.
Method get_page_size Undocumented
Method get_paginated_response Undocumented
Method get_paginated_response_schema Undocumented
Method get_previous_link Undocumented
Method get_schema_fields Undocumented
Method get_schema_operation_parameters Undocumented
Method paginate_queryset Undocumented
Method to_html Undocumented
Class Variable cursor_query_description Undocumented
Class Variable cursor_query_param Undocumented
Class Variable invalid_cursor_message Undocumented
Class Variable max_page_size Undocumented
Class Variable offset_cutoff Undocumented
Class Variable page_size_query_description Undocumented
Class Variable page_size_query_param Undocumented
Class Variable template Undocumented
Instance Variable base_url Undocumented
Instance Variable cursor Undocumented
Instance Variable display_page_controls Undocumented
Instance Variable has_next Undocumented
Instance Variable has_previous Undocumented
Instance Variable next_position Undocumented
Instance Variable ordering Undocumented
Instance Variable page Undocumented
Instance Variable page_size Undocumented
Instance Variable previous_position Undocumented
Method _get_position_from_instance Undocumented

Inherited from BasePagination:

Method get_results Undocumented
def decode_cursor(self, request): (source)

Given a request with a cursor, return a `Cursor` instance.

def encode_cursor(self, cursor): (source)

Given a Cursor instance, return an url with encoded cursor.

def get_html_context(self): (source)

Undocumented

def get_next_link(self): (source)

Undocumented

def get_ordering(self, request, queryset, view): (source)

Return a tuple of strings, that may be used in an `order_by` method.

def get_page_size(self, request): (source)

Undocumented

def get_paginated_response(self, data): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response

Undocumented

def get_paginated_response_schema(self, schema): (source)
overrides rest_framework.pagination.BasePagination.get_paginated_response_schema

Undocumented

def get_previous_link(self): (source)

Undocumented

def get_schema_fields(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_fields

Undocumented

def get_schema_operation_parameters(self, view): (source)
overrides rest_framework.pagination.BasePagination.get_schema_operation_parameters

Undocumented

def paginate_queryset(self, queryset, request, view=None): (source)
overrides rest_framework.pagination.BasePagination.paginate_queryset

Undocumented

def to_html(self): (source)
overrides rest_framework.pagination.BasePagination.to_html

Undocumented

cursor_query_description = (source)

Undocumented

cursor_query_param: str = (source)

Undocumented

invalid_cursor_message = (source)

Undocumented

max_page_size = (source)

Undocumented

offset_cutoff: int = (source)

Undocumented

page_size_query_description = (source)

Undocumented

page_size_query_param = (source)

Undocumented

template: str = (source)

Undocumented

base_url = (source)

Undocumented

cursor = (source)

Undocumented

display_page_controls: bool = (source)
overrides rest_framework.pagination.BasePagination.display_page_controls

Undocumented

has_next = (source)

Undocumented

has_previous = (source)

Undocumented

next_position = (source)

Undocumented

ordering = (source)

Undocumented

page = (source)

Undocumented

page_size = (source)

Undocumented

previous_position = (source)

Undocumented

def _get_position_from_instance(self, instance, ordering): (source)

Undocumented