Skip to content
This repository was archived by the owner on Oct 21, 2020. It is now read-only.

Introspection spec #153

Draft
janpio wants to merge 18 commits into
base: master
Choose a base branch
from
Draft

Introspection spec #153

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
0547854
bare minimum introspection spec as starting point
janpio Sep 17, 2019
106ae7f
docs: Update TOC
github-actions[bot] Sep 17, 2019
f2d98bf
Update README.md
janpio Sep 17, 2019
873a6b1
docs: Update TOC
github-actions[bot] Sep 17, 2019
274df91
add highlevel description for introspection
do4gr Sep 18, 2019
7547fc1
link to headlines, remove copypasta
do4gr Sep 18, 2019
7399717
docs: Update TOC
github-actions[bot] Sep 18, 2019
0097c43
Update README.md
janpio Sep 19, 2019
780efc5
docs: Update TOC
github-actions[bot] Sep 19, 2019
80d427d
add structure to describe current implementation
do4gr Oct 29, 2019
23ba0e5
docs: Update TOC
github-actions[bot] Oct 29, 2019
7fa55ee
add more sub points, add enums
do4gr Oct 30, 2019
317edb3
Merge branch 'introspection' of https://github.com/prisma/specs into …
do4gr Oct 30, 2019
88aa485
docs: Update TOC
github-actions[bot] Oct 30, 2019
c924f1f
more relation explanations, enum comments
do4gr Oct 30, 2019
dfbdeca
Merge branch 'introspection' of https://github.com/prisma/specs into …
do4gr Oct 30, 2019
25bb01c
Remove areas that are covered by the PSL -> SQL spec already.
do4gr Oct 31, 2019
1f5ba66
docs: Update TOC
github-actions[bot] Oct 31, 2019
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
20 changes: 3 additions & 17 deletions introspection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,12 @@
- State:
- Spec: In Progress 🚧
- Implementation: Unknown ❔

When a user gets started with Prisma in a brownfield project, they can let Prisma introspect their database to generate the initial Prisma data model definition.
Copy link
Contributor Author

@janpio janpio Sep 18, 2019

Choose a reason for hiding this comment

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

We actually "require" this introduction summary sentence - so we should come up with something more generalized about "Introspection" in the Prisma context. (Matt might have something liek that already in his Prisma framework PR)


---

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Motivation](#motivation)
- [Implementation](#implementation)
- [Current](#current)
- [Future 👽](#future-)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Motivation
Expand All @@ -36,22 +28,16 @@ Introspection happens in the following steps:
* The introspection connector takes that db-schema representation and converts it into Prismas internal datamodel representation
* The internal datamodel representation gets rendered into the Prisma schema

The formats for the connection strings are discussed in the schema spec. https://github.com/prisma/specs/blob/master/schema/Readme.md
The formats for the connection strings are discussed in the schema spec. https://github.com/prisma/specs/tree/master/schema#supported-fields
The conversion from the sql-schema to the Prisma internal datamodel changes the information from a description of the data layout / connection in the db to the data structure used to generate the API. This means that some tables / collections that are present in the database are omitted while some fields that have no representation in the database are generated.

* Backrelation fields for relations that store Ids in the model table
* Omitting Prisma style M:N relation tables and adding relationfields to their models
* Omitting Prisma style scalar list tables and instead adding the list fields to their models

The logic Prisma uses to create names for relations / relation fields in cases where they are not specified in the database is also described in the Schema spec.
The logic Prisma uses to create names for relations / relation fields in cases where they are not specified in the database is also described in the Schema spec. https://github.com/prisma/specs/tree/master/schema#relations

The renderer then takes the internal datamodel representation and prints it. While doing this, it omits printing out some information if it follows Prismas opionionation. Examples include:

* not printing relation names for unambigous relations if their name matches a Prisma style M:N relation table '_PostToUser'
* not printing the @relation(references: id) if the foreign key is on the lexicographically lower model

### Current


### Future 👽
Copy link
Contributor Author

@janpio janpio Sep 18, 2019

Choose a reason for hiding this comment

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

The idea about these headlines was to describe the existing JS/TS implementation and then the "new" Rust based one - maybe this is not useful any more.


* not printing the @relation(references: id) if the foreign key is on the lexicographically lower model