Saltar a contenido

Especificación Técnica: rel_unidades_comerciales_sucursales

Esquema: clientes
Base de Datos: crm
Tabla Legacy Origen: i144t_unidad_comercial_sucursal
Propósito: Habilitación y despliegue operativo de las líneas y unidades comerciales de negocio en cada sucursal física de la empresa.


1. Justificación y Mejoras de Arquitectura

  • Normalización de Matriz Unidad Comercial - Sucursal N:M: Permite definir qué unidades de negocio comerciales (distribución, retail, mayorista, exportación) están autorizadas y operativas en cada sede o sucursal de la organización.
  • Desacoplamiento Cross-Database: El campo sucursal_id UUID NOT NULL mantiene la correlación lógica con la entidad mae_sucursales en core.identidad sin forzar llaves foráneas físicas inter-base.
  • Aislamiento Multi-Tenant (RLS): Integra empresa_id BIGINT NOT NULL con políticas RLS obligatorias (USING y WITH CHECK).
  • Integridad Referencial Compuesta: Clave única compuesta (empresa_id, id) y clave foránea compuesta (empresa_id, unidad_comercial_id) hacia clientes.cat_unidades_comerciales(empresa_id, id) con eliminación en cascada (ON DELETE CASCADE).
  • Unicidad de Habilitación: Restricción UNIQUE (empresa_id, unidad_comercial_id, sucursal_id) para prevenir duplicados de configuración por sucursal.
  • Trazabilidad y Auditoría: Auditoría integral (created_at, updated_at, deleted_at, created_by, updated_by) con auditoría integral.

2. Definiciones de Implementación

Table clientes.rel_unidades_comerciales_sucursales {
    id                  uuid        [pk, default: `gen_random_uuid()`, note: 'Identificador único UUID']
    empresa_id                  bigint        [not null, note: 'Identificador BIGINT de la empresa en core.identidad (RLS)']
    unidad_comercial_id uuid        [not null, note: 'Línea de negocio o unidad comercial']
    sucursal_id         uuid        [not null, note: 'Correlación lógica con core.identidad.mae_sucursales (sin FK física)']

    // Auditoría General
    is_activo           boolean     [not null, default: `true`, note: 'Estado lógico del registro']
    created_at          timestamptz [not null, default: `now()`, note: 'Fecha de creación']
    updated_at          timestamptz [not null, default: `now()`, note: 'Fecha de última actualización']
    deleted_at          timestamptz [note: 'Fecha de eliminación lógica']
    created_by          uuid        [note: 'Usuario creador']
    updated_by          uuid        [note: 'Usuario modificador']

    Indexes {
        (empresa_id, id) [unique, name: 'uq_rel_unidades_comerciales_suc_empresa_id']
        (empresa_id, unidad_comercial_id, sucursal_id) [unique, name: 'uq_rel_unidades_comerciales_suc_asignacion']
        (empresa_id, is_activo) [name: 'ix_rel_unidades_sucursales_empresa_activo']
        (empresa_id, unidad_comercial_id) [name: 'ix_rel_unidades_sucursales_empresa_unidad']
        (empresa_id, sucursal_id) [name: 'ix_rel_unidades_sucursales_empresa_sucursal']
    }
}

Ref: clientes.rel_unidades_comerciales_sucursales.(empresa_id, unidad_comercial_id) > clientes.cat_unidades_comerciales.(empresa_id, id) [delete: cascade]
CREATE TABLE IF NOT EXISTS clientes.rel_unidades_comerciales_sucursales (
    id UUID NOT NULL DEFAULT gen_random_uuid(),
    empresa_id BIGINT NOT NULL,
    unidad_comercial_id UUID NOT NULL,
    sucursal_id UUID NOT NULL,

    -- Auditoría General
    is_activo BOOLEAN NOT NULL DEFAULT true,
    created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
    updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
    deleted_at TIMESTAMPTZ,
    created_by UUID,
    updated_by UUID,

    CONSTRAINT pk_rel_unidades_comerciales_sucursales
        PRIMARY KEY (id),

    CONSTRAINT uq_rel_unidades_comerciales_suc_empresa_id
        UNIQUE (empresa_id, id),

    CONSTRAINT uq_rel_unidades_comerciales_suc_asignacion
        UNIQUE (empresa_id, unidad_comercial_id, sucursal_id),

    CONSTRAINT fk_rel_unidades_comerciales_suc_unidad
        FOREIGN KEY (empresa_id, unidad_comercial_id)
        REFERENCES clientes.cat_unidades_comerciales (empresa_id, id)
        ON DELETE CASCADE
);

CREATE INDEX IF NOT EXISTS ix_rel_unidades_sucursales_empresa_activo
    ON clientes.rel_unidades_comerciales_sucursales (empresa_id, is_activo);

CREATE INDEX IF NOT EXISTS ix_rel_unidades_sucursales_empresa_unidad
    ON clientes.rel_unidades_comerciales_sucursales (empresa_id, unidad_comercial_id);

CREATE INDEX IF NOT EXISTS ix_rel_unidades_sucursales_empresa_sucursal
    ON clientes.rel_unidades_comerciales_sucursales (empresa_id, sucursal_id);

COMMENT ON TABLE clientes.rel_unidades_comerciales_sucursales IS
    'Unidades Comerciales por Sucursal: Habilitación y despliegue operativo de las líneas y unidades comerciales de negocio en cada sucursal física de la empresa.';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.id IS
    'Identificador único UUID';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.empresa_id IS
    'Identificador UUID de la empresa en core.identidad (RLS)';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.unidad_comercial_id IS
    'Línea de negocio o unidad comercial';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.sucursal_id IS
    'Correlación lógica con core.identidad.mae_sucursales (sin FK física)';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.is_activo IS
    'Estado lógico del registro';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.created_at IS
    'Fecha de creación';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.updated_at IS
    'Fecha de última actualización';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.deleted_at IS
    'Fecha de eliminación lógica';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.created_by IS
    'Usuario creador';

COMMENT ON COLUMN clientes.rel_unidades_comerciales_sucursales.updated_by IS
    'Usuario modificador';

ALTER TABLE clientes.rel_unidades_comerciales_sucursales
    ENABLE ROW LEVEL SECURITY;

CREATE POLICY rls_rel_unidades_comerciales_suc_empresa
    ON clientes.rel_unidades_comerciales_sucursales
    FOR ALL
    USING (
        empresa_id = current_setting(
            'app.current_empresa_id',
            true
        )::BIGINT
    )
    WITH CHECK (
        empresa_id = current_setting(
            'app.current_empresa_id',
            true
        )::BIGINT
    );
import uuid
from datetime import datetime
from typing import Optional

from sqlalchemy import (
    BigInteger,
    Boolean,
    ForeignKeyConstraint,
    Index,
    UniqueConstraint,
    text,
)
from sqlalchemy.dialects.postgresql import TIMESTAMPTZ, UUID
from sqlalchemy.orm import Mapped, mapped_column

from app.db.base import Base


class RelUnidadesComercialesSucursales(Base):
    """
    Unidades Comerciales por Sucursal.

    Habilitación y despliegue operativo de las líneas y unidades comerciales
    de negocio en cada sucursal física de la empresa.

    Legacy:
        i144t_unidad_comercial_sucursal
    """

    __tablename__ = "rel_unidades_comerciales_sucursales"

    __table_args__ = (
        UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_rel_unidades_comerciales_suc_empresa_id",
        ),
        UniqueConstraint(
            "empresa_id",
            "unidad_comercial_id",
            "sucursal_id",
            name="uq_rel_unidades_comerciales_suc_asignacion",
        ),
        ForeignKeyConstraint(
            ["empresa_id", "unidad_comercial_id"],
            ["clientes.cat_unidades_comerciales.empresa_id", "clientes.cat_unidades_comerciales.id"],
            ondelete="CASCADE",
            name="fk_rel_unidades_comerciales_suc_unidad",
        ),
        Index(
            "ix_rel_unidades_sucursales_empresa_activo",
            "empresa_id",
            "is_activo",
        ),
        Index(
            "ix_rel_unidades_sucursales_empresa_unidad",
            "empresa_id",
            "unidad_comercial_id",
        ),
        Index(
            "ix_rel_unidades_sucursales_empresa_sucursal",
            "empresa_id",
            "sucursal_id",
        ),
        {
            "schema": "clientes",
            "comment": "Unidades Comerciales por Sucursal",
        },
    )

    id: Mapped[uuid.UUID] = mapped_column(
        UUID(as_uuid=True),
        primary_key=True,
        server_default=text("gen_random_uuid()"),
        comment="Identificador único UUID",
    )

    empresa_id: Mapped[int] = mapped_column(
        BigInteger,
        nullable=False,
        comment="Identificador UUID de la empresa en core.identidad (RLS)",
    )

    unidad_comercial_id: Mapped[uuid.UUID] = mapped_column(
        UUID(as_uuid=True),
        nullable=False,
        comment="Línea de negocio o unidad comercial",
    )

    sucursal_id: Mapped[uuid.UUID] = mapped_column(
        UUID(as_uuid=True),
        nullable=False,
        comment="Correlación lógica con core.identidad.mae_sucursales (sin FK física)",
    )

    is_activo: Mapped[bool] = mapped_column(
        Boolean,
        nullable=False,
        server_default=text("true"),
        comment="Estado lógico del registro",
    )

    created_at: Mapped[datetime] = mapped_column(
        TIMESTAMPTZ,
        nullable=False,
        server_default=text("now()"),
        comment="Fecha de creación",
    )

    updated_at: Mapped[datetime] = mapped_column(
        TIMESTAMPTZ,
        nullable=False,
        server_default=text("now()"),
        comment="Fecha de última actualización",
    )

    deleted_at: Mapped[Optional[datetime]] = mapped_column(
        TIMESTAMPTZ,
        nullable=True,
        comment="Fecha de eliminación lógica",
    )

    created_by: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True),
        nullable=True,
        comment="Usuario creador",
    )

    updated_by: Mapped[Optional[uuid.UUID]] = mapped_column(
        UUID(as_uuid=True),
        nullable=True,
        comment="Usuario modificador",
    )
"""create rel_unidades_comerciales_sucursales

Revision ID: rel_0007
Revises: rel_0006
Create Date: 2026-09-10
"""

from typing import Sequence, Union

from alembic import op
import sqlalchemy as sa
from sqlalchemy.dialects import postgresql


