File: schema.pyi

package info (click to toggle)
python-django-stubs 5.2.9-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,832 kB
  • sloc: python: 5,185; makefile: 15; sh: 8
file content (110 lines) | stat: -rw-r--r-- 4,529 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
from collections.abc import Sequence
from contextlib import AbstractContextManager
from logging import Logger
from types import TracebackType
from typing import Any

from django.db.backends.base.base import BaseDatabaseWrapper
from django.db.backends.ddl_references import Statement
from django.db.models.base import Model
from django.db.models.constraints import BaseConstraint
from django.db.models.fields import Field
from django.db.models.indexes import Index
from django.db.models.sql.compiler import _AsSqlType
from typing_extensions import Self

logger: Logger

class BaseDatabaseSchemaEditor(AbstractContextManager[Any]):
    sql_create_table: str
    sql_rename_table: str
    sql_retablespace_table: str
    sql_delete_table: str
    sql_create_column: str
    sql_alter_column: str
    sql_alter_column_type: str
    sql_alter_column_null: str
    sql_alter_column_not_null: str
    sql_alter_column_default: str
    sql_alter_column_no_default: str
    sql_alter_column_no_default_null: str
    sql_delete_column: str
    sql_rename_column: str
    sql_update_with_default: str
    sql_unique_constraint: str
    sql_check_constraint: str
    sql_delete_constraint: str
    sql_constraint: str
    sql_create_check: str
    sql_delete_check: str
    sql_create_unique: str
    sql_delete_unique: str

    sql_create_fk: str
    sql_create_inline_fk: str | None
    sql_create_column_inline_fk: str | None
    sql_delete_fk: str

    sql_create_index: str
    sql_create_unique_index: str
    sql_rename_index: str
    sql_delete_index: str
    sql_create_pk: str
    sql_delete_pk: str
    sql_delete_procedure: str
    sql_alter_table_comment: str
    sql_alter_column_comment: str
    connection: BaseDatabaseWrapper
    collect_sql: bool
    collected_sql: Any
    atomic_migration: Any
    def __init__(self, connection: BaseDatabaseWrapper, collect_sql: bool = False, atomic: bool = True) -> None: ...
    deferred_sql: Any
    atomic: Any
    def __enter__(self) -> Self: ...
    def __exit__(
        self,
        exc_type: type[BaseException] | None,
        exc_value: BaseException | None,
        exc_tb: TracebackType | None,
    ) -> None: ...
    def execute(self, sql: Statement | str, params: Sequence[Any] | None = ()) -> None: ...
    def quote_name(self, name: str) -> str: ...
    def table_sql(self, model: type[Model]) -> tuple[str, list[Any]]: ...
    def column_sql(
        self, model: type[Model], field: Field, include_default: bool = False
    ) -> tuple[None, None] | tuple[str, list[Any]]: ...
    def skip_default(self, field: Field) -> bool: ...
    def skip_default_on_alter(self, field: Field) -> bool: ...
    def prepare_default(self, value: Any) -> Any: ...
    def db_default_sql(self, field: Field) -> _AsSqlType: ...
    def effective_default(self, field: Field) -> int | str: ...
    def quote_value(self, value: Any) -> str: ...
    def create_model(self, model: type[Model]) -> None: ...
    def delete_model(self, model: type[Model]) -> None: ...
    def add_index(self, model: type[Model], index: Index) -> None: ...
    def remove_index(self, model: type[Model], index: Index) -> None: ...
    def rename_index(self, model: type[Model], old_index: Index, new_index: Index) -> None: ...
    def add_constraint(self, model: type[Model], constraint: BaseConstraint) -> None: ...
    def remove_constraint(self, model: type[Model], constraint: BaseConstraint) -> None: ...
    def alter_unique_together(
        self,
        model: type[Model],
        old_unique_together: Sequence[Sequence[str]],
        new_unique_together: Sequence[Sequence[str]],
    ) -> None: ...
    def alter_index_together(
        self,
        model: type[Model],
        old_index_together: Sequence[Sequence[str]],
        new_index_together: Sequence[Sequence[str]],
    ) -> None: ...
    def alter_db_table(self, model: type[Model], old_db_table: str, new_db_table: str) -> None: ...
    def alter_db_table_comment(
        self, model: type[Model], old_db_table_comment: str, new_db_table_comment: str
    ) -> None: ...
    def alter_db_tablespace(self, model: type[Model], old_db_tablespace: str, new_db_tablespace: str) -> None: ...
    def add_field(self, model: type[Model], field: Field) -> None: ...
    def remove_field(self, model: type[Model], field: Field) -> None: ...
    def alter_field(self, model: type[Model], old_field: Field, new_field: Field, strict: bool = False) -> None: ...
    def remove_procedure(self, procedure_name: Any, param_types: Any = ()) -> None: ...