Features/40 update institutions models new

db_revisions/env.py

@@ -65,6 +65,7 @@ def run_migrations_offline() -> None:
         target_metadata=target_metadata,
         literal_binds=True,
         dialect_opts={"paramstyle": "named"},
+        render_as_batch=True,
     )
 
     with context.begin_transaction():
@@ -90,7 +91,10 @@ def run_migrations_online() -> None:
 
     with connectable.connect() as connection:
         context.configure(
-            connection=connection, target_metadata=target_metadata, version_table_schema=target_metadata.schema
+            connection=connection,
+            target_metadata=target_metadata,
+            version_table_schema=target_metadata.schema,
+            render_as_batch=True,
         )
 
         with context.begin_transaction():

db_revisions/versions/045aa502e050_update_financial_institutions_table.py

@@ -0,0 +1,109 @@
+"""Update Financial Institutions Table
+
+Revision ID: 045aa502e050
+Revises: "549c612bf1c9"
+Create Date: 2023-11-29 11:55:10.328766
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision: str = "045aa502e050"
+down_revision: Union[str, None] = "549c612bf1c9"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    with op.batch_alter_table("financial_institutions") as batch_op:
+        batch_op.add_column(sa.Column("tax_id", sa.String(length=9), nullable=True))
+        batch_op.add_column(sa.Column("rssd_id", sa.Integer(), nullable=True))
+        batch_op.add_column(sa.Column("primary_federal_regulator_id", sa.String(length=4), nullable=True))
+        batch_op.add_column(sa.Column("hmda_institution_type_id", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("sbl_institution_type_id", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("hq_address_street_1", sa.String(), nullable=False))
+        batch_op.add_column(sa.Column("hq_address_street_2", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("hq_address_city", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("hq_address_state", sa.String(length=2), nullable=True))
+        batch_op.add_column(sa.Column("hq_address_zip", sa.String(length=5), nullable=False))
+        batch_op.add_column(sa.Column("parent_lei", sa.String(length=20), nullable=True))
+        batch_op.add_column(sa.Column("parent_legal_name", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("parent_rssd_id", sa.Integer(), nullable=True))
+        batch_op.add_column(sa.Column("top_holder_lei", sa.String(length=20), nullable=True))
+        batch_op.add_column(sa.Column("top_holder_legal_name", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("top_holder_rssd_id", sa.Integer(), nullable=True))
+        batch_op.create_index(
+            batch_op.f("ix_financial_institutions_hmda_institution_type_id"),
+            ["hmda_institution_type_id"],
+            unique=False,
+        )
+        batch_op.create_index(
+            batch_op.f("ix_financial_institutions_hq_address_state"),
+            ["hq_address_state"],
+            unique=False,
+        )
+        batch_op.create_index(
+            batch_op.f("ix_financial_institutions_primary_federal_regulator_id"),
+            ["primary_federal_regulator_id"],
+            unique=False,
+        )
+        batch_op.create_index(
+            batch_op.f("ix_financial_institutions_sbl_institution_type_id"),
+            ["sbl_institution_type_id"],
+            unique=False,
+        )
+        batch_op.create_unique_constraint("unique_financial_institutions_tax_id", ["tax_id"])
+        batch_op.create_unique_constraint("unique_financial_institutions_rssd_id", ["rssd_id"])
+        batch_op.create_foreign_key(
+            "fk_federal_regulator_financial_institutions",
+            "federal_regulator",
+            ["primary_federal_regulator_id"],
+            ["id"],
+        )
+        batch_op.create_foreign_key(
+            "fk_address_state_financial_institutions", "address_state", ["hq_address_state"], ["code"]
+        )
+        batch_op.create_foreign_key(
+            "fk_hmda_institution_type_financial_institutions",
+            "hmda_institution_type",
+            ["hmda_institution_type_id"],
+            ["id"],
+        )
+        batch_op.create_foreign_key(
+            "fk_sbl_institution_type_financial_institutions",
+            "sbl_institution_type",
+            ["sbl_institution_type_id"],
+            ["id"],
+        )
+
+
+def downgrade() -> None:
+    op.drop_constraint(
+        constraint_name="fk_federal_regulator_financial_institutions", table_name="financial_institutions"
+    )
+    op.drop_constraint(constraint_name="fk_address_state_financial_institutions", table_name="financial_institutions")
+    op.drop_constraint(
+        constraint_name="fk_hmda_institution_type_financial_institutions", table_name="financial_institutions"
+    )
+    op.drop_constraint(
+        constraint_name="fk_sbl_institution_type_financial_institutions", table_name="financial_institutions"
+    )
+    op.drop_column("financial_institutions", "top_holder_rssd_id")
+    op.drop_column("financial_institutions", "top_holder_legal_name")
+    op.drop_column("financial_institutions", "top_holder_lei")
+    op.drop_column("financial_institutions", "parent_rssd_id")
+    op.drop_column("financial_institutions", "parent_legal_name")
+    op.drop_column("financial_institutions", "parent_lei")
+    op.drop_column("financial_institutions", "hq_address_zip")
+    op.drop_column("financial_institutions", "hq_address_state")
+    op.drop_column("financial_institutions", "hq_address_city")
+    op.drop_column("financial_institutions", "hq_address_street_2")
+    op.drop_column("financial_institutions", "hq_address_street_1")
+    op.drop_column("financial_institutions", "sbl_institution_type_id")
+    op.drop_column("financial_institutions", "hmda_institution_type_id")
+    op.drop_column("financial_institutions", "primary_federal_regulator_id")
+    op.drop_column("financial_institutions", "rssd_id")
+    op.drop_column("financial_institutions", "tax_id")

db_revisions/versions/1f6c33f20a2e_create_address_state_table.py

@@ -0,0 +1,37 @@
+"""Create Address State Table
+
+Revision ID: 1f6c33f20a2e
+Revises: "20e0d51d8be9"
+Create Date: 2023-11-29 12:03:41.737864
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+from db_revisions.utils import table_exists
+
+
+# revision identifiers, used by Alembic.
+revision: str = "1f6c33f20a2e"
+down_revision: Union[str, None] = "20e0d51d8be9"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    if not table_exists("address_state"):
+        op.create_table(
+            "address_state",
+            sa.Column("code", sa.String(length=2), nullable=False),
+            sa.Column("name", sa.String(), nullable=False),
+            sa.Column("event_time", sa.DateTime(), server_default=sa.func.now(), nullable=False),
+            sa.PrimaryKeyConstraint("code"),
+            sa.UniqueConstraint("name"),
+        )
+        op.create_index(op.f("ix_address_state_code"), "address_state", ["code"], unique=False)
+
+
+def downgrade() -> None:
+    op.drop_table("address_state")

