feat(core): add cursor-based pagination via em.findByCursor()
#3975
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TODO: - [ ] more tests - [ ] how to handle relations? - [ ] docs
winsontam
reviewed
Jan 28, 2023
winsontam
reviewed
Jan 28, 2023
winsontam
reviewed
Jan 28, 2023
Codecov ReportBase: 99.66% // Head: 99.64% // Decreases project coverage by
📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more Additional details and impacted files@@ Coverage Diff @@
## v6 #3975 +/- ##
==========================================
- Coverage 99.66% 99.64% -0.02%
==========================================
Files 215 216 +1
Lines 13683 13833 +150
Branches 3208 3256 +48
==========================================
+ Hits 13637 13784 +147
- Misses 44 47 +3
Partials 2 2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
https://opensource.huntersofbook.com/global/relay-cursor Great, now I can use it directly with graphql and the library I wrote. Thank you Martin |
B4nan
added a commit
that referenced
this pull request
Feb 5, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Feb 12, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Feb 17, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Feb 17, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Feb 26, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Mar 19, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Apr 6, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Apr 10, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Apr 12, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Apr 26, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
jsprw
pushed a commit
to jsprw/mikro-orm-full-text-operators
that referenced
this pull request
May 7, 2023
…o-orm#3975) As an alternative to the offset based pagination with `limit` and `offset`, we can paginate based on a cursor. A cursor is an opaque string that defines specific place in ordered entity graph. You can use `em.findByCursor()` to access those options. Under the hood, it will call `em.find()` and `em.count()` just like the `em.findAndCount()` method, but will use the cursor options instead. Supports `before`, `after`, `first` and `last` options while disallowing `limit` and `offset`. Explicit `orderBy` option is required. Use `first` and `after` for forward pagination, or `last` and `before` for backward pagination. - `first` and `last` are numbers and serve as an alternative to `offset`, those options are mutually exclusive, use only one at a time - `before` and `after` specify the previous cursor value, it can be one of the: - `Cursor` instance - opaque string provided by `startCursor/endCursor` properties - POJO/entity instance ```ts const currentCursor = await em.findByCursor(User, {}, { first: 10, after: previousCursor, // cursor instance orderBy: { id: 'desc' }, }); // to fetch next page const nextCursor = await em.findByCursor(User, {}, { first: 10, after: currentCursor.endCursor, // opaque string orderBy: { id: 'desc' }, }); // to fetch next page const nextCursor2 = await em.findByCursor(User, {}, { first: 10, after: { id: lastSeenId }, // entity-like POJO orderBy: { id: 'desc' }, }); ``` The `Cursor` object provides following interface: ```ts Cursor<User> { items: [ User { ... }, User { ... }, User { ... }, ... ], totalCount: 50, length: 10, startCursor: 'WzRd', endCursor: 'WzZd', hasPrevPage: true, hasNextPage: true, } ```
jsprw
pushed a commit
to jsprw/mikro-orm-full-text-operators
that referenced
this pull request
May 7, 2023
…o-orm#3975) As an alternative to the offset based pagination with `limit` and `offset`, we can paginate based on a cursor. A cursor is an opaque string that defines specific place in ordered entity graph. You can use `em.findByCursor()` to access those options. Under the hood, it will call `em.find()` and `em.count()` just like the `em.findAndCount()` method, but will use the cursor options instead. Supports `before`, `after`, `first` and `last` options while disallowing `limit` and `offset`. Explicit `orderBy` option is required. Use `first` and `after` for forward pagination, or `last` and `before` for backward pagination. - `first` and `last` are numbers and serve as an alternative to `offset`, those options are mutually exclusive, use only one at a time - `before` and `after` specify the previous cursor value, it can be one of the: - `Cursor` instance - opaque string provided by `startCursor/endCursor` properties - POJO/entity instance ```ts const currentCursor = await em.findByCursor(User, {}, { first: 10, after: previousCursor, // cursor instance orderBy: { id: 'desc' }, }); // to fetch next page const nextCursor = await em.findByCursor(User, {}, { first: 10, after: currentCursor.endCursor, // opaque string orderBy: { id: 'desc' }, }); // to fetch next page const nextCursor2 = await em.findByCursor(User, {}, { first: 10, after: { id: lastSeenId }, // entity-like POJO orderBy: { id: 'desc' }, }); ``` The `Cursor` object provides following interface: ```ts Cursor<User> { items: [ User { ... }, User { ... }, User { ... }, ... ], totalCount: 50, length: 10, startCursor: 'WzRd', endCursor: 'WzZd', hasPrevPage: true, hasNextPage: true, } ```
B4nan
added a commit
that referenced
this pull request
May 14, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
May 14, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
May 24, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
May 26, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Jun 11, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
Closed
|
This is a wonderful feature. Just a quick feedback @B4nan : in most API I have used with cursor based, the totalCount is not returned (what we are interested is only knowing if there is a next or prev page), which avoids a potentially costly SQL count. What about removing the count by default, and add an optional |
|
I am not sure if this should be disabled by default, but I am open to having an option to control it. |
B4nan
added a commit
that referenced
this pull request
Sep 10, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Sep 20, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Sep 24, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Sep 30, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Oct 2, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Oct 17, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Oct 21, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Oct 25, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Nov 2, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
B4nan
added a commit
that referenced
this pull request
Nov 5, 2023
As an alternative to the offset based pagination with `limit` and
`offset`, we can paginate based on a cursor. A cursor is an opaque
string that defines specific place in ordered entity graph. You can use
`em.findByCursor()` to access those options. Under the hood, it will
call `em.find()` and `em.count()` just like the `em.findAndCount()`
method, but will use the cursor options instead.
Supports `before`, `after`, `first` and `last` options while disallowing
`limit` and `offset`. Explicit `orderBy` option is required.
Use `first` and `after` for forward pagination, or `last` and `before`
for backward pagination.
- `first` and `last` are numbers and serve as an alternative to
`offset`, those options are mutually exclusive, use only one at a time
- `before` and `after` specify the previous cursor value, it can be one
of the:
- `Cursor` instance
- opaque string provided by `startCursor/endCursor` properties
- POJO/entity instance
```ts
const currentCursor = await em.findByCursor(User, {}, {
first: 10,
after: previousCursor, // cursor instance
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor = await em.findByCursor(User, {}, {
first: 10,
after: currentCursor.endCursor, // opaque string
orderBy: { id: 'desc' },
});
// to fetch next page
const nextCursor2 = await em.findByCursor(User, {}, {
first: 10,
after: { id: lastSeenId }, // entity-like POJO
orderBy: { id: 'desc' },
});
```
The `Cursor` object provides following interface:
```ts
Cursor<User> {
items: [
User { ... },
User { ... },
User { ... },
...
],
totalCount: 50,
length: 10,
startCursor: 'WzRd',
endCursor: 'WzZd',
hasPrevPage: true,
hasNextPage: true,
}
```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As an alternative to the offset based pagination with
limitandoffset, we can paginate based on a cursor. A cursor is an opaque string that defines specific place in ordered entity graph. You can useem.findByCursor()to access those options. Under the hood, it will callem.find()andem.count()just like theem.findAndCount()method, but will use the cursor options instead.Supports
before,after,firstandlastoptions while disallowinglimitandoffset. ExplicitorderByoption is required.Use
firstandafterfor forward pagination, orlastandbeforefor backward pagination.firstandlastare numbers and serve as an alternative tooffset, those options are mutually exclusive, use only one at a timebeforeandafterspecify the previous cursor value, it can be one of the:CursorinstancestartCursor/endCursorpropertiesThe
Cursorobject provides following interface: