ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

orionis.console.commands.db.wipe.DatabaseWiper

class documentation

class DatabaseWiper: (source)

Constructor: DatabaseWiper(inspector)

View In Hierarchy

Remove user-defined objects from a selected connection.

Static Method _dependencyOrder Order objects so dependencies are removed after their dependents.
Method __init__ Keep the inspector used for the wipe.
Async Method _disableSqlserverTemporalTables Disable system versioning for temporal tables before dropping them.
Async Method _dropDomains Drop PostgreSQL domains.
Async Method _dropMaterializedViews Drop materialized views before regular views and tables.
Async Method _dropSqlserverForeignKeys Remove foreign keys before dropping SQL Server tables.
Async Method _dropSqlserverViews Drop SQL Server views in dependency-safe order.
Async Method _dropTables Drop listed tables.
Async Method _dropTypes Drop listed schema types.
Async Method _dropViews Drop listed views.
Async Method _orderSqlserverTypes Order SQL Server user-defined types before their dependencies.
Async Method _prepareOracleTypes Validate and order Oracle types for safe deletion.
Async Method _wipeMysql Temporarily disable foreign-key checks while removing MySQL objects.
Async Method wipe Remove all discoverable user objects from the selected database.
Class Variable __slots__ Undocumented
Instance Variable _inspector Undocumented
def _dependencyOrder(dependencies: dict[str, set[str]], cycle_error: str) -> list[str]: (source)

Order objects so dependencies are removed after their dependents.

Parameters
dependencies:dict[str, set[str]]Mapping of each object to the objects it depends on.
cycle_error:strError message to raise when a dependency cycle is detected.
Returns
list[str]Objects ordered for safe removal.
def __init__(self, inspector: DatabaseInspector): (source)

Keep the inspector used for the wipe.

Parameters
inspector:DatabaseInspectorInspector for the target database connection.
Returns
NoneComplete the documented operation without returning a value.
async def _disableSqlserverTemporalTables(self, tables: list[str]): (source)

Disable system versioning for temporal tables before dropping them.

Parameters
tables:list[str]Table names to prepare.
Returns
NoneComplete the documented operation without returning a value.
async def _dropDomains(self, domains: list[str]): (source)

Drop PostgreSQL domains.

Parameters
domains:list[str]Domain names to remove.
Returns
NoneComplete the documented operation without returning a value.
async def _dropMaterializedViews(self, views: list[str]): (source)

Drop materialized views before regular views and tables.

Parameters
views:list[str]Materialized view names to remove.
Returns
NoneComplete the documented operation without returning a value.
async def _dropSqlserverForeignKeys(self, tables: list[str]): (source)

Remove foreign keys before dropping SQL Server tables.

Parameters
tables:list[str]Table names whose keys are removed.
Returns
NoneComplete the documented operation without returning a value.
async def _dropSqlserverViews(self, views: list[str]): (source)

Drop SQL Server views in dependency-safe order.

Parameters
views:list[str]View names to remove.
Returns
NoneComplete the documented operation without returning a value.
async def _dropTables(self, tables: list[str], *, cascade: bool = False): (source)

Drop listed tables.

Parameters
tables:list[str]Table names to remove.
cascade:bool, optionalWhether to cascade dependent objects when supported by the database.
Returns
NoneComplete the documented operation without returning a value.
async def _dropTypes(self, types: list[str], *, cascade: bool = False): (source)

Drop listed schema types.

Parameters
types:list[str]Type names to remove.
cascade:bool, optionalWhether to cascade dependent objects when supported by the database.
Returns
NoneComplete the documented operation without returning a value.
async def _dropViews(self, views: list[str], *, cascade: bool = False): (source)

Drop listed views.

Parameters
views:list[str]View names to remove.
cascade:bool, optionalWhether to cascade dependent objects when supported by the database.
Returns
NoneComplete the documented operation without returning a value.
async def _orderSqlserverTypes(self, types: list[str]) -> list[str]: (source)

Order SQL Server user-defined types before their dependencies.

Parameters
types:list[str]User-defined type names to remove.
Returns
list[str]Type names in a safe drop order.
async def _prepareOracleTypes(self, tables: list[str], views: list[str], materialized_views: list[str], types: list[str]) -> list[str]: (source)

Validate and order Oracle types for safe deletion.

Parameters
tables:list[str]Tables included in the wipe scope.
views:list[str]Views included in the wipe scope.
materialized_views:list[str]Materialized views included in the wipe scope.
types:list[str]Type names to validate and order.
Returns
list[str]Ordered type names safe to drop.
async def _wipeMysql(self, views: list[str], tables: list[str]): (source)

Temporarily disable foreign-key checks while removing MySQL objects.

Parameters
views:list[str]Names of views to drop.
tables:list[str]Names of tables to drop.
Returns
NoneComplete the documented operation without returning a value.
async def wipe(self) -> WipeResult: (source)

Remove all discoverable user objects from the selected database.

Returns
WipeResultNumber of tables, views, and types found before removal.
__slots__: tuple[str, ...] = (source)

Undocumented

_inspector = (source)

Undocumented