db_revisions/versions/549c612bf1c9_create_federal_regulator_table.py

@@ -0,0 +1,36 @@
+"""Create Federal Regulator Table
+
+Revision ID: 549c612bf1c9
+Revises: "8b1ba6a3275b"
+Create Date: 2023-11-29 12:09:20.012400
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+from db_revisions.utils import table_exists
+
+
+# revision identifiers, used by Alembic.
+revision: str = "549c612bf1c9"
+down_revision: Union[str, None] = "8b1ba6a3275b"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    if not table_exists("federal_regulator"):
+        op.create_table(
+            "federal_regulator",
+            sa.Column("id", sa.String(length=4), nullable=False),
+            sa.Column("name", sa.String(), nullable=False),
+            sa.Column("event_time", sa.DateTime(), server_default=sa.func.now(), nullable=False),
+            sa.PrimaryKeyConstraint("id"),
+            sa.UniqueConstraint("name"),
+        )
+
+
+def downgrade() -> None:
+    op.drop_table("federal_regulator")

db_revisions/versions/56ef0b5cd2d4_create_sbl_institution_type_table.py

@@ -0,0 +1,37 @@
+"""Create SBL Institution Type Table
+
+Revision ID: 56ef0b5cd2d4
+Revises: "1f6c33f20a2e"
+Create Date: 2023-11-29 12:20:05.593826
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+from db_revisions.utils import table_exists
+
+
+# revision identifiers, used by Alembic.
+revision: str = "56ef0b5cd2d4"
+down_revision: Union[str, None] = "1f6c33f20a2e"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    if not table_exists("sbl_institution_type"):
+        op.create_table(
+            "sbl_institution_type",
+            sa.Column("id", sa.String(), nullable=False),
+            sa.Column("name", sa.String(), nullable=False),
+            sa.Column("event_time", sa.DateTime(), server_default=sa.func.now(), nullable=False),
+            sa.PrimaryKeyConstraint("id"),
+            sa.UniqueConstraint("name"),
+        )
+        op.create_index(op.f("ix_sbl_institution_type_id"), "sbl_institution_type", ["id"], unique=False)
+
+
+def downgrade() -> None:
+    op.drop_table("sbl_institution_type")

db_revisions/versions/8b1ba6a3275b_create_hmda_institution_type_table.py

