Skip to content

spire_flush

django_spire.core.management.commands.spire_flush

Command

Bases: BaseCommand

help = 'Removes ALL DATA from the database, including data added during migrations. Does not achieve a "fresh install" state.' class-attribute instance-attribute

stealth_options = ('reset_sequences', 'inhibit_post_migrate') class-attribute instance-attribute

add_arguments

Source code in django_spire/core/management/commands/spire_flush.py 
26
27
28
29
30
31
32
def add_arguments(self, parser: ArgumentParser) -> None:
    parser.add_argument(
        "--database",
        default=DEFAULT_DB_ALIAS,
        choices=tuple(connections),
        help='Nominates a database to flush. Defaults to the "default" database.',
    )

handle

Source code in django_spire/core/management/commands/spire_flush.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def handle(self, **options) -> None:
    database = options["database"]
    connection = connections[database]
    verbosity = options["verbosity"]
    allow_cascade = True

    # The following are stealth options used by Django's internals.
    reset_sequences = options.get("reset_sequences", True)
    inhibit_post_migrate = options.get("inhibit_post_migrate", False)

    self.style = no_style()

    # Import the 'management' module within each installed app, to register
    # dispatcher events.
    for app_config in apps.get_app_configs():
        with contextlib.suppress(ImportError):
            import_module(".management", app_config.name)

    sql_list = sql_flush(
        self.style,
        connection,
        reset_sequences=reset_sequences,
        allow_cascade=allow_cascade,
    )

    try:
        connection.ops.execute_sql_flush(sql_list)
    except Exception as exc:
        db_name = connection.settings_dict['NAME']

        message = (
            f"Database {db_name} couldn't be flushed."
            f" Possible reasons:\n"
            f"  * The database isn't running or isn't"
            f" configured correctly.\n"
            f"  * At least one of the expected database"
            f" tables doesn't exist.\n"
            f"  * The SQL was invalid.\n"
            f"Hint: Look at the output of"
            f" 'django-admin sqlflush'. "
            f"That's the SQL this command wasn't"
            f" able to run."
        )

        raise CommandError(message) from exc

    # Empty sql_list may signify an empty database and post_migrate
    # would then crash.
    if sql_list and not inhibit_post_migrate:
        # Emit the post migrate signal. This allows individual
        # applications to respond as if the database had been migrated
        # from scratch.
        emit_post_migrate_signal(verbosity, False, database)

    db_name = connection.settings_dict['NAME']
    self.stdout.write(f'Database "{db_name}" flushed successfully.')