prisma 8.0.0-rc.9-dev.79 → 8.1.0-dev.1

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.
Files changed (53) hide show
  1. package/LICENSE +201 -158
  2. package/README.md +58 -101
  3. package/build/child.js +82915 -0
  4. package/build/cli.js +5778 -0
  5. package/build/completion.js +802 -0
  6. package/build/index.js +2 -0
  7. package/build/prisma_schema_build_bg.wasm +0 -0
  8. package/build/query_compiler_fast_bg.cockroachdb.js +2 -0
  9. package/build/query_compiler_fast_bg.cockroachdb.mjs +2 -0
  10. package/build/query_compiler_fast_bg.cockroachdb.wasm +0 -0
  11. package/build/query_compiler_fast_bg.mysql.js +2 -0
  12. package/build/query_compiler_fast_bg.mysql.mjs +2 -0
  13. package/build/query_compiler_fast_bg.mysql.wasm +0 -0
  14. package/build/query_compiler_fast_bg.postgresql.js +2 -0
  15. package/build/query_compiler_fast_bg.postgresql.mjs +2 -0
  16. package/build/query_compiler_fast_bg.postgresql.wasm +0 -0
  17. package/build/query_compiler_fast_bg.sqlite.js +2 -0
  18. package/build/query_compiler_fast_bg.sqlite.mjs +2 -0
  19. package/build/query_compiler_fast_bg.sqlite.wasm +0 -0
  20. package/build/query_compiler_fast_bg.sqlserver.js +2 -0
  21. package/build/query_compiler_fast_bg.sqlserver.mjs +2 -0
  22. package/build/query_compiler_fast_bg.sqlserver.wasm +0 -0
  23. package/build/query_compiler_small_bg.cockroachdb.js +2 -0
  24. package/build/query_compiler_small_bg.cockroachdb.mjs +2 -0
  25. package/build/query_compiler_small_bg.cockroachdb.wasm +0 -0
  26. package/build/query_compiler_small_bg.mysql.js +2 -0
  27. package/build/query_compiler_small_bg.mysql.mjs +2 -0
  28. package/build/query_compiler_small_bg.mysql.wasm +0 -0
  29. package/build/query_compiler_small_bg.postgresql.js +2 -0
  30. package/build/query_compiler_small_bg.postgresql.mjs +2 -0
  31. package/build/query_compiler_small_bg.postgresql.wasm +0 -0
  32. package/build/query_compiler_small_bg.sqlite.js +2 -0
  33. package/build/query_compiler_small_bg.sqlite.mjs +2 -0
  34. package/build/query_compiler_small_bg.sqlite.wasm +0 -0
  35. package/build/query_compiler_small_bg.sqlserver.js +2 -0
  36. package/build/query_compiler_small_bg.sqlserver.mjs +2 -0
  37. package/build/query_compiler_small_bg.sqlserver.wasm +0 -0
  38. package/build/schema_engine_bg.wasm +0 -0
  39. package/build/studio.css +5850 -0
  40. package/build/studio.js +373 -0
  41. package/build/xdg-open +1066 -0
  42. package/config.d.ts +1 -0
  43. package/config.js +30 -0
  44. package/dist/cli/src/config.d.ts +1 -0
  45. package/dist/cli/src/types.d.ts +1 -0
  46. package/package.json +189 -55
  47. package/preinstall/index.js +7 -0
  48. package/scripts/preinstall-entry.js +10 -0
  49. package/dist/config.d.ts +0 -2
  50. package/dist/config.js +0 -2
  51. package/dist/payload-B88Qvzxk-CrtTXSOe.js +0 -34
  52. package/dist/prisma.js +0 -14559
  53. package/dist/sender.js +0 -192
