Create Table: project_program_area_xref

[Neecolaa]

Overview

We need to create the project_program_area_xref table so that we can update a shared data store across hackforla.org, vrms, civictechjobs, and tables (onboarding) project.

Details

A table and a model are the same thing

Action Items

• [x] add issue link to the tables tab of the spreadsheet
• [x] identify and document table description (see spreadsheet under Resources)
• [x] compare and check off the data fields (below) against the ERD. Note any fields in the ERD that's missing from the list. (see Resources)
  • [ ] Review and correct discrepancies
• [x] compare the check off associated tables (below) against the ERD. Note any associated tables in the ERD that's missing from the list (see Resources)
• [x] create a single model in Django (defining schema)
• [x] write a test for the relationships this model will have with other models (e.g., creating a user and assigning them a set of permissions on a project).
• [x] write an API end point
• [x] write API unit tests
• [x] document the endpoint

Resources/Instructions

• See People Depot Resources wiki page for links
  • ERD
  • Table and Field Definitions
  • API Endpoint
• See the wiki page for instructions.

Description

Join table: links project to program area

Data Fields

1. Copied from spreadsheet and checked off according to ERD. (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

   • [x] (PK) id - int - Record Id
   • [x] (FK) project_id - int - id of project linked to program area
   • [x] (FK) program_area_id - int - id of program area linked to project
   • [x] created - timestamp

2. In ERD only (having items here indicates a mismatch, which requires a review)

   • created_date - timestamp

Associated Tables

1. Copied from spreadsheet and checked off according to ERD. (unchecked items indicate a mismatch between ERD and spreadsheet, which requires a review)

   • [x] program_area (many-to-one)
   • [x] project (many-to-one)

2. In ERD only (having items here indicates a mismatch, which requires a review)

   • None

[del9ra]

ETA: September 1, 6 PM Availability: Mon-Fri 10AM-15PM

[shmonks]

Most xref tables can created automatically by Django, so this issue needs to be rewritten to define the many to many relationship.

[fyliu]

After slack messaging with @del9ra, we realized that probably none of the xref tables can use the "through" table generated by Django, because the generated table won't contain the created_at and updated_at fields defined in the abstract base class. So in that case, we should discuss @del9ra's suggestion to create another abstract base class to add a standardized ended_at field to all the xref table models that inherit from it.

In any case, that means this issue does still need to implement a new model.

[del9ra]

After slack messaging with @del9ra, we realized that probably none of the xref tables can use the "through" table generated by Django, because the generated table won't contain the created_at and updated_at fields defined in the abstract base class. So in that case, we should discuss @del9ra's suggestion to create another abstract base class to add a standardized ended_at field to all the xref table models that inherit from it.

Variations of ended are used not only in xref models but also in other models: ended_at in the Affiliation model, ended in the Permission model, project_sponsor_partner_xref, and permission_history, and ended_on in project_language_xref and project_sdg_xref.

In any case, that means this issue does still need to implement a new model.

@fyliu I didn't implement a new model in my new PR #398 ; I just added a program_areas many-to-many field in the Project model.

[fyliu]

I think we need to discuss with @Neecolaa on using the same name and type for the xref table to mark when the relationship ended. Adding "ready for DB Architect" and will add an item to the next meeting.

@del9ra I think we do need to add the xref model just because the created timestamp is a requirement and that model would provide it. I would wait for @dmartin4820's PR #385 to be merged and use that as a model for this issue.

[del9ra]

@fyliu https://github.com/hackforla/peopledepot/pull/376#discussion_r1749162686 Here you said:

"...this xref table doesn't have any extra data fields other than the relations (foreign keys). It means that we don't really need to create a Django model for this table at all.."