@prisma/extension-optimize 0.5.0 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Optimize Prisma Client extension
|
|
2
|
+
|
|
3
|
+
This is the package for the [Prisma Client extension](https://www.prisma.io/docs/concepts/components/prisma-client/client-extensions?utm_source=github&utm_medium=accelerate-readme) that enables usage of Prisma Optimize.
|
|
4
|
+
|
|
5
|
+
Optimize enables developers to profile and get performance-related recommendations while developing applications with prisma.
|
|
6
|
+
|
|
7
|
+
It is part of the [Prisma](https://www.prisma.io?utm_source=github&utm_medium=accelerate-readme) ecosystem, alongside other tools such as:
|
|
8
|
+
|
|
9
|
+
- [Prisma Accelerate](https://www.prisma.io/data-platform/accelerate?utm_source=github&utm_medium=pulse-readme): Global database cache with scalable connection pooling.
|
|
10
|
+
- [Prisma Pulse](https://www.prisma.io/data-platform/pulse?utm_source=github&utm_medium=accelerate-readme): Real-time database events with type-safe subscriptions.
|
|
11
|
+
|
|
12
|
+
Prisma is leading Data DX, a philosophy that promotes simplicity in data-driven application development. Learn more on the [Data DX manifesto](https://www.datadx.io/?utm_source=github&utm_medium=accelerate-readme).
|
|
13
|
+
|
|
14
|
+
## Getting started with Optimize
|
|
15
|
+
|
|
16
|
+
Enabling Optimize in your local development workflow is really simple.
|
|
17
|
+
|
|
18
|
+
### 1. Install the extension
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
npm install @prisma/extension-optimize --save-dev
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
> Starting a prisma project from scratch? Follow https://www.prisma.io/docs/getting-started
|
|
25
|
+
|
|
26
|
+
### 2. Extend your prisma client with Optimize support
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
import { PrismaClient } from "@prisma/client";
|
|
30
|
+
import { withOptimize } from "@prisma/extension-optimize";
|
|
31
|
+
|
|
32
|
+
const prisma = new PrismaClient().$extends(withOptimize());
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
The extension will orchestrate the user experience around optimize. You will:
|
|
36
|
+
|
|
37
|
+
- Be required to log into the prisma data platform through your GitHub account
|
|
38
|
+
- And be instructed to visit the URL of your Optimize dashboard:
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
[...]
|
|
42
|
+
> tsx index.ts
|
|
43
|
+
|
|
44
|
+
┌─────────────────────────────────┐
|
|
45
|
+
│ See your Optimize dashboard at: │
|
|
46
|
+
│ https://optimize-3k7.pages.dev/ │
|
|
47
|
+
└─────────────────────────────────┘
|
|
48
|
+
[...]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Got feedback?
|
|
52
|
+
|
|
53
|
+
Please [submit an issue](https://github.com/prisma/optimize-feedback/issues/new/choose) or [join a discussion](https://github.com/prisma/optimize-feedback/discussions) in our [feedback repository](https://github.com/prisma/optimize-feedback/)
|