docs icon indicating copy to clipboard operation
docs copied to clipboard

Documentation for Introspection Warnings

Open janpio opened this issue 5 years ago • 8 comments

prisma introspect recently added Introspection Warning messages to communicate to the user about guardrails that were applied during Introspection. This currently looks like this:

image

We want to document these individually and offer workarounds. Additionally the error messages itself should be improved and link to the matching documentation.

PRs:

  • Engine PR to change error message (with link): https://github.com/prisma/prisma-engines/pull/638
  • Docs PR to add warning messages with description and workaround: https://github.com/prisma/prisma2-docs/pull/72
  • Pris.ly PR to add short links for docs sections: https://github.com/prisma/pris.ly/pull/3

janpio avatar Mar 30 '20 20:03 janpio

This would still be nice to have as people might wonder what these mean.

janpio avatar Sep 10 '20 10:09 janpio

@janpio Error reference-style docs?

mhwelander avatar Sep 15 '20 14:09 mhwelander

Maybe. Might also be enough to just mention Introspection Warnings, what they are and how they are output - and then possibly a few examples of the different "categories" and what you can/should do to work around these limitations.

janpio avatar Sep 15 '20 22:09 janpio

Here is the list of warnings that can be generated, hopefully self documenting: https://github.com/prisma/prisma-engines/blob/master/introspection-engine/connectors/sql-introspection-connector/src/warnings.rs

janpio avatar May 31 '21 09:05 janpio

Introspection Warning still exist and should be documented.

janpio avatar Aug 26 '22 23:08 janpio

Related file: https://github.com/prisma/prisma-engines/blob/main/schema-engine/connectors/schema-connector/src/warnings.rs

Jolg42 avatar May 04 '23 15:05 Jolg42

Related to: https://github.com/prisma/docs/issues/4758

ruheni avatar May 16 '23 11:05 ruheni

Related PR https://github.com/prisma/docs/pull/4777

mhessdev avatar Mar 13 '24 14:03 mhessdev

@aqrln this is still the related file right? (prisma/prisma-engines@main/schema-engine/connectors/schema-connector/src/warnings.rs](https://github.com/prisma/prisma-engines/blob/main/schema-engine/connectors/schema-connector/src/warnings.rs)

ankur-arch avatar Nov 13 '24 07:11 ankur-arch

Yes. Line ranges https://github.com/prisma/prisma-engines/blob/main/schema-engine/connectors/schema-connector/src/warnings.rs#L59-L136 and https://github.com/prisma/prisma-engines/blob/main/schema-engine/connectors/schema-connector/src/warnings.rs#L186-L412 are the useful parts.

aqrln avatar Nov 13 '24 09:11 aqrln

Closing this as not planned for now 🙏

nikolasburk avatar Nov 27 '24 12:11 nikolasburk