Create Table: project_sponsor_partner_xref

[ericvennemeyer]

Overview

We need to create the project_sponsor_partner_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

• identify and document table description (see spreadsheet under Resources)
  • if not, reach out to PD leads
• 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)
• 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)
• create a single model in Django (defining schema)
  • add the docstring from the section below
• 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).
• write an API end point
• write API unit tests
• document the endpoint

After Merge

• Release Create guideline for documenting clarifications #182 from the ice box if this is the last dependency

Resources/Instructions

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

Sponsor/Partner clarification

Sponsor/partner relationships stored in this table are project-dependent. They cannot be both a sponsor and a partner for the same project, so if is_sponsor is FALSE they are a project partner, if is_sponsor is TRUE they are a project sponsor.

Description

Stores the relationship between sponsors/partners and projects (Joins tables sponsor_partner and project)

Table name vs Model name

• The table name should be project_affiliate_xref, but the Django model name should be Affiliation for ease of coding.
  • Use db_table field in meta to specify the db table name

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)

   • (PK) id - int - Record Id
   • (FK) project_id - int - id of project linked to partner
   • (FK) partner_id - int - id of partner linked to project
   • created - timestamp
   • ended - timestamp
   • is_sponsor - boolean
   • is_partner - boolean

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

   • None

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)

   • project (many-to-one)
   • sponsor_partner (many-to-one)

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

   • None

[freaky4wrld]

@fyliu there's an action item, to add the doc-string, can you point out the section from which it is to be copied.
Also just clarifying in the schema shall I add the created_date and ended field, or leave the created_date as it is inherited from the AbstractBaseModel.

Thanks !!

[fyliu]

@freaky4wrld I think it's the clarification section.

[fyliu]

@Neecolaa I brought up converting the boolean is_partner into an enum or choice. Here's the django documentation on that. It'd be a char field in the database.

To add choices, we'd have to modify the code. It shouldn't need to modify the database, since it'd still be a char field. However, it's not something that could be added on the fly like stack_element_type.