TableContract Loader¶
DKOps.table_governance.contracts.loader
¶
loader.py¶
Carga y resuelve contratos de tabla (Table Contracts) desde archivos JSON.
Un contrato de tabla define el schema, tipos, particiones, propiedades y permisos de una tabla Delta en Unity Catalog. Este módulo se encarga de:
- Leer el JSON del contrato desde disco.
- Resolver los placeholders
{catalog.<capa>}y{path.<nombre>}usando elEnvironmentConfigactivo del Launcher. - Devolver un
TableContract— dataclass inmutable y tipado que el resto del módulo (validators, writers, migrators) consume.
Placeholders soportados en el JSON¶
{catalog.bronze} → env.get_catalog("bronze")
{catalog.silver} → env.get_catalog("silver")
{catalog.gold} → env.get_catalog("gold")
{path.raw} → env.get_path("raw")
{path.curated} → env.get_path("curated")
{path.archive} → env.get_path("archive")
{env} → env.env (ej: "dev", "prod")
{env_short} → env.env_short (ej: "d", "p")
Ejemplo de contrato JSON¶
{
"catalog": "{catalog.bronze}",
"schema": "aeronautica",
"name": "vuelos_raw",
"type": "EXTERNAL",
"format": "DELTA",
"comment": "Datos crudos de vuelos",
"owner": "data-engineers",
"location": "{path.raw}/aeronautica/vuelos_raw",
"columns": [
{"name": "vuelo_id", "type": "STRING", "nullable": false},
{"name": "origen", "type": "STRING"},
{"name": "fecha", "type": "DATE"},
{"name": "cargado_en", "type": "TIMESTAMP", "default": "current_timestamp()"}
],
"partitions": ["fecha"],
"properties": {
"delta.autoOptimize.optimizeWrite": "true",
"quality": "raw",
"merge_schema": true,
"change_data_feed": true
},
"permissions": [
{"action": "SELECT", "principal": "analysts-group", "operation": "GRANT"}
]
}
Flags especiales en properties¶
merge_schema (bool) — activa mergeSchema=true en append/overwrite_partition.
change_data_feed (bool) — inyecta delta.enableChangeDataFeed=true en TBLPROPERTIES.
Estos flags son extraídos del dict antes de construir el TableContract.
No llegan como TBLPROPERTIES al motor Delta.
Uso¶
from DKOps.table_governance.contracts.loader import load_contract
launcher = Launcher("config.json")
contract = load_contract("tables/aeronautica/vuelos_raw.json")
print(contract.full_name) # ct_bronze_dlsuraanaliticadev.aeronautica.vuelos_raw
print(contract.location) # abfss://raw@dlsuraanaliticadev.../aeronautica/vuelos_raw
print(contract.column_names) # ['vuelo_id', 'origen', 'fecha', 'cargado_en']
print(contract.required_columns) # ['vuelo_id', 'origen', 'fecha'] (sin defaults)
Attributes¶
DELTA_TYPE_ALIASES = {'STRING': ['StringType'], 'INTEGER': ['IntegerType', 'LongType'], 'LONG': ['LongType'], 'DOUBLE': ['DoubleType', 'FloatType', 'DecimalType'], 'FLOAT': ['FloatType', 'DecimalType'], 'BOOLEAN': ['BooleanType'], 'DATE': ['DateType'], 'TIMESTAMP': ['TimestampType', 'TimestampNTZType'], 'BINARY': ['BinaryType'], 'DECIMAL': ['DecimalType'], 'ARRAY': ['ArrayType'], 'MAP': ['MapType'], 'STRUCT': ['StructType']}
module-attribute
¶
WIDENING_ALLOWED = {'INTEGER': {'LongType'}, 'FLOAT': {'DoubleType', 'DecimalType'}, 'DOUBLE': {'DecimalType'}, 'DATE': {'TimestampType'}}
module-attribute
¶
VALID_OPERATIONS = {'GRANT', 'REVOKE'}
module-attribute
¶
VALID_ACTIONS = {'SELECT', 'MODIFY', 'CREATE', 'READ_METADATA', 'ALL PRIVILEGES', 'USAGE', 'EXECUTE'}
module-attribute
¶
Classes¶
ColumnContract
dataclass
¶
Definición de una columna dentro del contrato de tabla.
Atributos¶
name : nombre de la columna (snake_case) type : tipo Delta (STRING, INTEGER, DATE, …) nullable : permite NULL (default True) comment : descripción de la columna default : expresión SQL de valor por defecto (ej: "current_timestamp()") Si está presente, la columna puede omitirse en el DataFrame y el writer la añadirá automáticamente.
Source code in src/DKOps/table_governance/contracts/loader.py
Attributes¶
name
instance-attribute
¶
type
instance-attribute
¶
nullable = True
class-attribute
instance-attribute
¶
comment = ''
class-attribute
instance-attribute
¶
default = None
class-attribute
instance-attribute
¶
mask = None
class-attribute
instance-attribute
¶
has_default
property
¶
has_mask
property
¶
spark_types
property
¶
Tipos Spark que son compatibles con este tipo de contrato.
widening_types
property
¶
Tipos Spark que se aceptan por widening (compatibles hacia arriba).
Functions¶
__init__(name, type, nullable=True, comment='', default=None, mask=None)
¶
PermissionContract
dataclass
¶
Un GRANT o REVOKE sobre la tabla.
Source code in src/DKOps/table_governance/contracts/loader.py
ClusteringContract
dataclass
¶
Columnas de liquid clustering (Databricks).
Source code in src/DKOps/table_governance/contracts/loader.py
TableContract
dataclass
¶
Contrato completo de una tabla Delta — inmutable y tipado.
Construido por load_contract(). No instanciar directamente.
Propiedades útiles¶
full_name → "
Source code in src/DKOps/table_governance/contracts/loader.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | |
Attributes¶
catalog
instance-attribute
¶
schema
instance-attribute
¶
name
instance-attribute
¶
type
instance-attribute
¶
format
instance-attribute
¶
comment = ''
class-attribute
instance-attribute
¶
owner = ''
class-attribute
instance-attribute
¶
location = ''
class-attribute
instance-attribute
¶
columns = field(default_factory=tuple)
class-attribute
instance-attribute
¶
partitions = field(default_factory=tuple)
class-attribute
instance-attribute
¶
clustering = None
class-attribute
instance-attribute
¶
properties = field(default_factory=dict)
class-attribute
instance-attribute
¶
permissions = field(default_factory=tuple)
class-attribute
instance-attribute
¶
merge_schema = False
class-attribute
instance-attribute
¶
change_data_feed = False
class-attribute
instance-attribute
¶
source_path = ''
class-attribute
instance-attribute
¶
full_name
property
¶
catalog.schema.name — identificador canónico en Unity Catalog.
column_names
property
¶
required_columns
property
¶
Columnas que DEBEN estar en el DataFrame (sin default).
default_columns
property
¶
Columnas con default — el writer las añade si faltan en el DF.
non_nullable_columns
property
¶
Columnas con nullable=False — no pueden tener nulls.
nullable_map
property
¶
partition_columns
property
¶
effective_name
property
¶
Nombre de la tabla calificado según el runtime activo.
Databricks → catalog.schema.name (Unity Catalog gestiona el path) Local PC → schema.name (catálogo nativo de Spark)
Resuelve el runtime via Launcher.current() — asume que hay un Launcher activo. Es el nombre que debe usarse en cualquier SQL directo que referencie la tabla (SELECT, JOIN, etc.).
masked_columns
property
¶
Columnas que tienen política de masking definida.
Functions¶
__init__(catalog, schema, name, type, format, comment='', owner='', location='', columns=tuple(), partitions=tuple(), clustering=None, properties=dict(), permissions=tuple(), merge_schema=False, change_data_feed=False, source_path='')
¶
get_column(name)
¶
Devuelve la ColumnContract por nombre, o None si no existe.
is_external()
¶
ContractLoader
¶
Bases: LoggableMixin
Carga contratos de tabla desde JSON y resuelve sus variables de entorno.
Parámetros¶
env : EnvironmentConfig opcional. Si no se pasa, se obtiene del Launcher activo (Launcher.current().env). Solo es útil pasarlo explícitamente en tests o flujos avanzados con múltiples envs.
Uso¶
loader = ContractLoader() # usa Launcher.current()
contract = loader.load("tables/aeronautica/vuelos_raw.json")
Source code in src/DKOps/table_governance/contracts/loader.py
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 | |
Functions¶
__init__(env=None)
¶
Source code in src/DKOps/table_governance/contracts/loader.py
load(path)
¶
Carga y resuelve un contrato desde un archivo JSON.
Parámetros¶
path : ruta al archivo .json del contrato.
Devuelve¶
TableContract inmutable y listo para usar.
Lanza¶
FileNotFoundError si el archivo no existe. ValueError si el JSON es inválido o le faltan campos obligatorios. KeyError si un placeholder referencia un catálogo/path no definido.
Source code in src/DKOps/table_governance/contracts/loader.py
load_many(paths)
¶
Carga múltiples contratos de una vez. Falla rápido en el primero inválido.
Source code in src/DKOps/table_governance/contracts/loader.py
load_schema(schema_dir)
¶
Carga todos los contratos .json de un directorio de schema.
Source code in src/DKOps/table_governance/contracts/loader.py
Functions¶
load_contract(path, env=None)
¶
Shortcut para cargar un único contrato sin instanciar ContractLoader.
Si env no se pasa, se obtiene del Launcher activo. Pasarlo
explícitamente solo es útil en tests o flujos avanzados.
Uso¶
contract = load_contract("tables/aeronautica/vuelos_raw.json")
Source code in src/DKOps/table_governance/contracts/loader.py
load_schema_contracts(schema_dir, env=None)
¶
Shortcut para cargar todos los contratos de un directorio de schema.
Uso¶
contracts = load_schema_contracts("tables/aeronautica/")