Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sandrewtx08/prisma-paginate
Paginate ORM Prisma
https://github.com/sandrewtx08/prisma-paginate
orm pagination prisma typescript
Last synced: 6 days ago
JSON representation
Paginate ORM Prisma
- Host: GitHub
- URL: https://github.com/sandrewtx08/prisma-paginate
- Owner: sandrewTx08
- Created: 2022-11-18T12:41:30.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T17:59:29.000Z (17 days ago)
- Last Synced: 2024-12-13T15:20:00.073Z (13 days ago)
- Topics: orm, pagination, prisma, typescript
- Language: TypeScript
- Homepage: https://sandrewtx08.github.io/prisma-paginate/
- Size: 3.35 MB
- Stars: 102
- Watchers: 3
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📖 prisma-paginate
| [](https://badge.fury.io/js/prisma-paginate) | [](https://github.com/sandrewTx08/prisma-paginate/actions/workflows/ci.yaml) | [](https://github.com/sandrewTx08/prisma-paginate/actions/workflows/pages/pages-build-deployment) |
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
# Install
```shell
npm i prisma@>=4.9.0 @prisma/client@>=4.9.0 prisma-paginate@latest
yarn add prisma@>=4.9.0 @prisma/client@>=4.9.0 prisma-paginate@latest
```
**`prisma/schema.prisma`**:
```ts
generator client {
provider = "prisma-client-js"
previewFeatures = ["clientExtensions"]
}
```
⚠️ These steps no longer required for versions starting from **4.16.0**
# Documentation and usage
For more details and type definitions see:
http://sandrewtx08.github.io/prisma-paginate/
## Importing
```js
// ESM
import { PrismaClient } from "@prisma/client";
import extension from "prisma-paginate";
// Commonjs
const { PrismaClient } = require("@prisma/client");
const { extension } = require("prisma-paginate");
```
## Applying extension
```js
const prisma = new PrismaClient();
const xprisma = prisma.$extends(extension);
xprisma.model2
.paginate({ limit: 10, page: 1, select: { id: true } })
.then((result) => {
console.log(result);
});
xprisma.table1
.paginate({ where: { id: 5 } }, { limit: 10, page: 1 })
.then((result) => {
console.log(result);
});
```
## Paginating 100 rows
```js
// on database = [ { id: 1 }, { id: 2 }, {...}, { id: 100 } ]
xprisma.model1
.paginate(
{
where: {
// query stuff...
},
},
{ page: 1, limit: 50 },
)
.then((result) => {
console.log(result.result); // [ {...}, { id: 48 }, { id: 49 }, { id: 50 } ]
});
```
## Paginating SQL queries
```ts
const [{ count }] = await prisma.$queryRawUnsafe<[{ count: bigint }]>(
'SELECT COUNT(*) FROM "Model3";',
);
const pagination = new Pagination(limit, page, Number(count));
```
```ts
const data = await prisma.$queryRawUnsafe(
'SELECT name FROM "Model3" LIMIT $1 OFFSET $2;',
limit,
Pagination.offset(limit, page),
);
```
## Parameters
- `findManyArgs` {Object}
- `paginationArgs` {Pagination&onCount?(pagination) => void}
---
- `findManyPaginationArgs` {Object&Pagination}
## Return
- `result` {Array}
- `totalPages` {Number}
- `hasNextPage` {Boolean}
- `hasPrevPage` {Boolean}
- `count` {Number}
- `nextPage` {() => Promise}
- `exceedCount` {Boolean}
- `exceedTotalPages` {Boolean}