search

rivenmedia / riven

Handle your Media Library with ease!
https://rivenmedia.github.io/wiki/
GNU General Public License v3.0
396 stars 54 forks source link

feat: database migrations, so long db resets #858

Closed Gaisberg closed 2 weeks ago

Gaisberg commented 2 weeks ago

Pull Request Check List

Resolves: #issue-number-here

Description:

Summary by CodeRabbit

Release Notes

These updates enhance the database management capabilities and streamline migration processes, providing users with better control and diagnostics.

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request introduces significant enhancements to the database migration system using Alembic for a media management application. Key changes include the addition of a new Alembic configuration file, the establishment of a baseline database schema, and the implementation of improved logging and error handling mechanisms. New functions for resetting the database and managing migrations have been added, while redundant code has been removed to streamline the migration process. Additionally, command-line interface updates allow for pre-migration database resets, enhancing user control over database management.

Changes

File Change Summary
src/alembic.ini New configuration file for Alembic with parameters like script_location, file_template, etc.
src/alembic/env.py Added logging with Loguru, new functions for database reset and migration handling.
src/alembic/script.py.mako New Mako template for Alembic migration scripts with placeholders for dynamic content.
src/alembic/versions/20241105_1300_c99709e3648f_baseline_schema.py New migration script establishing baseline schema with multiple tables and relationships.
src/program/db/db.py Removed redundant Alembic management code, simplified migration execution logic.
src/program/db/db_functions.py Enhanced database reset functionality, added new method for pre-migration reset.
src/program/settings/models.py Added new boolean attribute debug_database to AppModel class.
src/program/utils/cli.py Introduced new CLI argument --hard_reset_db_pre_migration for pre-migration database reset.

Poem

🐇 In the burrow where data flows,
Alembic dances, as the schema grows.
With logs that sparkle, errors that fade,
A reset before migration, a fine upgrade.
Hopping through tables, oh what a sight,
In the world of databases, all feels right! 🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
iPromKnight commented 2 weeks ago

Looks good man - great work We can prob get rid of that README file

DamnDam commented 2 weeks ago

@dreulavelle I'm having a crash loop now on startup when upgrading from 0.16.2 to 0.17.0

riven | alembic.util.exc.CommandError: Can't locate revision identified by '97cbe84f0c18' riven | 24-11-05 19:12:00 | CRITICAL | main. - Server has been stopped

Gaisberg commented 2 weeks ago

Please run the following command: docker exec -it ”riven_container_name” python /riven/src/main.py —hard_reset_db_pre_migration

DamnDam commented 2 weeks ago

For reference when running in compose and crashlooping as I was:

docker compose run --entrypoint python riven /riven/src/main.py --hard_reset_db_pre_migration

filiptrplan commented 1 week ago

docker compose run --entrypoint python riven /riven/src/main.py --hard_reset_db_pre_migration

This should be really added to release notes! @dreulavelle