Skip to content

Commit

Permalink
enhance: known limitations section
Browse files Browse the repository at this point in the history
  • Loading branch information
ankur-arch committed Mar 10, 2024
1 parent 4530e53 commit 5a17ae0
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 26 deletions.
34 changes: 10 additions & 24 deletions content/400-pulse/500-known-limitations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,25 @@ Below are descriptions of known limitations when using Prisma Pulse. If you are

</TopBlock>

## Superuser account required for Starter plan
## Superuser role required for starter plan

If you're on the [Starter plan](https://www.prisma.io/pricing), you must connect to your database instance from Prisma Pulse using a superuser account.
Our [Starter plan](https://www.prisma.io/pricing) requires a database role with superuser access.

## Database events are not persisted

To capture database events, an application must maintain an active connection to Prisma Pulse using the [`subscribe()`](/pulse/api-reference#subscribe) method.
Prisma Pulse does not persist database events and does not provide delivery guarantees regarding ordering or exact-once/at-least-once delivery.

It's important to note scenarios where database events may be discarded:
To capture database events, an application must maintain an active connection to Pulse using the  [`subscribe()`](/pulse/api-reference#subscribe) method.

1. **Inactive subscriptions**: If no active subscriptions match the filters of the database event, they will be discarded.
2. **Exceeding database event size limits**: Database events surpassing predefined size limits will also be discarded.
It's important to note scenarios where database events may not be delivered:

If the database is not reachable, Prisma Pulse will temporarily stop processing and discard all database events up to that point.
1. **Inactive subscriptions**: If no active subscriptions match the filters of the database event.
2. **Exceeding database event size limits**: Database events surpassing predefined size limits.

This ensures the stability of both the database and the application. Without this precaution, a sudden influx of database events could overwhelm the application, leading to excessive CPU and memory consumption.
## Prisma Pulse is server-side

## Front-end use is not possible

Pulse cannot be used in the front-end portion of an application.

<Admonition type="info">

If you find this capability valuable, please let us know on the `#help-and-questions` channel in our community [Discord](https://pris.ly/discord).

</Admonition>
Prisma Pulse subscriptions cannot be initiated directly within client-side code.

## Limited to Postgres versions 12 or higher

Prisma Pulse is currently supported with Postgres versions 12 or higher. It should work with most Postgres providers that expose Postgres’ native logical replication feature. We plan on adding support for MySQL some time after our GA release.

<Admonition type="info">

If you have questions about whether your database is supported, please reach out to us on the `#help-and-questions` channel in our community [Discord](https://pris.ly/discord).

</Admonition>
Prisma Pulse is currently supported with Postgres versions 12 or higher. It should work with most Postgres providers that expose Postgres’ native logical replication feature.
26 changes: 24 additions & 2 deletions vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -3881,11 +3881,33 @@
},
{
"source": "/docs/pulse/current-limitations",
"destination": "/docs/pulse/known-limitations"
"destination": "/docs/pulse/known-limitations",
"statusCode": 301
},
{
"source": "/docs/pulse/current-limitations#change-events-are-not-persisted",
"destination": "/docs/pulse/known-limitations#database-events-are-not-persisted"
"destination": "/docs/pulse/known-limitations#database-events-are-not-persisted",
"statusCode": 301
},
{
"source": "/pulse/current-limitations",
"destination": "/pulse/known-limitations",
"statusCode": 301
},
{
"source": "/pulse/current-limitations#front-end-use-is-not-possible",
"destination": "/pulse/known-limitations#prisma-pulse-is-server-side",
"statusCode": 301
},
{
"source": "/pulse/current-limitations#self-signed-certificates-are-not-supported-yet",
"destination": "/pulse/known-limitations",
"statusCode": 301
},
{
"source": "/pulse/current-limitations#pulse-will-not-attempt-a-reconnect-or-give-an-indication-of-the-network-is-disconnected",
"destination": "/pulse/known-limitations",
"statusCode": 301
}
]
}

0 comments on commit 5a17ae0

Please sign in to comment.