Database Dictionary Audit for Enablement:Database

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 associated 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

• ar_internal_metadata

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

• batched_background_migrations

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

• background_migration_jobs

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

• postgres_async_indexes

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

• postgres_reindex_actions

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

• batched_background_migration_job_transition_logs

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

• detached_partitions

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

• postgres_reindex_queued_actions

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

• schema_migrations

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

• partitioned_foreign_keys

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

• batched_background_migration_jobs

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

Assignments

Table	Team member who will update the file
ar_internal_metadata	@mattkasa
batched_background_migrations	@dfrazao-gitlab
background_migration_jobs	@dfrazao-gitlab
postgres_async_indexes	@abrandl
postgres_reindex_actions	@abrandl
batched_background_migration_job_transition_logs	@dfrazao-gitlab
detached_partitions	@stomlinson
postgres_reindex_queued_actions	@abrandl
schema_migrations	@mattkasa
partitioned_foreign_keys	@stomlinson
batched_background_migration_jobs	@dfrazao-gitlab

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.

added Category:Database Database tooling documentation labels

added to epic &7842 (closed)

marked #359367 (closed) as a duplicate of this issue

marked this issue as related to #359367 (closed)

added groupdatabase label

assigned to @alexives

Setting label(s) devopsenablement sectionenablement based on groupdatabase.

added devopssystems sectioncore platform labels

changed the description

@mattkasa, @dfrazao-gitlab, @abrandl, and @stomlinson I made a table up above splitting up the tables we need to add descriptions for. For each table assigned to you, could you write a brief description of what it's used for and put up a merge request updating the file? My hope is that this will just take a few minutes for each of you!

mentioned in merge request !85331 (merged)

marked the checklist item detached_partitions as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item detached_partitions description has been updated as completed

marked the checklist item detached_partitions milestone and introduced_by_url seem accurate as completed

marked the checklist item partitioned_foreign_keys as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item partitioned_foreign_keys description has been updated as completed

marked the checklist item partitioned_foreign_keys milestone and introduced_by_url seem accurate as completed

changed the description

mentioned in commit 5665930c

mentioned in merge request !85372 (merged)

mentioned in commit e87bce24

added databaseactive label

added workflowin dev label

changed the description

mentioned in issue #359335 (closed)

marked the checklist item postgres_reindex_queued_actions as completed

marked the checklist item postgres_reindex_actions as completed

marked the checklist item postgres_async_indexes as completed

marked the checklist item postgres_reindex_queued_actions milestone and introduced_by_url seem accurate as completed

marked the checklist item postgres_reindex_queued_actions description has been updated as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item postgres_reindex_actions milestone and introduced_by_url seem accurate as completed

marked the checklist item postgres_reindex_actions description has been updated as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item postgres_async_indexes milestone and introduced_by_url seem accurate as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item postgres_async_indexes description has been updated as completed

created branch 359362-database-dictionary-audit-for-enablement-database to address this issue

mentioned in merge request !85753 (merged)

mentioned in commit 49258c84

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item schema_migrations description has been updated as completed

marked the checklist item database is the correct feature category or has been updated as completed

marked the checklist item ar_internal_metadata description has been updated as completed

mentioned in commit 03fce269

marked the checklist item ar_internal_metadata milestone and introduced_by_url seem accurate as completed

marked the checklist item ar_internal_metadata as completed

marked the checklist item schema_migrations milestone and introduced_by_url seem accurate as completed