@@ -0,0 +1,37 @@
+"""Create HMDA Institution Type Table
+
+Revision ID: 8b1ba6a3275b
+Revises: "56ef0b5cd2d4"
+Create Date: 2023-11-29 12:14:16.694281
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+from db_revisions.utils import table_exists
+
+
+# revision identifiers, used by Alembic.
+revision: str = "8b1ba6a3275b"
+down_revision: Union[str, None] = "56ef0b5cd2d4"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    if not table_exists("hmda_institution_type"):
+        op.create_table(
+            "hmda_institution_type",
+            sa.Column("id", sa.String(), nullable=False),
+            sa.Column("name", sa.String(), nullable=False),
+            sa.Column("event_time", sa.DateTime(), server_default=sa.func.now(), nullable=False),
+            sa.PrimaryKeyConstraint("id"),
+            sa.UniqueConstraint("name"),
+        )
+        op.create_index(op.f("ix_hmda_institution_type_id"), "hmda_institution_type", ["id"], unique=False)
+
+
+def downgrade() -> None:
+    op.drop_table("hmda_institution_type")

src/entities/models/__init__.py

@@ -11,13 +11,25 @@
     "DeniedDomainDto",
     "UserProfile",
     "AuthenticatedUser",
+    "FederalRegulatorDao",
+    "HMDAInstitutionTypeDao",
+    "SBLInstitutionTypeDao",
+    "AddressStateDao",
+    "FederalRegulatorDto",
+    "HMDAInstitutionTypeDto",
+    "SBLInstitutionTypeDto",
+    "AddressStateDto",
 ]
 
 from .dao import (
     Base,
     FinancialInstitutionDao,
     FinancialInstitutionDomainDao,
     DeniedDomainDao,
+    FederalRegulatorDao,
+    HMDAInstitutionTypeDao,
+    SBLInstitutionTypeDao,
+    AddressStateDao,
 )
 from .dto import (
     FinancialInstitutionDto,
@@ -28,4 +40,8 @@
     DeniedDomainDto,
     UserProfile,
     AuthenticatedUser,
+    FederalRegulatorDto,
+    HMDAInstitutionTypeDto,
+    SBLInstitutionTypeDto,
+    AddressStateDto,
 )

src/entities/models/dao.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from typing import List
-from sqlalchemy import ForeignKey, func
+from sqlalchemy import ForeignKey, func, String
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 from sqlalchemy.orm import DeclarativeBase
 from sqlalchemy.ext.asyncio import AsyncAttrs
@@ -21,6 +21,26 @@ class FinancialInstitutionDao(AuditMixin, Base):
     domains: Mapped[List["FinancialInstitutionDomainDao"]] = relationship(
         "FinancialInstitutionDomainDao", back_populates="fi"
     )
+    tax_id: Mapped[str] = mapped_column(String(9), unique=True)
+    rssd_id: Mapped[int] = mapped_column(unique=True)
+    primary_federal_regulator_id: Mapped[str] = mapped_column(ForeignKey("federal_regulator.id"))
+    primary_federal_regulator: Mapped["FederalRegulatorDao"] = relationship(lazy="selectin")
+    hmda_institution_type_id: Mapped[str] = mapped_column(ForeignKey("hmda_institution_type.id"))
+    hmda_institution_type: Mapped["HMDAInstitutionTypeDao"] = relationship(lazy="selectin")
+    sbl_institution_type_id: Mapped[str] = mapped_column(ForeignKey("sbl_institution_type.id"))
+    sbl_institution_type: Mapped["SBLInstitutionTypeDao"] = relationship(lazy="selectin")
+    hq_address_street_1: Mapped[str] = mapped_column(nullable=False)
+    hq_address_street_2: Mapped[str]
+    hq_address_city: Mapped[str]
+    hq_address_state_code: Mapped[str] = mapped_column(ForeignKey("address_state.code"))
+    hq_address_state: Mapped["AddressStateDao"] = relationship(lazy="selectin")
+    hq_address_zip: Mapped[str] = mapped_column(String(5), nullable=False)
+    parent_lei: Mapped[str] = mapped_column(String(20))
+    parent_legal_name: Mapped[str]
+    parent_rssd_id: Mapped[int]
+    top_holder_lei: Mapped[str] = mapped_column(String(20))
+    top_holder_legal_name: Mapped[str]
+    top_holder_rssd_id: Mapped[int]
 
 
 class FinancialInstitutionDomainDao(AuditMixin, Base):
@@ -33,3 +53,27 @@ class FinancialInstitutionDomainDao(AuditMixin, Base):
 class DeniedDomainDao(AuditMixin, Base):
     __tablename__ = "denied_domains"
     domain: Mapped[str] = mapped_column(index=True, primary_key=True)
+
+
+class FederalRegulatorDao(AuditMixin, Base):
+    __tablename__ = "federal_regulator"
+    id: Mapped[str] = mapped_column(String(4), index=True, primary_key=True, unique=True)
+    name: Mapped[str] = mapped_column(unique=True, nullable=False)
+
+
+class HMDAInstitutionTypeDao(AuditMixin, Base):
+    __tablename__ = "hmda_institution_type"
+    id: Mapped[str] = mapped_column(index=True, primary_key=True, unique=True)
+    name: Mapped[str] = mapped_column(unique=True)
+
+
+class SBLInstitutionTypeDao(AuditMixin, Base):
+    __tablename__ = "sbl_institution_type"
+    id: Mapped[str] = mapped_column(index=True, primary_key=True, unique=True)
+    name: Mapped[str] = mapped_column(unique=True, nullable=False)
+
+
+class AddressStateDao(AuditMixin, Base):
+    __tablename__ = "address_state"
+    code: Mapped[str] = mapped_column(String(2), index=True, primary_key=True, unique=True)
+    name: Mapped[str] = mapped_column(unique=True, nullable=False)