pypaginate
Getting Started
Getting Started
Installation
Quick Start
First Steps
User Guide
Pagination
Offset Pagination
Cursor/Keyset Pagination
In-Memory Pagination
Filtering
Basic Filtering
Nested Filter Groups
Operators Reference
Search
Text Search
Fuzzy Matching
Sorting
Basic Sorting
Multi-Column Sorting
Integrations
Framework Integrations
FastAPI Integration
SQLAlchemy Integration
API Reference
API Reference
pypaginate
Examples
Examples
Basic Pagination
Filtering
FastAPI Integration
Keyset (Cursor) Pagination
Concepts
Concepts
Architecture
Pagination Strategies
Cursor Encoding
Filter Expressions
Search & Relevance
Contributing
Contributing to pypaginate
Development Setup
Code Style
Testing Guide
Architecture Guide
Roadmap
Contributor Covenant Code of Conduct
Project
Competitive Analysis
Performance Benchmarks
pypaginate
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
A
And() (in module pypaginate)
(in module pypaginate.domain.specs)
apply() (pypaginate.filtering.engine.FilterEngine method)
(pypaginate.filtering.FilterEngine method)
(pypaginate.search.engine.SearchEngine method)
(pypaginate.search.SearchEngine method)
(pypaginate.sorting.engine.SortEngine method)
(pypaginate.sorting.SortEngine method)
apply_filters() (pypaginate.adapters.memory.filters.MemoryFilterBackend static method)
(pypaginate.adapters.memory.MemoryFilterBackend static method)
(pypaginate.adapters.sqlalchemy.filters.SQLAlchemyFilterBackend method)
(pypaginate.adapters.sqlalchemy.SQLAlchemyFilterBackend method)
(pypaginate.domain.protocols.FilterBackend method)
apply_search() (pypaginate.adapters.memory.MemorySearchBackend static method)
(pypaginate.adapters.memory.search.MemorySearchBackend static method)
(pypaginate.adapters.sqlalchemy.search.SQLAlchemySearchBackend static method)
(pypaginate.adapters.sqlalchemy.SQLAlchemySearchBackend static method)
(pypaginate.domain.protocols.SearchBackend static method)
apply_sorting() (pypaginate.adapters.memory.MemorySortBackend static method)
(pypaginate.adapters.memory.sorting.MemorySortBackend static method)
(pypaginate.adapters.sqlalchemy.sorting.SQLAlchemySortBackend static method)
(pypaginate.adapters.sqlalchemy.SQLAlchemySortBackend static method)
(pypaginate.domain.protocols.SortBackend static method)
AsyncCursorPaginator (class in pypaginate.engine.cursor)
AsyncPaginator (class in pypaginate.engine.paginator)
AsyncPipeline (class in pypaginate.engine.pipeline)
B
BasePage (class in pypaginate.domain.pages)
BaseParams (class in pypaginate.domain.params)
build_keyset_condition() (in module pypaginate.adapters.sqlalchemy.keyset)
C
clamp() (pypaginate.domain.params.OffsetParams method)
(pypaginate.OffsetParams method)
clear_normalize_cache() (in module pypaginate.text.normalize)
compile_accessor() (in module pypaginate.filtering.accessor)
compile_dict_accessor() (in module pypaginate.filtering.accessor)
ConfigurationError
,
[1]
count() (pypaginate.adapters.memory.backend.MemoryBackend method)
(pypaginate.adapters.memory.MemoryBackend method)
(pypaginate.adapters.sqlalchemy.backend.SQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.backend.SyncSQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.SQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.SyncSQLAlchemyBackend method)
(pypaginate.domain.protocols.PaginationBackend method)
(pypaginate.domain.protocols.SyncPaginationBackend method)
create() (pypaginate.CursorPage class method)
(pypaginate.domain.pages.CursorPage class method)
(pypaginate.domain.pages.OffsetPage class method)
(pypaginate.OffsetPage class method)
CursorBackend (class in pypaginate.domain.protocols)
CursorDep (in module pypaginate.adapters.fastapi)
(in module pypaginate.adapters.fastapi.dependencies)
CursorPage (class in pypaginate)
(class in pypaginate.domain.pages)
CursorParams (class in pypaginate)
(class in pypaginate.domain.params)
D
Dataset (class in pypaginate)
(class in pypaginate.dataset)
decode_cursor() (in module pypaginate.engine.cursor_codec)
E
encode_cursor() (in module pypaginate.engine.cursor_codec)
execute() (pypaginate.engine.pipeline.AsyncPipeline method)
(pypaginate.engine.pipeline.SyncPipeline method)
extract_order_columns() (in module pypaginate.adapters.sqlalchemy.keyset)
F
FastCursorPage (class in pypaginate.domain.fast_pages)
FastOffsetPage (class in pypaginate.domain.fast_pages)
fetch() (pypaginate.adapters.memory.backend.MemoryBackend method)
(pypaginate.adapters.memory.MemoryBackend method)
(pypaginate.adapters.sqlalchemy.backend.SQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.backend.SyncSQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.SQLAlchemyBackend method)
(pypaginate.adapters.sqlalchemy.SyncSQLAlchemyBackend method)
(pypaginate.domain.protocols.PaginationBackend method)
(pypaginate.domain.protocols.SyncPaginationBackend method)
fetch_page() (pypaginate.adapters.sqlalchemy.cursor.SQLAlchemyCursorBackend method)
(pypaginate.adapters.sqlalchemy.cursor.SyncSQLAlchemyCursorBackend method)
(pypaginate.adapters.sqlalchemy.SQLAlchemyCursorBackend method)
(pypaginate.adapters.sqlalchemy.SyncSQLAlchemyCursorBackend method)
(pypaginate.domain.protocols.CursorBackend method)
FilterBackend (class in pypaginate.domain.protocols)
FilterDep (class in pypaginate.adapters.fastapi)
(class in pypaginate.adapters.fastapi.filters)
FilterEngine (class in pypaginate.filtering)
(class in pypaginate.filtering.engine)
FilterError
,
[1]
FilterField() (in module pypaginate.adapters.fastapi)
(in module pypaginate.adapters.fastapi.filters)
FilterGroup (class in pypaginate)
(class in pypaginate.domain.specs)
FilterInput (in module pypaginate.domain.specs)
FilterLogic (class in pypaginate)
(class in pypaginate.domain.enums)
FilterOperator (in module pypaginate.domain.specs)
FilterSpec (class in pypaginate)
(class in pypaginate.domain.specs)
FilterValidationError
,
[1]
FuzzyMode (class in pypaginate)
(class in pypaginate.domain.enums)
M
MAX_LIMIT (in module pypaginate.domain.params)
MemoryBackend (class in pypaginate.adapters.memory)
(class in pypaginate.adapters.memory.backend)
MemoryFilterBackend (class in pypaginate.adapters.memory)
(class in pypaginate.adapters.memory.filters)
MemorySearchBackend (class in pypaginate.adapters.memory)
(class in pypaginate.adapters.memory.search)
MemorySortBackend (class in pypaginate.adapters.memory)
(class in pypaginate.adapters.memory.sorting)
model_config (pypaginate.adapters.fastapi.FilterDep attribute)
(pypaginate.adapters.fastapi.filters.FilterDep attribute)
(pypaginate.adapters.fastapi.search.SearchDep attribute)
(pypaginate.adapters.fastapi.SearchDep attribute)
(pypaginate.adapters.fastapi.SortDep attribute)
(pypaginate.adapters.fastapi.sorting.SortDep attribute)
(pypaginate.domain.pages.BasePage attribute)
(pypaginate.domain.params.BaseParams attribute)
(pypaginate.domain.specs.FilterGroup attribute)
(pypaginate.domain.specs.FilterSpec attribute)
(pypaginate.domain.specs.SearchSpec attribute)
(pypaginate.domain.specs.SortSpec attribute)
(pypaginate.FilterGroup attribute)
(pypaginate.FilterSpec attribute)
(pypaginate.SearchSpec attribute)
(pypaginate.SortSpec attribute)
model_dump() (pypaginate.domain.fast_pages.FastCursorPage method)
(pypaginate.domain.fast_pages.FastOffsetPage method)
model_dump_json() (pypaginate.domain.fast_pages.FastCursorPage method)
(pypaginate.domain.fast_pages.FastOffsetPage method)
module
pypaginate
pypaginate.adapters
pypaginate.adapters.fastapi
pypaginate.adapters.fastapi.dependencies
pypaginate.adapters.fastapi.filters
pypaginate.adapters.fastapi.search
pypaginate.adapters.fastapi.sorting
pypaginate.adapters.memory
pypaginate.adapters.memory.backend
pypaginate.adapters.memory.filters
pypaginate.adapters.memory.search
pypaginate.adapters.memory.sorting
pypaginate.adapters.sqlalchemy
pypaginate.adapters.sqlalchemy.backend
pypaginate.adapters.sqlalchemy.columns
pypaginate.adapters.sqlalchemy.cursor
pypaginate.adapters.sqlalchemy.filters
pypaginate.adapters.sqlalchemy.keyset
pypaginate.adapters.sqlalchemy.search
pypaginate.adapters.sqlalchemy.sorting
pypaginate.adapters.sqlalchemy.types
pypaginate.dataset
pypaginate.domain
pypaginate.domain.enums
pypaginate.domain.exceptions
pypaginate.domain.fast_pages
pypaginate.domain.pages
pypaginate.domain.params
pypaginate.domain.protocols
pypaginate.domain.specs
pypaginate.engine
pypaginate.engine.cursor
pypaginate.engine.cursor_codec
pypaginate.engine.paginator
pypaginate.engine.pipeline
pypaginate.filtering
pypaginate.filtering.accessor
pypaginate.filtering.engine
pypaginate.search
pypaginate.search.engine
pypaginate.sorting
pypaginate.sorting.engine
pypaginate.text
pypaginate.text.normalize
N
normalize_text() (in module pypaginate.text.normalize)
NullsPosition (class in pypaginate)
(class in pypaginate.domain.enums)
O
offset (pypaginate.domain.params.OffsetParams property)
(pypaginate.OffsetParams property)
OffsetDep (in module pypaginate.adapters.fastapi)
(in module pypaginate.adapters.fastapi.dependencies)
OffsetPage (class in pypaginate)
(class in pypaginate.domain.pages)
OffsetParams (class in pypaginate)
(class in pypaginate.domain.params)
Or() (in module pypaginate)
(in module pypaginate.domain.specs)
order_clause (pypaginate.adapters.sqlalchemy.keyset.OrderColumn property)
OrderColumn (class in pypaginate.adapters.sqlalchemy.keyset)
OverflowStrategy (class in pypaginate)
(class in pypaginate.domain.enums)
P
paginate() (in module pypaginate)
(pypaginate.Dataset method)
(pypaginate.dataset.Dataset method)
(pypaginate.engine.cursor.AsyncCursorPaginator method)
(pypaginate.engine.paginator.AsyncPaginator method)
(pypaginate.engine.paginator.Paginator method)
PaginationBackend (class in pypaginate.domain.protocols)
PaginationError
,
[1]
Paginator (class in pypaginate.engine.paginator)
pypaginate
module
pypaginate.adapters
module
pypaginate.adapters.fastapi
module
pypaginate.adapters.fastapi.dependencies
module
pypaginate.adapters.fastapi.filters
module
pypaginate.adapters.fastapi.search
module
pypaginate.adapters.fastapi.sorting
module
pypaginate.adapters.memory
module
pypaginate.adapters.memory.backend
module
pypaginate.adapters.memory.filters
module
pypaginate.adapters.memory.search
module
pypaginate.adapters.memory.sorting
module
pypaginate.adapters.sqlalchemy
module
pypaginate.adapters.sqlalchemy.backend
module
pypaginate.adapters.sqlalchemy.columns
module
pypaginate.adapters.sqlalchemy.cursor
module
pypaginate.adapters.sqlalchemy.filters
module
pypaginate.adapters.sqlalchemy.keyset
module
pypaginate.adapters.sqlalchemy.search
module
pypaginate.adapters.sqlalchemy.sorting
module
pypaginate.adapters.sqlalchemy.types
module
pypaginate.dataset
module
pypaginate.domain
module
pypaginate.domain.enums
module
pypaginate.domain.exceptions
module
pypaginate.domain.fast_pages
module
pypaginate.domain.pages
module
pypaginate.domain.params
module
pypaginate.domain.protocols
module
pypaginate.domain.specs
module
pypaginate.engine
module
pypaginate.engine.cursor
module
pypaginate.engine.cursor_codec
module
pypaginate.engine.paginator
module
pypaginate.engine.pipeline
module
pypaginate.filtering
module
pypaginate.filtering.accessor
module
pypaginate.filtering.engine
module
pypaginate.search
module
pypaginate.search.engine
module
pypaginate.sorting
module
pypaginate.sorting.engine
module
pypaginate.text
module
pypaginate.text.normalize
module
R
resolve_column() (in module pypaginate.adapters.sqlalchemy.columns)
reversed (pypaginate.adapters.sqlalchemy.keyset.OrderColumn property)
S
SearchBackend (class in pypaginate.domain.protocols)
SearchDep (class in pypaginate.adapters.fastapi)
(class in pypaginate.adapters.fastapi.search)
SearchEngine (class in pypaginate.search)
(class in pypaginate.search.engine)
SearchError
,
[1]
SearchFieldMode (class in pypaginate)
(class in pypaginate.domain.enums)
SearchQueryError
,
[1]
SearchSpec (class in pypaginate)
(class in pypaginate.domain.specs)
SelectStatement (in module pypaginate.adapters.sqlalchemy.types)
SortBackend (class in pypaginate.domain.protocols)
SortDep (class in pypaginate.adapters.fastapi)
(class in pypaginate.adapters.fastapi.sorting)
SortDirection (class in pypaginate)
(class in pypaginate.domain.enums)
SortEngine (class in pypaginate.sorting)
(class in pypaginate.sorting.engine)
SortError
,
[1]
SortSpec (class in pypaginate)
(class in pypaginate.domain.specs)
SQLAlchemyBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.backend)
SQLAlchemyCursorBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.cursor)
SQLAlchemyFilterBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.filters)
SQLAlchemySearchBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.search)
SQLAlchemySortBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.sorting)
SyncPaginationBackend (class in pypaginate.domain.protocols)
SyncPipeline (class in pypaginate.engine.pipeline)
SyncSQLAlchemyBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.backend)
SyncSQLAlchemyCursorBackend (class in pypaginate.adapters.sqlalchemy)
(class in pypaginate.adapters.sqlalchemy.cursor)
T
to_pydantic() (pypaginate.domain.fast_pages.FastCursorPage method)
(pypaginate.domain.fast_pages.FastOffsetPage method)
to_spec() (pypaginate.adapters.fastapi.search.SearchDep method)
(pypaginate.adapters.fastapi.SearchDep method)
to_specs() (pypaginate.adapters.fastapi.FilterDep method)
(pypaginate.adapters.fastapi.filters.FilterDep method)
(pypaginate.adapters.fastapi.SortDep method)
(pypaginate.adapters.fastapi.sorting.SortDep method)
V
ValidationError
,
[1]