CatgirlIntelligenceAgency/code/common/db
Viktor Lofgren 1d34224416 (refac) Remove src/main from all source code paths.
Look, this will make the git history look funny, but trimming unnecessary depth from the source tree is a very necessary sanity-preserving measure when dealing with a super-modularized codebase like this one.

While it makes the project configuration a bit less conventional, it will save you several clicks every time you jump between modules.  Which you'll do a lot, because it's *modul*ar.  The src/main/java convention makes a lot of sense for a non-modular project though.  This ain't that.
2024-02-23 16:13:40 +01:00
..
java/nu/marginalia/db (refac) Remove src/main from all source code paths. 2024-02-23 16:13:40 +01:00
resources/db/migration (refac) Remove src/main from all source code paths. 2024-02-23 16:13:40 +01:00
test/nu/marginalia/db (refac) Remove src/main from all source code paths. 2024-02-23 16:13:40 +01:00
build.gradle (refac) Remove src/main from all source code paths. 2024-02-23 16:13:40 +01:00
readme.md (doc) Remove confusingly outdated ER-diagrams 2023-09-21 15:08:27 +02:00

DB

This module primarily contains SQL files for the URLs database. The most central tables are EC_DOMAIN, EC_URL and EC_PAGE_DATA.

Flyway

The system uses flyway to track database changes and allow easy migrations, this is accessible via gradle tasks.

  • flywayMigrate
  • flywayBaseline
  • flywayRepair
  • flywayClean (dangerous as in wipes your entire database)

Refer to the Flyway documentation for guidance. It's well documented and these are probably the only four tasks you'll ever need.

If you are not running the system via docker, you need to provide alternative connection details than the defaults (TODO: how?).

The migration files are in resources/db/migration. The file name convention incorporates the project's cal-ver versioning; and are applied in lexicographical order.

VYY_MM_v_nnn__description.sql

Central Paths

See Also

  • common/service implements DatabaseModule, which is from where the services get database connections.