inbo / inbo/tutorials

Tutorial about how to structure data in a relational database system

Open
#283 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

proposal tutorial
Dominant language
HTML
Stars
24
Forks
10
Avg merge
2d 32m
Merged PRs (30d)
2

Description

I've had the chance in the last few years to work in collaboration with biodiversity professionals, and from my IT-oriented perspective there's often a lack of knowledge about how to efficiently organise / structure the data in a relational database systems. To be more precise: there's generally enough knowledge to make something "that works", but a better structured database would be much more future-proof (less data errors, easier to reuse the data in other contexts such as data publication, web portals, ...)

That tutorial would not cover SQL nor the technicalities of a given database engine (SQLite, PostgreSQL, ...), but rather help answering questions such as

  • should a given piece of information be placed in a new field or in a new table?
  • how should I link tables X, Y and Z so they can be queried to answer a wide range of questions?
  • what constraint can I configure early when I create a database so human errors (i.e. typos when entering data) are detected as early as possible (and the database doesn't get messier when it gets more used/bigger)

Is there any demand for this from scientists, or is it just me?

If so, I'd be happy to help contributing to a tutorial (but I think it can be a pretty large task, so I'd like to have an idea of the interest first).

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed tutorial scope: relational database structure, table and field choices, relationships, and constraints, while excluding SQL and database-engine specifics. Confirm whether scientists need this material and agree on the intended examples and coverage before drafting; done means a complete, published tutorial with that scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, sqlite
Domain
databases, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.