Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: annotates the PII tables in Aspects as per OEP-30 #569

Merged
merged 1 commit into from
Jan 18, 2024
Merged

docs: annotates the PII tables in Aspects as per OEP-30 #569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions ...emplates/aspects/apps/aspects/migrations/alembic/versions/0016_event_sink_user_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
"""
create user_profile sink table

This table is always created, but it will only be populated if ASPECTS_ENABLE_PII.

.. pii: Stores Open edX user profile data.
.. pii_types: user_id, name, username, location, phone_number, email_address, birth_date, biography, gender
.. pii_retirement: local_api, consumer_api
"""
from alembic import op

Expand Down
6 changes: 6 additions & 0 deletions ...templates/aspects/apps/aspects/migrations/alembic/versions/0026_event_sink_external_id.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
"""
create external_id sink table

This table is always created, but it will only be populated if ASPECTS_ENABLE_PII.

.. pii: Stores a mapping between an Open edX user and their external_id values stored in Open edX.
.. pii_types: user_id, username
.. pii_retirement: local_api, consumer_api
"""
from alembic import op

Expand Down
4 changes: 4 additions & 0 deletions ...spects/apps/aspects/migrations/alembic/versions/0027_partition_event_sink_user_profile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
"""
Partition the event_sink.user_profile table

.. pii: Stores Open edX user profile data.
.. pii_types: user_id, name, username, location, phone_number, email_address, birth_date, biography, gender
.. pii_retirement: local_api, consumer_api
"""
from alembic import op

Expand Down
7 changes: 7 additions & 0 deletions tutoraspects/templates/aspects/apps/aspects/migrations/alembic/versions/0028_user_pii.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
"""
create user_pii table sourced from an in-memory dictionary joining the PII tables.

This table is always created, but it will only be populated if ASPECTS_ENABLE_PII.
Once accessed, data from this dictionary is cached in-memory for ASPECTS_PII_CACHE_LIFETIME seconds.

.. pii: Stores Open edX user and profile data in a dictionary for use by Superset charts.
.. pii_types: user_id, name, username, location, phone_number, email_address, birth_date, biography, gender
.. pii_retirement: local_api, consumer_api
"""
from alembic import op

Expand Down