class documentation

class Command(BaseCommand):

Known subclasses: django.contrib.gis.management.commands.inspectdb.Command

View In Hierarchy

Undocumented

Method add​_arguments Entry point for subclassed commands to add custom arguments.
Method get​_field​_type Given the database connection, the table name, and the cursor row description, this routine will return the given field type name, as well as any additional keyword parameters and notes for the field.
Method get​_meta Return a sequence comprising the lines of code necessary to construct the inner Meta class for the model corresponding to the given database table name.
Method handle The actual logic of the command. Subclasses must implement this method.
Method handle​_inspection Undocumented
Method normalize​_col​_name Modify the column name to make it Python-compatible as a field name
Class Variable db​_module Undocumented
Class Variable help Undocumented
Class Variable requires​_system​_checks Undocumented
Class Variable stealth​_options Undocumented

Inherited from BaseCommand:

Method __init__ Undocumented
Method add​_base​_argument Call the parser's add_argument() method, suppressing the help text according to BaseCommand.suppressed_base_arguments.
Method check No summary
Method check​_migrations Print a warning if the set of migrations on disk don't match the migrations in the database.
Method create​_parser Create and return the ArgumentParser which will be used to parse the arguments to this command.
Method execute Try to execute this command, performing system checks if needed (as controlled by the requires_system_checks attribute, except if force-skipped).
Method get​_version Return the Django version, which should be correct for all built-in Django commands. User-supplied commands can override this method to return their own version.
Method print​_help Print the help message for this command, derived from self.usage().
Method run​_from​_argv No summary
Class Variable base​_stealth​_options Undocumented
Class Variable output​_transaction Undocumented
Class Variable requires​_migrations​_checks Undocumented
Class Variable suppressed​_base​_arguments Undocumented
Instance Variable ​_called​_from​_command​_line Undocumented
Instance Variable stderr Undocumented
Instance Variable stdout Undocumented
Instance Variable style Undocumented
def add_arguments(self, parser):
Entry point for subclassed commands to add custom arguments.
def get_field_type(self, connection, table_name, row):
Given the database connection, the table name, and the cursor row description, this routine will return the given field type name, as well as any additional keyword parameters and notes for the field.
def get_meta(self, table_name, constraints, column_to_field_name, is_view, is_partition):
Return a sequence comprising the lines of code necessary to construct the inner Meta class for the model corresponding to the given database table name.
def handle(self, **options):
The actual logic of the command. Subclasses must implement this method.
def handle_inspection(self, options):

Undocumented

def normalize_col_name(self, col_name, used_column_names, is_relation):
Modify the column name to make it Python-compatible as a field name
db_module: str =
help: str =
requires_system_checks: list =
stealth_options: tuple[str, ...] =