# revision identifiers, used by Alembic.
revision: str = "rel_0007"
down_revision: Union[str, Sequence[str], None] = "rel_0006"
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:

    op.create_table(
        "rel_unidades_comerciales_sucursales",

        sa.Column(
            "id",
            postgresql.UUID(as_uuid=True),
            nullable=False,
            server_default=sa.text("gen_random_uuid()"),
            comment="Identificador único UUID",
        ),

        sa.Column(
            "empresa_id",
            sa.BigInteger(),
            nullable=False,
            comment="Identificador UUID de la empresa en core.identidad (RLS)",
        ),

        sa.Column(
            "unidad_comercial_id",
            postgresql.UUID(as_uuid=True),
            nullable=False,
            comment="Línea de negocio o unidad comercial",
        ),

        sa.Column(
            "sucursal_id",
            postgresql.UUID(as_uuid=True),
            nullable=False,
            comment="Correlación lógica con core.identidad.mae_sucursales (sin FK física)",
        ),

        # Auditoría General
        sa.Column(
            "is_activo",
            sa.Boolean(),
            nullable=False,
            server_default=sa.text("true"),
            comment="Estado lógico del registro",
        ),

        sa.Column(
            "created_at",
            sa.TIMESTAMP(timezone=True),
            nullable=False,
            server_default=sa.text("now()"),
            comment="Fecha de creación",
        ),

        sa.Column(
            "updated_at",
            sa.TIMESTAMP(timezone=True),
            nullable=False,
            server_default=sa.text("now()"),
            comment="Fecha de última actualización",
        ),

        sa.Column(
            "deleted_at",
            sa.TIMESTAMP(timezone=True),
            nullable=True,
            comment="Fecha de eliminación lógica",
        ),

        sa.Column(
            "created_by",
            postgresql.UUID(as_uuid=True),
            nullable=True,
            comment="Usuario creador",
        ),

        sa.Column(
            "updated_by",
            postgresql.UUID(as_uuid=True),
            nullable=True,
            comment="Usuario modificador",
        ),

        sa.PrimaryKeyConstraint(
            "id",
            name="pk_rel_unidades_comerciales_sucursales",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "id",
            name="uq_rel_unidades_comerciales_suc_empresa_id",
        ),

        sa.UniqueConstraint(
            "empresa_id",
            "unidad_comercial_id",
            "sucursal_id",
            name="uq_rel_unidades_comerciales_suc_asignacion",
        ),

        sa.ForeignKeyConstraint(
            ["empresa_id", "unidad_comercial_id"],
            ["clientes.cat_unidades_comerciales.empresa_id", "clientes.cat_unidades_comerciales.id"],
            ondelete="CASCADE",
            name="fk_rel_unidades_comerciales_suc_unidad",
        ),

        comment="Unidades Comerciales por Sucursal",
        schema="clientes",
    )

    op.create_index(
        "ix_rel_unidades_sucursales_empresa_activo",
        "rel_unidades_comerciales_sucursales",
        ["empresa_id", "is_activo"],
        unique=False,
        schema="clientes",
    )

    op.create_index(
        "ix_rel_unidades_sucursales_empresa_unidad",
        "rel_unidades_comerciales_sucursales",
        ["empresa_id", "unidad_comercial_id"],
        unique=False,
        schema="clientes",
    )

    op.create_index(
        "ix_rel_unidades_sucursales_empresa_sucursal",
        "rel_unidades_comerciales_sucursales",
        ["empresa_id", "sucursal_id"],
        unique=False,
        schema="clientes",
    )

    op.execute(
        """
        ALTER TABLE clientes.rel_unidades_comerciales_sucursales
        ENABLE ROW LEVEL SECURITY;
        """
    )

    op.execute(
        """
        CREATE POLICY rls_rel_unidades_comerciales_suc_empresa
        ON clientes.rel_unidades_comerciales_sucursales
        FOR ALL
        USING (
            empresa_id = current_setting(
                'app.current_empresa_id',
                true
            )::BIGINT
        )
        WITH CHECK (
            empresa_id = current_setting(
                'app.current_empresa_id',
                true
            )::BIGINT
        );
        """
    )


def downgrade() -> None:

    op.execute(
        """
        DROP POLICY IF EXISTS rls_rel_unidades_comerciales_suc_empresa
        ON clientes.rel_unidades_comerciales_sucursales;
        """
    )

    op.execute(
        """
        ALTER TABLE clientes.rel_unidades_comerciales_sucursales
        DISABLE ROW LEVEL SECURITY;
        """
    )

    op.drop_index(
        "ix_rel_unidades_sucursales_empresa_sucursal",
        table_name="rel_unidades_comerciales_sucursales",
        schema="clientes",
    )

    op.drop_index(
        "ix_rel_unidades_sucursales_empresa_unidad",
        table_name="rel_unidades_comerciales_sucursales",
        schema="clientes",
    )

    op.drop_index(
        "ix_rel_unidades_sucursales_empresa_activo",
        table_name="rel_unidades_comerciales_sucursales",
        schema="clientes",
    )

    op.drop_table(
        "rel_unidades_comerciales_sucursales",
        schema="clientes",
    )