654 updated database documentation

[temmey]

Basics

• I added a line to /doc/CHANGELOG.md
• The PR is rebased with current master.
• Details of what you changed are in commit messages.
• References to issues, e.g. close #X, are in the commit messages.
• The buildserver is happy.

Checklist

• I have installed and I am using pre-commit hooks
• I fully described what my PR does in the documentation
  (not in the PR description)
• I fixed all affected documentation
• I fixed the introduction tour
• I wrote migrations in a way that they are compatible with already present data
• I fixed all affected decisions
• I added unit tests for my code
• I added code comments, logging, and assertions as appropriate
• I translated all strings visible to the user
• I mentioned every code or binary not directly written or done by me in reuse syntax
• I created left-over issues for things that are still to be done
• Code is conforming to our Architecture
• Code is conforming to our Guidelines
  (exceptions are documented)
• Code is consistent to our Design Decisions

Review

• I've tested the code
• I've read through the whole code
• Examples are well chosen and understandable

[badnames]

Well done!
As usual just a few minor things.

[markus2330]

@temmey let us get this done, please request review when you are ready and/or set labels accordingly

[markus2330]

@temmey let us do this first, it basically only needs that you reread your own text and rebase it.

[chr-schr]

Some sections are incomplete / not up to date with the database schema.

[chr-schr]

Fix types

Suggested change

	INT price
	INT generation
	TEXT notes
	INT owner_id "NOT NULL"
	SMALLINT price
	SMALLINT generation
	TEXT notes
	UUID owner_id "NOT NULL"

[chr-schr]

Fix types

Suggested change

	INT zoom_factor "NOT NULL"
	INT honors "NOT NULL"
	INT visits "NOT NULL"
	INT harvested "NOT NULL"
	PRIVACY_OPTION privacy "NOT NULL"
	TEXT description
	GEOGRAPHY location
	INT owner_id "NOT NULL"
	SMALLINT zoom_factor "NOT NULL"
	SMALLINT honors "NOT NULL"
	SMALLINT visits "NOT NULL"
	SMALLINT harvested "NOT NULL"
	PRIVACY_OPTION privacy "NOT NULL"
	TEXT description
	GEOGRAPHY location
	UUID owner_id "NOT NULL"

[chr-schr]

Fix type

Suggested change

	INT id PK
	UUID id PK

[chr-schr]

Add missing seed_id

Suggested change

	}
	INT seed_id
	}

[chr-schr]

Fix typo

Suggested change

	TRACKS track
	TRACK track

[chr-schr]

Table is called gained_blossoms

Suggested change

	blossoms_gained {
	gained_blossoms {

[chr-schr]

Some relationships were missing

Suggested change

	blossoms ||--o{ blossoms_gained : ""
	blossoms ||--o{ gained_blossoms : ""
	gained_blossoms }o--|| users : "gained by"
	users ||--o| guided_tours : ""
	base_layer_images }o--|| layers : "belongs to"
	users ||--o{ seeds : ""
	plantings }o--|| seeds : ""

[chr-schr]

Suggested change

	## `Plant_detail`
	## `Plants`

[chr-schr]

Not up to date with the database schema

[markus2330]

I think we shouldn't fully replicate everything in docu but rather only have the essence. Maybe we simply remove/reduce this?

[markus2330]

Great job! Maybe a bit reduction and when @chr-schr approves, we can merge.

[markus2330]

I think we shouldn't fully replicate everything in docu but rather only have the essence. Maybe we simply remove/reduce this?

[chr-schr]

I would argue to remove the table descriptions. Ideally they would be somehow automatically generated from the rust table definitions such that we only have a single source of truth, but as it stands I anticipate them to always be out of sync.

[markus2330]

If we don't find some minimal descriptions that are still useful to get an overview, we can also get rid of this documentation completely.

What speaks to maybe keep it: It was mostly used to design the relations and might be useful when we do non-trivial extensions.

We can today also speak a bit about how to document GIS systems.