package/LICENSE CHANGED
@@ -1,158 +1,201 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction, and
10
- distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by the copyright
13
- owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all other entities
16
- that control, are controlled by, or are under common control with that entity.
17
- For the purposes of this definition, "control" means (i) the power, direct or
18
- indirect, to cause the direction or management of such entity, whether by
19
- contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
20
- outstanding shares, or (iii) beneficial ownership of such entity.
21
-
22
- "You" (or "Your") shall mean an individual or Legal Entity exercising
23
- permissions granted by this License.
24
-
25
- "Source" form shall mean the preferred form for making modifications, including
26
- but not limited to software source code, documentation source, and configuration
27
- files.
28
-
29
- "Object" form shall mean any form resulting from mechanical transformation or
30
- translation of a Source form, including but not limited to compiled object code,
31
- generated documentation, and conversions to other media types.
32
-
33
- "Work" shall mean the work of authorship, whether in Source or Object form, made
34
- available under the License, as indicated by a copyright notice that is included
35
- in or attached to the work.
36
-
37
- "Derivative Works" shall mean any work, whether in Source or Object form, that
38
- is based on (or derived from) the Work and for which the editorial revisions,
39
- annotations, elaborations, or other modifications represent, as a whole, an
40
- original work of authorship. For the purposes of this License, Derivative Works
41
- shall not include works that remain separable from, or merely link (or bind by
42
- name) to the interfaces of, the Work and Derivative Works thereof.
43
-
44
- "Contribution" shall mean any work of authorship, including the original version
45
- of the Work and any modifications or additions to that Work or Derivative Works
46
- thereof, that is intentionally submitted to Licensor for inclusion in the Work by
47
- the copyright owner or by an individual or Legal Entity authorized to submit on
48
- behalf of the copyright owner. For the purposes of this definition, "submitted"
49
- means any form of electronic, verbal, or written communication sent to the
50
- Licensor or its representatives, including but not limited to communication on
51
- electronic mailing lists, source code control systems, and issue tracking
52
- systems that are managed by, or on behalf of, the Licensor for the purpose of
53
- discussing and improving the Work, but excluding communication that is
54
- conspicuously marked or otherwise designated in writing by the copyright owner
55
- as "Not a Contribution."
56
-
57
- "Contributor" shall mean Licensor and any individual or Legal Entity on behalf
58
- of whom a Contribution has been received by Licensor and subsequently
59
- incorporated within the Work.
60
-
61
- 2. Grant of Copyright License. Subject to the terms and conditions of this
62
- License, each Contributor hereby grants to You a perpetual, worldwide,
63
- non-exclusive, no-charge, royalty-free, irrevocable copyright license to
64
- reproduce, prepare Derivative Works of, publicly display, publicly perform,
65
- sublicense, and distribute the Work and such Derivative Works in Source or Object
66
- form.
67
-
68
- 3. Grant of Patent License. Subject to the terms and conditions of this License,
69
- each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
70
- no-charge, royalty-free, irrevocable (except as stated in this section) patent
71
- license to make, have made, use, offer to sell, sell, import, and otherwise
72
- transfer the Work, where such license applies only to those patent claims
73
- licensable by such Contributor that are necessarily infringed by their
74
- Contribution(s) alone or by combination of their Contribution(s) with the Work to
75
- which such Contribution(s) was submitted. If You institute patent litigation
76
- against any entity (including a cross-claim or counterclaim in a lawsuit)
77
- alleging that the Work or a Contribution incorporated within the Work
78
- constitutes direct or contributory patent infringement, then any patent licenses
79
- granted to You under this License for that Work shall terminate as of the date
80
- such litigation is filed.
81
-
82
- 4. Redistribution. You may reproduce and distribute copies of the Work or
83
- Derivative Works thereof in any medium, with or without modifications, and in
84
- Source or Object form, provided that You meet the following conditions:
85
-
86
- (a) You must give any other recipients of the Work or Derivative Works a copy of
87
- this License; and
88
-
89
- (b) You must cause any modified files to carry prominent notices stating that You
90
- changed the files; and
91
-
92
- (c) You must retain, in the Source form of any Derivative Works that You
93
- distribute, all copyright, patent, trademark, and attribution notices from the
94
- Source form of the Work, excluding those notices that do not pertain to any part
95
- of the Derivative Works; and
96
-
97
- (d) If the Work includes a "NOTICE" text file as part of its distribution, then
98
- any Derivative Works that You distribute must include a readable copy of the
99
- attribution notices contained within such NOTICE file, excluding those notices
100
- that do not pertain to any part of the Derivative Works, in at least one of the
101
- following places: within a NOTICE text file distributed as part of the Derivative
102
- Works; within the Source form or documentation, if provided along with the
103
- Derivative Works; or, within a display generated by the Derivative Works, if and
104
- wherever such third-party notices normally appear. The contents of the NOTICE
105
- file are for informational purposes only and do not modify the License. You may
106
- add Your own attribution notices within Derivative Works that You distribute,
107
- alongside or as an addendum to the NOTICE text from the Work, provided that such
108
- additional attribution notices cannot be construed as modifying the License.
109
-
110
- You may add Your own copyright statement to Your modifications and may provide
111
- additional or different license terms and conditions for use, reproduction, or
112
- distribution of Your modifications, or for any such Derivative Works as a whole,
113
- provided Your use, reproduction, and distribution of the Work otherwise complies
114
- with the conditions stated in this License.
115
-
116
- 5. Submission of Contributions. Unless You explicitly state otherwise, any
117
- Contribution intentionally submitted for inclusion in the Work by You to the
118
- Licensor shall be under the terms and conditions of this License, without any
119
- additional terms or conditions. Notwithstanding the above, nothing herein shall
120
- supersede or modify the terms of any separate license agreement you may have
121
- executed with Licensor regarding such Contributions.
122
-
123
- 6. Trademarks. This License does not grant permission to use the trade names,
124
- trademarks, service marks, or product names of the Licensor, except as required
125
- for reasonable and customary use in describing the origin of the Work and
126
- reproducing the content of the NOTICE file.
127
-
128
- 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
129
- writing, Licensor provides the Work (and each Contributor provides its
130
- Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
131
- either express or implied, including, without limitation, any warranties or
132
- conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
133
- PARTICULAR PURPOSE. You are solely responsible for determining the
134
- appropriateness of using or redistributing the Work and assume any risks
135
- associated with Your exercise of permissions under this License.
136
-
137
- 8. Limitation of Liability. In no event and under no legal theory, whether in
138
- tort (including negligence), contract, or otherwise, unless required by
139
- applicable law (such as deliberate and grossly negligent acts) or agreed to in
140
- writing, shall any Contributor be liable to You for damages, including any
141
- direct, indirect, special, incidental, or consequential damages of any character
142
- arising as a result of this License or out of the use or inability to use the
143
- Work (including but not limited to damages for loss of goodwill, work stoppage,
144
- computer failure or malfunction, or any and all other commercial damages or
145
- losses), even if such Contributor has been advised of the possibility of such
146
- damages.
147
-
148
- 9. Accepting Warranty or Additional Liability. While redistributing the Work or
149
- Derivative Works thereof, You may choose to offer, and charge a fee for,
150
- acceptance of support, warranty, indemnity, or other liability obligations and/or
151
- rights consistent with this License. However, in accepting such obligations, You
152
- may act only on Your own behalf and on Your sole responsibility, not on behalf of
153
- any other Contributor, and only if You agree to indemnify, defend, and hold each
154
- Contributor harmless for any liability incurred by, or claims asserted against,
155
- such Contributor by reason of your accepting any such warranty or additional
156
- liability.
157
-
158
- END OF TERMS AND CONDITIONS
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,129 +1,86 @@
1
- <p align="center">
2
- <img src="https://i.imgur.com/h6UIYTu.png" alt="Prisma" width="360" />
3
- </p>
1
+ <div align="center">
2
+ <h1>Prisma</h1>
3
+ <a href="https://www.npmjs.com/package/prisma"><img src="https://img.shields.io/npm/v/prisma.svg?style=flat" /></a>
4
+ <a href="https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
5
+ <a href="https://github.com/prisma/prisma/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache%202-blue" /></a>
6
+ <a href="https://pris.ly/discord"><img alt="Discord" src="https://img.shields.io/discord/937751382725886062?label=Discord"></a>
7
+ <br />
8
+ <br />
9
+ <a href="https://www.prisma.io/docs/getting-started/prisma-orm/quickstart/prisma-postgres">Quickstart</a>
10
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
11
+ <a href="https://www.prisma.io/">Website</a>
12
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
13
+ <a href="https://www.prisma.io/docs/">Docs</a>
14
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
15
+ <a href="https://github.com/prisma/prisma-examples/">Examples</a>
16
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
17
+ <a href="https://www.prisma.io/blog">Blog</a>
18
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
19
+ <a href="https://pris.ly/discord">Discord</a>
20
+ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
21
+ <a href="https://twitter.com/prisma">Twitter</a>
22
+ <br />
23
+ <hr />
24
+ </div>
4
25
 
5
- # Prisma CLI
26
+ ## What is Prisma?
6
27
 
7
- [![npm version](https://img.shields.io/npm/v/prisma?label=npm)](https://www.npmjs.com/package/prisma)
8
- [![license](https://img.shields.io/npm/l/prisma)](https://github.com/prisma/prisma-cli/blob/main/LICENSE)
9
- [![Node.js](https://img.shields.io/node/v/prisma)](https://www.npmjs.com/package/prisma)
28
+ Prisma is a **next-generation ORM** that consists of these tools:
10
29
 
11
- [Quickstart](#quickstart) • [Commands](#commands) • [Beta notes](#beta-notes) • [Documentation](#documentation) • [Support](#support)
30
+ - [**Prisma Client**](https://www.prisma.io/docs/concepts/components/prisma-client): Auto-generated and type-safe query builder for Node.js & TypeScript
31
+ - [**Prisma Migrate**](https://www.prisma.io/docs/concepts/components/prisma-migrate): Declarative data modeling & migration system
32
+ - [**Prisma Studio**](https://github.com/prisma/studio): GUI to view and edit data in your database
12
33
 
13
- ---
34
+ Prisma Client can be used in _any_ Node.js or TypeScript backend application (including serverless applications and microservices). This can be a [REST API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/rest), a [GraphQL API](https://www.prisma.io/docs/concepts/overview/prisma-in-your-stack/graphql) a gRPC API, or anything else that needs a database.
14
35
 
15
- `prisma` is the public beta of the new CLI for the
16
- Prisma Developer Platform.
36
+ **If you need a database to use with Prisma ORM, check out [Prisma Postgres](https://www.prisma.io/docs/getting-started/prisma-orm/quickstart/prisma-postgres?utm_source=npm&utm_medium=readme) or if you are looking for our MCP Server, head [here](https://github.com/prisma/mcp).**
17
37
 
18
- It is one binary for the ORM, Composer, and the Prisma Developer
19
- Platform: projects, branches, services, service versions, environment
20
- variables, and the Prisma ORM schema and migration workflow.
38
+ ## Getting started
21
39
 
22
- ---
40
+ The fastest way to get started with Prisma is by following the [**Quickstart (5 min)**](https://pris.ly/quickstart).
23
41
 
24
- ## Quickstart
42
+ The Quickstart is based on a preconfigured SQLite database. You can also get started with your own database (PostgreSQL and MySQL) by following one of these guides:
25
43
 
26
- Install the beta package locally:
44
+ - [Add Prisma to an existing project](https://www.prisma.io/docs/getting-started/prisma-orm/add-to-existing-project/postgresql)
45
+ - [Set up a new project with Prisma from scratch](https://www.prisma.io/docs/getting-started/setup-prisma/start-from-scratch/relational-databases-typescript-postgresql)
27
46
 
28
- ```bash
29
- npm install --save-dev prisma@next
30
- ```
47
+ ## Community
31
48
 
32
- Run the binary exposed by this package:
49
+ Prisma has a large and supportive [community](https://www.prisma.io/community) of enthusiastic application developers. You can join us on [Discord](https://pris.ly/discord) and here on [GitHub](https://github.com/prisma/prisma/discussions).
33
50
 
34
- ```bash
35
- npx prisma --help
36
- npx prisma auth login
37
- npx prisma project create my-app
38
- npx prisma git connect git@github.com:owner/repo.git
39
- ```
51
+ ## Security
40
52
 
41
- Deployments start from pushing the connected repository, the Console, or `prisma deploy`.
53
+ If you have a security issue to report, please contact us at [security@prisma.io](mailto:security@prisma.io?subject=[GitHub]%20Prisma%202%20Security%20Report%20).
42
54
 
43
- With `pnpm`:
44
-
45
- ```bash
46
- pnpm add -D prisma@next
47
- pnpm prisma auth login
48
- pnpm prisma git connect
49
- ```
50
-
51
- Useful next commands:
52
-
53
- ```bash
54
- npx prisma service list
55
- npx prisma service logs
56
- npx prisma project env add DATABASE_URL=postgresql://example --role preview
57
- npx prisma project env add --file .env --role preview
58
- npx prisma project env list
59
- npx prisma project env list --role preview
60
- ```
61
-
62
- ---
63
-
64
- ## Commands
65
-
66
- | Group | What it does |
67
- | --- | --- |
68
- | `auth` | Log in, log out, and inspect the active Prisma account. |
69
- | `project` | List, create, link, and manage projects and their environment variables. |
70
- | `git` | Connect or disconnect a project from a GitHub repository; pushes deploy. |
71
- | `branch` | List Prisma branches for the resolved project. |
72
- | `postgres` | Create, inspect, back up, restore, and delete Prisma Postgres databases and their connections. |
73
- | `bucket` | Create, list, and delete object-store buckets and their access keys. |
74
- | `service` | Inspect services: versions, logs, domains, promote, roll back, delete. |
75
- | `dev`, `deploy` | Run a Composer app locally; deploy it to the platform. |
76
- | `contract`, `db`, `migration`, `orm init`, `lsp` | The Prisma ORM workflow. |
77
-
78
- Common examples:
55
+ ## Support
79
56
 
80
- ```bash
81
- npx prisma --version
82
- npx prisma auth whoami
83
- npx prisma project show
84
- npx prisma branch list
85
- npx prisma service list
86
- npx prisma service version promote VERSION_ID
87
- ```
57
+ ### Ask a question about Prisma
88
58
 
89
- ### Built for humans, CI, and agents
59
+ You can ask questions and initiate [discussions](https://github.com/prisma/prisma/discussions/) about Prisma-related topics in the `prisma` repository on GitHub.
90
60
 
91
- - Human-readable output by default.
92
- - `--json` for structured output.
93
- - `--no-interactive` and `--yes` for automation.
94
- - `PRISMA_SERVICE_TOKEN` for headless authenticated commands.
95
- - Stable command groups, flags, and error codes for scripts and agents.
96
- - Environment variable values are not printed back to the terminal.
61
+ 👉 [**Ask a question**](https://github.com/prisma/prisma/discussions/new)
97
62
 
98
- ---
63
+ ### Create a bug report for Prisma
99
64
 
100
- ## Beta notes
65
+ If you see an error message or run into an issue, please make sure to create a bug report! You can find [best practices for creating bug reports](https://www.prisma.io/docs/guides/other/troubleshooting-orm/creating-bug-reports) (like including additional debugging output) in the docs.
101
66
 
102
- - Requires Node.js 22.18 or newer.
103
- - This is a release-candidate package and may change quickly.
104
- - The 8.0.0 release candidates publish as `prisma` on the `next` dist-tag.
105
- - The package binary is `prisma`.
106
- - Local project context is cached in `.prisma/local.json`, which is gitignored and not a declarative repo config file.
67
+ 👉 [**Create bug report**](https://pris.ly/prisma-prisma-bug-report)
107
68
 
108
- ---
69
+ ### Submit a feature request
109
70
 
110
- ## Documentation
71
+ If Prisma currently doesn't have a certain feature, be sure to check out the [roadmap](https://www.prisma.io/docs/more/roadmap) to see if this is already planned for the future.
111
72
 
112
- - [CLI docs index](https://github.com/prisma/prisma-cli/blob/main/docs/README.md)
113
- - [Command principles](https://github.com/prisma/prisma-cli/blob/main/docs/product/command-principles.md)
114
- - [Output conventions](https://github.com/prisma/prisma-cli/blob/main/docs/product/output-conventions.md)
115
- - [Error conventions](https://github.com/prisma/prisma-cli/blob/main/docs/product/error-conventions.md)
73
+ If the feature on the roadmap is linked to a GitHub issue, please make sure to leave a +1 on the issue and ideally a comment with your thoughts about the feature!
116
74
 
117
- ## Support
75
+ 👉 [**Submit feature request**](https://github.com/prisma/prisma/issues/new?assignees=&labels=&template=feature_request.md&title=)
118
76
 
119
- Issues and feedback are welcome while the CLI is in public beta. Please use
120
- [GitHub issues](https://github.com/prisma/prisma-cli/issues) for bug reports and
121
- feature requests.
77
+ ## Contributing
122
78
 
123
- Security reports should follow Prisma's
124
- [security policy](https://github.com/prisma/prisma-cli/blob/main/SECURITY.md)
125
- and should not be filed as public issues.
79
+ Refer to our [contribution guidelines](https://github.com/prisma/prisma/blob/main/CONTRIBUTING.md) and [Code of Conduct for contributors](https://github.com/prisma/prisma/blob/main/CODE_OF_CONDUCT.md).
126
80
 
127
- ## License
81
+ ## Tests Status
128
82
 
129
- Apache-2.0
83
+ - Prisma Tests Status:
84
+ [![CI](https://github.com/prisma/prisma/actions/workflows/test.yml/badge.svg)](https://github.com/prisma/prisma/actions/workflows/test.yml)
85
+ - Ecosystem Tests Status:
86
+ [![Actions Status](https://github.com/prisma/ecosystem-tests/workflows/test/badge.svg)](https://github.com/prisma/ecosystem-tests/actions)