Skip to content

Database Dictionary Audit for Manage:Workspace

Recently the database team has started documenting all database tables in db/doc. As an MVP, we've assigned each table to a feature category. We attempted to automate this, and then made rough guesses on the ones that couldn't be automatically identified either using this spreadsheet or just by guessing based on their name and code references. In order to make sure these are accurate, I'm asking every team to take a look at the tables associated with their feature categories assoicated with their stages.

What we need from your team? Look through the list of tables and fix any mistaken labels and update the description field to help folks know what purpose the table serves.

Process (per table)

  1. Are the feature categories correct?
    • Keep in mind that tables can have multiple categories. Look at the list and if there are any other categories it belongs to, add them.
    • If a table has no category that seems to be a perfect match, assign it to the closest match. Tables must have at least one feature category.
    • If the table is assigned to a feature category for a different group, open a merge request changing the category and assign it to the EM for the group responsible for that category.
  2. Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
  3. Double check the milestone and introduced_by_url to see if they are accurate

Tables

  • namespace_admin_notes

    • subgroups is the correct feature category or has been updated
    • namespace_admin_notes description has been updated
    • namespace_admin_notes milestone and introduced_by_url seem accurate

  • namespace_settings

    • subgroups is the correct feature category or has been updated
    • namespace_settings description has been updated
    • namespace_settings milestone and introduced_by_url seem accurate

  • group_features

    • subgroups is the correct feature category or has been updated
    • group_features description has been updated
    • group_features milestone and introduced_by_url seem accurate

  • namespaces

    • subgroups is the correct feature category or has been updated
    • namespaces description has been updated
    • namespaces milestone and introduced_by_url seem accurate

  • routes

    • subgroups is the correct feature category or has been updated
    • routes description has been updated
    • routes milestone and introduced_by_url seem accurate

  • group_deletion_schedules

    • subgroups is the correct feature category or has been updated
    • group_deletion_schedules description has been updated
    • group_deletion_schedules milestone and introduced_by_url seem accurate

  • internal_ids

    • subgroups is the correct feature category or has been updated
    • internal_ids description has been updated
    • internal_ids milestone and introduced_by_url seem accurate

  • namespace_limits

    • subgroups is the correct feature category or has been updated
    • namespace_limits description has been updated
    • namespace_limits milestone and introduced_by_url seem accurate

  • members

    • subgroups is the correct feature category or has been updated
    • members description has been updated
    • members milestone and introduced_by_url seem accurate

  • group_crm_settings

    • subgroups is the correct feature category or has been updated
    • group_crm_settings description has been updated
    • group_crm_settings milestone and introduced_by_url seem accurate

  • group_custom_attributes

    • subgroups is the correct feature category or has been updated
    • group_custom_attributes description has been updated
    • group_custom_attributes milestone and introduced_by_url seem accurate

  • redirect_routes

    • subgroups is the correct feature category or has been updated
    • redirect_routes description has been updated
    • redirect_routes milestone and introduced_by_url seem accurate

  • customer_relations_organizations

    • subgroups is the correct feature category or has been updated
    • customer_relations_organizations description has been updated
    • customer_relations_organizations milestone and introduced_by_url seem accurate

  • user_preferences

    • users is the correct feature category or has been updated
    • user_preferences description has been updated
    • user_preferences milestone and introduced_by_url seem accurate

  • emails

    • users is the correct feature category or has been updated
    • emails description has been updated
    • emails milestone and introduced_by_url seem accurate

  • list_user_preferences

    • users is the correct feature category or has been updated
    • list_user_preferences description has been updated
    • list_user_preferences milestone and introduced_by_url seem accurate

  • chat_teams

    • users is the correct feature category or has been updated
    • chat_teams description has been updated
    • chat_teams milestone and introduced_by_url seem accurate

  • abuse_reports

    • users is the correct feature category or has been updated
    • abuse_reports description has been updated
    • abuse_reports milestone and introduced_by_url seem accurate

  • saved_replies

    • users is the correct feature category or has been updated
    • saved_replies description has been updated
    • saved_replies milestone and introduced_by_url seem accurate

  • users

    • users is the correct feature category or has been updated
    • users description has been updated
    • users milestone and introduced_by_url seem accurate

  • user_group_callouts

    • users is the correct feature category or has been updated
    • user_group_callouts description has been updated
    • user_group_callouts milestone and introduced_by_url seem accurate

  • user_details

    • users is the correct feature category or has been updated
    • user_details description has been updated
    • user_details milestone and introduced_by_url seem accurate

  • user_credit_card_validations

    • users is the correct feature category or has been updated
    • user_credit_card_validations description has been updated
    • user_credit_card_validations milestone and introduced_by_url seem accurate

  • user_callouts

    • users is the correct feature category or has been updated
    • user_callouts description has been updated
    • user_callouts milestone and introduced_by_url seem accurate

  • customer_relations_contacts

    • users is the correct feature category or has been updated
    • customer_relations_contacts description has been updated
    • customer_relations_contacts milestone and introduced_by_url seem accurate

  • user_follow_users

    • users is the correct feature category or has been updated
    • user_follow_users description has been updated
    • user_follow_users milestone and introduced_by_url seem accurate

  • sent_notifications

    • users is the correct feature category or has been updated
    • sent_notifications description has been updated
    • sent_notifications milestone and introduced_by_url seem accurate

  • epic_user_mentions

    • users is the correct feature category or has been updated
    • epic_user_mentions description has been updated
    • epic_user_mentions milestone and introduced_by_url seem accurate

  • user_custom_attributes

    • users is the correct feature category or has been updated
    • user_custom_attributes description has been updated
    • user_custom_attributes milestone and introduced_by_url seem accurate

  • commit_user_mentions

    • users is the correct feature category or has been updated
    • commit_user_mentions description has been updated
    • commit_user_mentions milestone and introduced_by_url seem accurate

  • allowed_email_domains

    • users is the correct feature category or has been updated
    • allowed_email_domains description has been updated
    • allowed_email_domains milestone and introduced_by_url seem accurate

  • user_statuses

    • users is the correct feature category or has been updated
    • user_statuses description has been updated
    • user_statuses milestone and introduced_by_url seem accurate

  • chat_names

    • users is the correct feature category or has been updated
    • chat_names description has been updated
    • chat_names milestone and introduced_by_url seem accurate

  • keys

    • users is the correct feature category or has been updated
    • keys description has been updated
    • keys milestone and introduced_by_url seem accurate

  • user_canonical_emails

    • users is the correct feature category or has been updated
    • user_canonical_emails description has been updated
    • user_canonical_emails milestone and introduced_by_url seem accurate

  • users_star_projects

    • projects is the correct feature category or has been updated
    • users_star_projects description has been updated
    • users_star_projects milestone and introduced_by_url seem accurate

  • badges

    • projects is the correct feature category or has been updated
    • badges description has been updated
    • badges milestone and introduced_by_url seem accurate

  • project_authorizations

    • projects is the correct feature category or has been updated
    • project_authorizations description has been updated
    • project_authorizations milestone and introduced_by_url seem accurate

  • project_security_settings

    • projects is the correct feature category or has been updated
    • project_security_settings description has been updated
    • project_security_settings milestone and introduced_by_url seem accurate

  • routes

    • projects is the correct feature category or has been updated
    • routes description has been updated
    • routes milestone and introduced_by_url seem accurate

  • internal_ids

    • projects is the correct feature category or has been updated
    • internal_ids description has been updated
    • internal_ids milestone and introduced_by_url seem accurate

  • topics

    • projects is the correct feature category or has been updated
    • topics description has been updated
    • topics milestone and introduced_by_url seem accurate

  • members

    • projects is the correct feature category or has been updated
    • members description has been updated
    • members milestone and introduced_by_url seem accurate

  • project_tracing_settings

    • projects is the correct feature category or has been updated
    • project_tracing_settings description has been updated
    • project_tracing_settings milestone and introduced_by_url seem accurate

  • project_topics

    • projects is the correct feature category or has been updated
    • project_topics description has been updated
    • project_topics milestone and introduced_by_url seem accurate

  • project_custom_attributes

    • projects is the correct feature category or has been updated
    • project_custom_attributes description has been updated
    • project_custom_attributes milestone and introduced_by_url seem accurate

  • project_ci_feature_usages

    • projects is the correct feature category or has been updated
    • project_ci_feature_usages description has been updated
    • project_ci_feature_usages milestone and introduced_by_url seem accurate

  • draft_notes

    • projects is the correct feature category or has been updated
    • draft_notes description has been updated
    • draft_notes milestone and introduced_by_url seem accurate

  • project_settings

    • projects is the correct feature category or has been updated
    • project_settings description has been updated
    • project_settings milestone and introduced_by_url seem accurate

  • projects

    • projects is the correct feature category or has been updated
    • projects description has been updated
    • projects milestone and introduced_by_url seem accurate

  • project_features

    • projects is the correct feature category or has been updated
    • project_features description has been updated
    • project_features milestone and introduced_by_url seem accurate

  • redirect_routes

    • projects is the correct feature category or has been updated
    • redirect_routes description has been updated
    • redirect_routes milestone and introduced_by_url seem accurate

  • programming_languages

    • projects is the correct feature category or has been updated
    • programming_languages description has been updated
    • programming_languages milestone and introduced_by_url seem accurate

Why is this effort happening?

There have been many times that issues occur in production, but the the infrastructure team doesn't have the information it needs to identify subject matter experts who can help resolve things quickly. This in turn can delay the time it takes to find and fix pressing issues.

How much time should we expect to spend on this?

Depends, if the team has a lot of tables, it may take a little bit to get all of the information together. If not, this could be very fast. The descriptions are as much or little as the team wants to add. More information may help folks self service better.

How urgent is this?

The urgency is up to the team. If the tables have poor information or are misassigned, that may cause more burden on the team when answering questions.

Edited by Gosia Ksionek