Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add example on how to use prisma init --preview-feature #5403

Merged
merged 10 commits into from
Oct 30, 2023
Merged

add example on how to use prisma init --preview-feature #5403

Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0d48cc0
add example on how to use `prisma init --preview-feature`
ruheni Oct 27, 2023
f66d594
update description
ruheni Oct 27, 2023
763a3db
Apply suggestions from code review
ruheni Oct 27, 2023
a66fb14
Update content/400-reference/200-api-reference/200-command-reference.mdx
ruheni Oct 27, 2023
42b6580
Apply suggestions from code review
ruheni Oct 27, 2023
0a4deb2
Update content/400-reference/200-api-reference/200-command-reference.mdx
ruheni Oct 27, 2023
0571073
add output example
ruheni Oct 30, 2023
4a964bf
Apply suggestions from code review
ruheni Oct 30, 2023
2b433f2
format table
ruheni Oct 30, 2023
56d41bc
Merge branch 'main' into prisma-init-improvements
ruheni Oct 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions content/400-reference/200-api-reference/200-command-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,13 +306,14 @@ The `init` command does not interpret any existing files. Instead, it creates a

#### Arguments

| Argument | Required | Description | Default |
|-------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| `--datasource-provider` | No | Specifies the default value for the `provider` field in the `datasource` block. Options are `sqlite`, `postgresql`, `mysql`, `sqlserver`, `mongodb` and `cockroachdb`. | `postgresql` |
| `--url` | No | Define a custom datasource url. | |
| `--generator-provider` | No | Define the default generator provider to use. | `prisma-client-js` |
| `--preview-features` | No | Define the default Preview features to use. [Learn more](/concepts/components/preview-features) | |
| `--output` | No | Specifies the default output location for the generated client. [Learn more](/concepts/components/prisma-client/working-with-prismaclient/generating-prisma-client#using-a-custom-output-path) | `node_modules/.prisma/client` |
| Argument | Required | Description | Default |
|-------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
| `--datasource-provider` | No | Specifies the value for the `provider` field in the `datasource` block. Options are `sqlite`, `postgresql`, `mysql`, `sqlserver`, `mongodb` and `cockroachdb`. | `postgresql` |
| `--url` | No | Define a custom datasource url. | |
| `--generator-provider` | No | Define the generator provider to use. | `prisma-client-js` |
| `--preview-feature` | No | Define the [Preview features](/concepts/components/preview-features) to use. . To define multiple Preview features, you have to provide the flag multiple times for each Preview feature [See example](#run-prisma-init---preview-feature) | |
ruheni marked this conversation as resolved.
Show resolved Hide resolved
| `--output` | No | Specifies the [output location for the generated client](/concepts/components/prisma-client/working-with-prismaclient/generating-prisma-client#using-a-custom-output-path). | `node_modules/.prisma/client` |


#### Examples

Expand Down Expand Up @@ -356,6 +357,20 @@ prisma init --datasource-provider sqlite

The command output contains helpful information on how to use the generated files and begin using Prisma with your project.

#### Run `prisma init --preview-feature`

```terminal
prisma init --preview-feature multiSchema
```

The command sets `multiSchema` as a Preview feature in your schema.

```terminal
prisma init --preview-feature multiSchema --preview-feature metrics
```

The command sets `multiSchema` and `metrics` as the Preview features in your Prisma schema.
ruheni marked this conversation as resolved.
Show resolved Hide resolved

#### Generated Assets

**`prisma/schema.prisma`**
Expand Down
Loading