Skip to content

Add docs on Data Proxy directUrl property - #4377

Merged
ruheni merged 15 commits into
mainfrom
direct-url
Feb 7, 2023
Merged

Add docs on Data Proxy directUrl property#4377
ruheni merged 15 commits into
mainfrom
direct-url

Conversation

@keerlu

@keerlu keerlu commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

Describe this PR

  • Add Data Proxy directUrl property to datasource block in schema reference
  • Update Data Proxy page on introspect/migrate/CLI commands

Changes

What issue does this fix?

Fixes #4297
Fixes #4305

Any other relevant information

@vercel

vercel Bot commented Jan 10, 2023

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 7, 2023 at 7:26PM (UTC)

@github-actions

github-actions Bot commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

This PR changes the following pages (Vercel Preview Deploy links):

Changed Vercel links

(Note that links will only be valid after Vercel preview deploy succeeded)

@keerlu
keerlu marked this pull request as draft January 10, 2023 11:10
@keerlu keerlu changed the title Add Data Proxy directUrl property to schema reference Add docs on Data Proxy directUrl property Jan 10, 2023
Comment thread content/400-reference/200-api-reference/100-prisma-schema-reference.mdx Outdated
@keerlu
keerlu marked this pull request as ready for review January 10, 2023 14:33
Comment thread content/800-data-platform/050-data-proxy/700-prisma-cli-with-data-proxy.mdx Outdated
Comment thread content/800-data-platform/050-data-proxy/700-prisma-cli-with-data-proxy.mdx Outdated
@janpio

janpio commented Jan 10, 2023

Copy link
Copy Markdown
Contributor

Note that we already have a shortlink pointing to this section, which seem to have broken in an earlier update when the headline/anchor was renamed: https://pris.ly/d/data-proxy-cli We should make sure we have a good headline to link to that can be updated via a PR to pris.ly

…ata-proxy.mdx

Co-authored-by: Jan Piotrowski <piotrowski+github@gmail.com>
@keerlu

keerlu commented Jan 11, 2023

Copy link
Copy Markdown
Contributor Author

This seems to be the place the shortlink is used: https://sourcegraph.com/github.com/prisma/prisma/-/blob/packages/internals/src/cli/checkUnsupportedDataProxy.ts?L37

I think linking to this whole page, rather than a heading, would work, as is the message is about the general problem with needing to use a direct connection

@janpio

janpio commented Jan 11, 2023

Copy link
Copy Markdown
Contributor

True, before this was just a subsection of a page - not it is its own page.
Then we only need to remove the anchor from the pris.ly config to avoid this confusion moving forward.

Comment thread content/400-reference/200-api-reference/100-prisma-schema-reference.mdx Outdated
Comment thread content/400-reference/200-api-reference/100-prisma-schema-reference.mdx Outdated
Comment thread content/800-data-platform/050-data-proxy/700-prisma-cli-with-data-proxy.mdx Outdated
@zachtil

zachtil commented Jan 12, 2023

Copy link
Copy Markdown
Contributor

Thank you for helping with this content, @keerlu! 🙏 That is going to make things so much easier for Data Proxy users! 😌

Comment thread content/400-reference/200-api-reference/100-prisma-schema-reference.mdx Outdated

@sabinadams sabinadams left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of this looks good to me

Comment on lines +10 to +12
Currently, you can only use [Prisma Client](/concepts/components/prisma-client) with the Data Proxy to _query_ your database.

</TopBlock>

You need a direct (non-Data Proxy) database connection if you apply schema changes to your database with [Prisma Migrate](/concepts/components/prisma-migrate/get-started) or [`db push`](/concepts/components/prisma-migrate/db-push), or if you [introspect](/concepts/components/introspection) your database. See [Prisma CLI commands that require a direct database connection](#prisma-cli-commands-that-require-a-direct-database-connection).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upon rereading this, we could make clearer that Prisma Client is totally fine.
And that it is only Prisma CLI where commands are not by default and the additional feature here are needed.
Right now that is not super spelled out, both in words and visually.

(Line 12 could maybe start with "In Prisma CLI you need...")

@amlcodes

amlcodes commented Feb 7, 2023

Copy link
Copy Markdown

prisma:warn Attempt 1/10 failed for querying: Internal Data Proxy error (The request id was: 84981ec9bae4ff43536662429f743c00)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PDP: Update Prisma CLI with Data Proxy page Add Data Proxy directUrl property to datasource block documentation

7 participants