schema_sentinel.metadata_manager.enums

  1from dataclasses import dataclass
  2from enum import Enum
  3
  4
  5class ChangeSetUpdateAction(Enum):
  6    IGNORE = 0
  7    EXECUTE = 1
  8    ERROR = 2
  9    ASK = 3
 10
 11
 12class ExceptionAction(Enum):
 13    RAISE = 0
 14    CONTINUE = 1
 15    ASK = 2
 16
 17
 18class ConnectMode(Enum):
 19    SSO = 0
 20    PWD = 1
 21    KEY_PAIR = 2
 22
 23
 24class StreamSourceType(Enum):
 25    TABLE = 0
 26    VIEW = 1
 27
 28
 29class StreamMode(Enum):
 30    APPEND_ONLY = 0
 31    INSERT_ONLY = 1
 32
 33
 34class DbObjectType(Enum):
 35    DATABASE = ("database",)
 36    SCHEMA = ("schema",)
 37    STAGE = ("stage",)
 38    TABLE = ("table",)
 39    VIEW = ("view",)
 40    COLUMN = ("column",)
 41    PRIMARY_KEY = ("primary key",)
 42    UNIQUE_KEY = ("unique key",)
 43    FOREIGN_KEY = ("foreign key",)
 44    PROCEDURE = ("procedure",)
 45    FUNCTION = ("function",)
 46    STREAM = ("stream",)
 47    PIPE = ("pipe",)
 48    TASK = ("task",)
 49    PARAMETER = "parameter"
 50
 51
 52class DbFolderType(Enum):
 53    DATABASE = ((DbObjectType.DATABASE, "01"),)
 54    SCHEMA = ((DbObjectType.SCHEMA, "02"),)
 55    STAGE = ((DbObjectType.STAGE, "04"),)
 56    TABLE = ((DbObjectType.TABLE, "05"),)
 57    VIEW = ((DbObjectType.VIEW, "06"),)
 58    STREAM = ((DbObjectType.STREAM, "07"),)
 59    TASK = ((DbObjectType.TASK, "08"),)
 60    PROCEDURE = (DbObjectType.PROCEDURE, "09")
 61
 62
 63@dataclass
 64class Message:
 65    subject: str
 66    text: str
 67
 68
 69@dataclass
 70class DiffCategoryItem:
 71    id: int
 72    name: str
 73    message: Message
 74
 75
 76DATA_RETENTION_TIME_IN_DAYS = 7
 77
 78
 79class DbObjectType(Enum):
 80    DATABASE = "database"
 81    SCHEMA = "schema"
 82    TABLE = "table"
 83    COLUMN = "column"
 84    TABLE_CONSTRAINT = "table_constraint"
 85    COLUMN_CONSTRAINT = "column_constraint"
 86    REFERENTIAL_CONSTRAINT = "referential_constraint"
 87    VIEW = "view"
 88    PIPE = "pipe"
 89    STAGE = "stage"
 90    STREAM = "stream"
 91    TASK = "task"
 92    PROCEDURE = "procedure"
 93    FUNCTION = "function"
 94    CONSTRAINT = "constraint"
 95
 96    @staticmethod
 97    def list():
 98        return [e.value for e in DbObjectType]
 99
100
101class Environment(Enum):
102    DEV = "dev"
103    NON_PROD = "non_prod"
104    CERT = "cert"
105    PROD = "prod"
106
107    @staticmethod
108    def list():
109        return [e.value for e in Environment]
110
111
112class ConstraintType(Enum):
113    PRIMARY_KEY = "primary key"
114    UNIQUE_KEY = "unique"
115    FOREIGN_KEY = "foreign key"
116
117    @staticmethod
118    def list():
119        return [e.value for e in ConstraintType]
120
121
122class StageType(Enum):
123    INTERNAL_NAMED = "internal named"
124    EXTERNAL_NAMED = "external named"
125
126
127class DiffCategory(Enum):
128    TYPE = (
129        DiffCategoryItem(
130            0,
131            "object type",
132            Message(subject="object type", text="{} object {} is different from {}"),
133        ),
134    )
135    NAME = (
136        DiffCategoryItem(
137            1,
138            "object name",
139            Message(subject="object name", text="{} object {} is not in the list {}"),
140        ),
141    )
142    COMMENT = (
143        DiffCategoryItem(
144            2,
145            "object comment",
146            Message(subject="object comment", text="{} object {} is different from {}"),
147        ),
148    )
149    QUOTED_IDENTIFIER = (
150        DiffCategoryItem(
151            3,
152            "quoted identifier",
153            Message(subject="object comment", text="{} object {} is different from {}"),
154        ),
155    )
156    DATABASE_SCHEMAS = (
157        DiffCategoryItem(
158            4,
159            "database schemas",
160            Message(subject="object comment", text="{} object {} is different from {}"),
161        ),
162    )
163    SCHEMA_TABLES = (
164        DiffCategoryItem(
165            5,
166            "schema tables",
167            Message(subject="object comment", text="{} object {} is different from {}"),
168        ),
169    )
170    TABLE_COLUMNS = (
171        DiffCategoryItem(
172            6,
173            "table columns",
174            Message(subject="object comment", text="{} object {} is different from {}"),
175        ),
176    )
177    PARAMETERS = (
178        DiffCategoryItem(
179            6,
180            "parameters",
181            Message(subject="object comment", text="{} object {} is different from {}"),
182        ),
183    )
184    PRIMARY_KEY = (
185        DiffCategoryItem(
186            7,
187            "primary key",
188            Message(subject="object comment", text="{} object {} is different from {}"),
189        ),
190    )
191    UNIQUE_KEYS = (
192        DiffCategoryItem(
193            8,
194            "unique keys",
195            Message(subject="object comment", text="{} object {} is different from {}"),
196        ),
197    )
198    FOREIGN_KEYS = (
199        DiffCategoryItem(
200            9,
201            "foreign keys",
202            Message(subject="object comment", text="{} object {} is different from {}"),
203        ),
204    )
205    COLUMN_DATA_TYPE = (
206        DiffCategoryItem(
207            10,
208            "column data type",
209            Message(subject="object comment", text="{} object {} is different from {}"),
210        ),
211    )
212    NUMBER_SCALE = (
213        DiffCategoryItem(
214            10,
215            "number scale",
216            Message(subject="object comment", text="{} object {} is different from {}"),
217        ),
218    )
219    NUMBER_PRECISION = (
220        DiffCategoryItem(
221            11,
222            "number precision",
223            Message(subject="object comment", text="{} object {} is different from {}"),
224        ),
225    )
226    DATA_LENGTH = (
227        DiffCategoryItem(
228            12,
229            "column length",
230            Message(subject="object comment", text="{} object {} is different from {}"),
231        ),
232    )
233    COLUMN_NULLABLE = (
234        DiffCategoryItem(
235            13,
236            "is nullable",
237            Message(subject="object comment", text="{} object {} is different from {}"),
238        ),
239    )
240    COLUMN_DEFAULT = (
241        DiffCategoryItem(
242            14,
243            "column default",
244            Message(subject="object comment", text="{} object {} is different from {}"),
245        ),
246    )
247    COLUMN_UNIQUE = (
248        DiffCategoryItem(
249            15,
250            "is unique",
251            Message(subject="object comment", text="{} object {} is different from {}"),
252        ),
253    )
254    COLUMN_IS_PK = (
255        DiffCategoryItem(
256            16,
257            "is in primary key",
258            Message(subject="object comment", text="{} object {} is different from {}"),
259        ),
260    )
261    COLUMN_FOREIGN_KEY = DiffCategoryItem(
262        17,
263        "column is not in foreign key",
264        Message(
265            subject="column is not in foreign key",
266            text="{} object {} is different from {}",
267        ),
268    )