feat: add Meta.db_table alias for table name#2207
Open
waketzheng wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add
Meta.db_tableas an alias forMeta.tablewhen configuring model table names.This change allows:
table = "custom_table"db_table = "custom_table"tableanddb_tablewhen they have the same valueIf both options are set with different values, model creation raises
ConfigurationError.The model documentation has also been updated to mention
db_table.Motivation and Context
Users coming from Django often expect
Meta.db_tableto customize the database table name. Previously, Tortoise ORM only recognizedMeta.table, sodb_tablewas silently ignored.Supporting
db_tablemakes the behavior friendlier for Django users while keeping the existingtableoption fully backward compatible.How Has This Been Tested?
Tested on Windows with Python 3.14.3.
Commands run:
tests/test_table_name.pynow covers:Meta.tablestill taking precedence over the global table name generatorMeta.db_tableworking as a table name overrideMeta.tableandMeta.db_tableMeta.tableandMeta.db_tableraisingConfigurationErrorChecklist: