Saltar a contenido

Especificación Técnica: cat_clases_cliente

Esquema: clientes Base de Datos: crm
Tabla Legacy Origen: i248t_clase_cliente (co_clase_cliente, tx_clase_cliente)
Propósito: Categorización comercial de clientes según volumen, facturación o importancia estratégica (A, B, C, Clave, Corporativo, Distribuidor).


1. Justificación y Mejoras de Arquitectura

  • Estandariza catálogos tipados con UUID, multitenancy mediante RLS por empresa y claves únicas de negocio, eliminando cadenas sueltas y estructuras desnormalizadas.

- Multi-tenancy RLS y Auditoría Estándar: Cada tabla incluye empresa_id BIGINT NOT NULL, utilizado para el aislamiento multiempresa mediante políticas RLS y como identificador de la empresa en core.identidad. Además, incorpora trazabilidad mediante created_at, updated_at, deleted_at, created_by, updated_by y version.

2. Definiciones de Implementación

Table clientes.cat_clases_cliente {

    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)']
    codigo              varchar(30)   [not null, note: 'Código único de la clase dentro de la empresa']
    nombre              varchar(100)  [not null, note: 'Nombre de la categoría']
    prioridad_atencion  int           [not null, default: `1`, note: 'Nivel de prioridad operativa (1=Mayor)']
    descripcion         varchar(255)  [note: 'Descripción de la clase de cliente']

    // 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, codigo) [unique, name: 'uq_cat_clases_cliente_empresa_codigo']
        (empresa_id, is_activo) [name: 'ix_cat_clases_cliente_empresa_activo']
    }
}
CREATE TABLE IF NOT EXISTS clientes.cat_clases_cliente (

    id UUID NOT NULL DEFAULT gen_random_uuid(),

    empresa_id BIGINT NOT NULL,

    codigo VARCHAR(30) NOT NULL,

    nombre VARCHAR(100) NOT NULL,

    prioridad_atencion INT NOT NULL DEFAULT 1,

    descripcion VARCHAR(255),

    -- Auditoría
    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_clases_cliente
        PRIMARY KEY (id),

    CONSTRAINT uq_cat_clases_cliente_empresa_codigo
        UNIQUE (empresa_id, codigo)
);

CREATE INDEX IF NOT EXISTS ix_cat_clases_cliente_empresa_activo
    ON clientes.cat_clases_cliente (
        empresa_id,
        is_activo
    );

ALTER TABLE clientes.cat_clases_cliente
ENABLE ROW LEVEL SECURITY;

CREATE POLICY rls_cat_clases_cliente_empresa
    ON clientes.cat_clases_cliente
    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
    );

COMMENT ON TABLE clientes.cat_clases_cliente
IS 'Clases de Cliente: categorización comercial según volumen, facturación o importancia estratégica.';

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

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

COMMENT ON COLUMN clientes.cat_clases_cliente.codigo
IS 'Código único de la clase dentro de la empresa';

COMMENT ON COLUMN clientes.cat_clases_cliente.nombre
IS 'Nombre de la categoría';

COMMENT ON COLUMN clientes.cat_clases_cliente.prioridad_atencion
IS 'Nivel de prioridad operativa (1=Mayor)';

COMMENT ON COLUMN clientes.cat_clases_cliente.descripcion
IS 'Descripción de la clase de cliente';

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

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

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

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

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

COMMENT ON COLUMN clientes.cat_clases_cliente.updated_by
IS 'Usuario modificador';
import uuid

from datetime import datetime
from typing import Optional

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

from app.db.base import Base


class CatClasesCliente(Base):
    """
    Clases de Cliente.

    Categorización comercial de clientes según volumen,
    facturación o importancia estratégica.

    Legacy:
        i248t_clase_cliente
        (co_clase_cliente, tx_clase_cliente)
    """

    __tablename__ = "cat_clases_cliente"

    __table_args__ = (
        UniqueConstraint(
            "empresa_id",
            "codigo",
            name="uq_cat_clases_cliente_empresa_codigo",
        ),

        Index(
            "ix_cat_clases_cliente_empresa_activo",
            "empresa_id",
            "is_activo",
        ),

        {
            "schema": "clientes",
            "comment": "Clases de 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="Identificador UUID de la empresa en core.identidad (RLS)",
    )

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

    nombre: Mapped[str] = mapped_column(
        String(100),
        nullable=False,
        comment="Nombre de la categoría",
    )

    prioridad_atencion: Mapped[int] = mapped_column(
        Integer,
        nullable=False,
        server_default=text("1"),
        comment="Nivel de prioridad operativa (1=Mayor)",
    )

    descripcion: Mapped[Optional[str]] = mapped_column(
        String(255),
        nullable=True,
        comment="Descripción de la clase de cliente",
    )

    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 cat_clases_cliente

Revision ID: 0003
Revises: 0002
Create Date: 2026-09-09
"""

from typing import Sequence, Union

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


revision: str = "0003"
down_revision: Union[str, None] = "0002"
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:

    op.create_table(
        "cat_clases_cliente",

        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(
            "codigo",
            sa.String(length=30),
            nullable=False,
            comment="Código único de la clase dentro de la empresa",
        ),

        sa.Column(
            "nombre",
            sa.String(length=100),
            nullable=False,
            comment="Nombre de la categoría",
        ),

        sa.Column(
            "prioridad_atencion",
            sa.Integer(),
            nullable=False,
            server_default=sa.text("1"),
            comment="Nivel de prioridad operativa (1=Mayor)",
        ),

        sa.Column(
            "descripcion",
            sa.String(length=255),
            nullable=True,
            comment="Descripción de la clase de cliente",
        ),

        # Auditoría

        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_cat_clases_cliente",
        ),

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

        schema="clientes",
        comment="Clases de Cliente",
    )

    # Índices

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

    # Row Level Security

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

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

    # Row Level Security

    op.execute(
        """
        DROP POLICY IF EXISTS rls_cat_clases_cliente_empresa
        ON clientes.cat_clases_cliente;
        """
    )

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

    # Índice

    op.drop_index(
        "ix_cat_clases_cliente_empresa_activo",
        table_name="cat_clases_cliente",
        schema="clientes",
    )

    # Tabla

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