Saltar a contenido

Especificación Técnica: cat_modelos_comerciales

Esquema: clientes Base de Datos: crm

Tabla Legacy Origen: i746t_modelo_comercial

Propósito: Define las modalidades de negocio aplicables a la relación comercial con el cliente (Venta Directa, Consignación, Distribución Exclusiva, Preventa, Autoventa).


1. Justificación y Mejoras de Arquitectura

  • Estandarización: Estandariza el catálogo con UUID, multitenancy mediante RLS por empresa y claves únicas de código de negocio, eliminando cadenas sueltas y estructuras desnormalizadas.

  • Multi-tenancy y RLS: Cada registro incluye empresa_id BIGINT NOT NULL, utilizado para el aislamiento multitenant mediante PostgreSQL Row-Level Security (RLS). La empresa corresponde al UUID de core.identidad.

  • Auditoría estándar: La tabla incorpora trazabilidad mediante created_at, updated_at, deleted_at, created_by, updated_by y version.

  • Código de negocio: El código del modelo comercial es único dentro de cada empresa mediante UNIQUE (empresa_id, codigo).


2. Definiciones de Implementación

Table clientes.cat_modelos_comerciales {

    id                  uuid            [pk, default: `gen_random_uuid()`, note: 'Identificador único UUID']
    empresa_id                  bigint        [not null, note: 'BIGINT de la empresa en core.identidad (RLS)']
    codigo              varchar(30)     [not null, note: 'Código único del modelo comercial dentro de la empresa']
    nombre              varchar(100)    [not null, note: 'Nombre del modelo comercial']
    descripcion         varchar(255)    [note: 'Descripción del modelo comercial']

    // 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: 'UUID del usuario creador']
    updated_by          uuid            [note: 'UUID del usuario modificador']

    Indexes {
        (empresa_id, codigo) [unique, name: 'uq_cat_modelos_comerciales_empresa_codigo']
        (empresa_id, is_activo) [name: 'ix_cat_modelos_comerciales_empresa_activo']
    }
}
CREATE TABLE IF NOT EXISTS clientes.cat_modelos_comerciales (

    id UUID NOT NULL DEFAULT gen_random_uuid(),

    empresa_id BIGINT NOT NULL,

    codigo VARCHAR(30) NOT NULL,

    nombre VARCHAR(100) NOT NULL,

    descripcion VARCHAR(255),

    -- 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_cat_modelos_comerciales
        PRIMARY KEY (id),

    CONSTRAINT uq_cat_modelos_comerciales_empresa_codigo
        UNIQUE (empresa_id, codigo)

);

CREATE INDEX IF NOT EXISTS ix_cat_modelos_comerciales_empresa_activo
    ON clientes.cat_modelos_comerciales (
        empresa_id,
        is_activo
    );

COMMENT ON TABLE clientes.cat_modelos_comerciales IS
    'Modelos comerciales aplicables a la relación con el cliente.';

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

COMMENT ON COLUMN clientes.cat_modelos_comerciales.empresa_id IS
    'UUID de la empresa en core.identidad utilizado para aislamiento multitenant mediante RLS';

COMMENT ON COLUMN clientes.cat_modelos_comerciales.codigo IS
    'Código único del modelo comercial dentro de la empresa';

COMMENT ON COLUMN clientes.cat_modelos_comerciales.nombre IS
    'Nombre del modelo comercial';

COMMENT ON COLUMN clientes.cat_modelos_comerciales.descripcion IS
    'Descripción del modelo comercial';

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

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

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

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

COMMENT ON COLUMN clientes.cat_modelos_comerciales.created_by IS
    'UUID del usuario creador';

COMMENT ON COLUMN clientes.cat_modelos_comerciales.updated_by IS
    'UUID del usuario modificador';


ALTER TABLE clientes.cat_modelos_comerciales
    ENABLE ROW LEVEL SECURITY;


CREATE POLICY rls_cat_modelos_comerciales_empresa
    ON clientes.cat_modelos_comerciales
    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,
    Index,
    String,
    UniqueConstraint,
    text,
)

from sqlalchemy.dialects.postgresql import TIMESTAMPTZ, UUID

from sqlalchemy.orm import Mapped, mapped_column

from app.db.base import Base


class CatModelosComerciales(Base):
    """
    Modelos comerciales aplicables a la relación con el cliente.

    Legacy:
        i746t_modelo_comercial

    Ejemplos:
        - Venta Directa
        - Consignación
        - Distribución Exclusiva
        - Preventa
        - Autoventa
    """

    __tablename__ = "cat_modelos_comerciales"

    __table_args__ = (
        UniqueConstraint(
            "empresa_id",
            "codigo",
            name="uq_cat_modelos_comerciales_empresa_codigo",
        ),
        Index(
            "ix_cat_modelos_comerciales_empresa_activo",
            "empresa_id",
            "is_activo",
        ),
        {
            "schema": "clientes",
            "comment": (
                "Modelos comerciales aplicables "
                "a la relación con el cliente"
            ),
        },
    )

    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=(
            "UUID de la empresa en core.identidad "
            "utilizado para RLS"
        ),
    )

    codigo: Mapped[str] = mapped_column(
        String(30),
        nullable=False,
        comment=(
            "Código único del modelo comercial "
            "dentro de la empresa"
        ),
    )

    nombre: Mapped[str] = mapped_column(
        String(100),
        nullable=False,
        comment="Nombre del modelo comercial",
    )

    descripcion: Mapped[Optional[str]] = mapped_column(
        String(255),
        nullable=True,
        comment="Descripción del modelo comercial",
    )

    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="UUID del usuario creador",
    )

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

Revision: 0005 Down revision: 0004

Los valores 0005 y 0004 son referencias secuenciales. En el proyecto deben sustituirse por los identificadores reales generados por Alembic.

"""create cat_modelos_comerciales

Revision ID: 0005
Revises: 0004
Create Date: 2026-09-09
"""

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 = "0005"

down_revision: Union[str, Sequence[str], None] = "0004"

branch_labels: Union[str, Sequence[str], None] = None

depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:

    op.create_table(
        "cat_modelos_comerciales",

        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=(
                "UUID de la empresa en core.identidad "
                "utilizado para RLS"
            ),
        ),

        sa.Column(
            "codigo",
            sa.String(length=30),
            nullable=False,
            comment=(
                "Código único del modelo comercial "
                "dentro de la empresa"
            ),
        ),

        sa.Column(
            "nombre",
            sa.String(length=100),
            nullable=False,
            comment="Nombre del modelo comercial",
        ),

        sa.Column(
            "descripcion",
            sa.String(length=255),
            nullable=True,
            comment="Descripción del modelo comercial",
        ),

        # 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",
            postgresql.TIMESTAMP(timezone=True),
            nullable=False,
            server_default=sa.text("now()"),
            comment="Fecha de creación",
        ),

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

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

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

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

        # Constraints

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

        sa.UniqueConstraint(
            "empresa_id",
            "codigo",
            name="uq_cat_modelos_comerciales_empresa_codigo",
        ),

        comment=(
            "Modelos comerciales aplicables "
            "a la relación con el cliente"
        ),

        schema="clientes",
    )

    # Índices

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

    # Row Level Security

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

    # RLS Policy

    op.execute(
        """
        CREATE POLICY rls_cat_modelos_comerciales_empresa
        ON clientes.cat_modelos_comerciales
        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:

    # Eliminar RLS Policy

    op.execute(
        """
        DROP POLICY IF EXISTS
        rls_cat_modelos_comerciales_empresa
        ON clientes.cat_modelos_comerciales;
        """
    )

    # Deshabilitar RLS

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

    # Eliminar índice

    op.drop_index(
        "ix_cat_modelos_comerciales_empresa_activo",
        table_name="cat_modelos_comerciales",
        schema="clientes",
    )

    # Eliminar tabla

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