diff options
Diffstat (limited to 'db/docs')
27 files changed, 93 insertions, 26 deletions
diff --git a/db/docs/analytics_cycle_analytics_aggregations.yml b/db/docs/analytics_cycle_analytics_aggregations.yml index b79cb949d1f..ab92c5c078b 100644 --- a/db/docs/analytics_cycle_analytics_aggregations.yml +++ b/db/docs/analytics_cycle_analytics_aggregations.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::Aggregation feature_categories: - value_stream_management -description: TODO +description: Stores Value Stream Analytics aggregation related metadata for top-level groups. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/79942 milestone: '14.9' diff --git a/db/docs/analytics_cycle_analytics_group_value_streams.yml b/db/docs/analytics_cycle_analytics_group_value_streams.yml index d41ed8168d0..8942439dddd 100644 --- a/db/docs/analytics_cycle_analytics_group_value_streams.yml +++ b/db/docs/analytics_cycle_analytics_group_value_streams.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::GroupValueStream feature_categories: - value_stream_management -description: TODO +description: Store group level Value Stream objects. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36658 milestone: '13.2' diff --git a/db/docs/analytics_cycle_analytics_issue_stage_events.yml b/db/docs/analytics_cycle_analytics_issue_stage_events.yml index cc993799033..b3f6a9f4716 100644 --- a/db/docs/analytics_cycle_analytics_issue_stage_events.yml +++ b/db/docs/analytics_cycle_analytics_issue_stage_events.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::IssueStageEvent feature_categories: - value_stream_management -description: TODO +description: Contains various Issue-related timestamps for aggregating Value Stream Analytics data. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68950 milestone: '14.3' diff --git a/db/docs/analytics_cycle_analytics_merge_request_stage_events.yml b/db/docs/analytics_cycle_analytics_merge_request_stage_events.yml index 796db2a54af..ae3074d544b 100644 --- a/db/docs/analytics_cycle_analytics_merge_request_stage_events.yml +++ b/db/docs/analytics_cycle_analytics_merge_request_stage_events.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::MergeRequestStageEvent feature_categories: - value_stream_management -description: TODO +description: Contains various MergeRequest-related timestamps for aggregating Value Stream Analytics data. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68950 milestone: '14.3' diff --git a/db/docs/analytics_cycle_analytics_project_stages.yml b/db/docs/analytics_cycle_analytics_project_stages.yml index 051f1c585ba..1ff917faf94 100644 --- a/db/docs/analytics_cycle_analytics_project_stages.yml +++ b/db/docs/analytics_cycle_analytics_project_stages.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::ProjectStage feature_categories: - value_stream_management -description: TODO +description: Persists project level value stream analytics stages. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/15061 milestone: '12.2' diff --git a/db/docs/analytics_cycle_analytics_stage_event_hashes.yml b/db/docs/analytics_cycle_analytics_stage_event_hashes.yml index cec953a261d..3df5ee1c172 100644 --- a/db/docs/analytics_cycle_analytics_stage_event_hashes.yml +++ b/db/docs/analytics_cycle_analytics_stage_event_hashes.yml @@ -4,6 +4,6 @@ classes: - Analytics::CycleAnalytics::StageEventHash feature_categories: - value_stream_management -description: TODO +description: Stores hashes of Value Stream Analytics stage configurations. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/67259 milestone: '14.2' diff --git a/db/docs/analytics_devops_adoption_segments.yml b/db/docs/analytics_devops_adoption_segments.yml index 18abfcaff09..4b22c5926c2 100644 --- a/db/docs/analytics_devops_adoption_segments.yml +++ b/db/docs/analytics_devops_adoption_segments.yml @@ -4,6 +4,6 @@ classes: - Analytics::DevopsAdoption::EnabledNamespace feature_categories: - devops_reports -description: TODO +description: Stores a reference to the Namespace which is enabled for the DevOps report. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/45748 milestone: '13.6' diff --git a/db/docs/analytics_devops_adoption_snapshots.yml b/db/docs/analytics_devops_adoption_snapshots.yml index 8bb87fd08fc..3fcaea684d6 100644 --- a/db/docs/analytics_devops_adoption_snapshots.yml +++ b/db/docs/analytics_devops_adoption_snapshots.yml @@ -4,6 +4,6 @@ classes: - Analytics::DevopsAdoption::Snapshot feature_categories: - devops_reports -description: TODO +description: Contains periodical DevOps Adoption data points. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/47388 milestone: '13.7' diff --git a/db/docs/analytics_language_trend_repository_languages.yml b/db/docs/analytics_language_trend_repository_languages.yml index b27543dffaf..c42328b6bc8 100644 --- a/db/docs/analytics_language_trend_repository_languages.yml +++ b/db/docs/analytics_language_trend_repository_languages.yml @@ -3,7 +3,7 @@ table_name: analytics_language_trend_repository_languages classes: - Analytics::LanguageTrend::RepositoryLanguage feature_categories: -- devops_reports -description: TODO +- source_code_management +description: Contains snapshot data about the used programming languages over time. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16491 milestone: '12.3' diff --git a/db/docs/analytics_usage_trends_measurements.yml b/db/docs/analytics_usage_trends_measurements.yml index 88e66fd7c98..1672c195e3d 100644 --- a/db/docs/analytics_usage_trends_measurements.yml +++ b/db/docs/analytics_usage_trends_measurements.yml @@ -4,6 +4,6 @@ classes: - Analytics::UsageTrends::Measurement feature_categories: - devops_reports -description: TODO +description: Contains periodically snapshotted database record counts. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62797 milestone: '14.0' diff --git a/db/docs/ci_partitions.yml b/db/docs/ci_partitions.yml new file mode 100644 index 00000000000..8dfa31f05f9 --- /dev/null +++ b/db/docs/ci_partitions.yml @@ -0,0 +1,9 @@ +--- +table_name: ci_partitions +classes: +- Ci::Partition +feature_categories: +- continuous_integration +description: Database partitioning metadata for CI tables +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96856 +milestone: '15.4' diff --git a/db/docs/conversational_development_index_metrics.yml b/db/docs/conversational_development_index_metrics.yml index fb96c376953..9371f9f1bfb 100644 --- a/db/docs/conversational_development_index_metrics.yml +++ b/db/docs/conversational_development_index_metrics.yml @@ -4,6 +4,6 @@ classes: - DevOpsReport::Metric feature_categories: - devops_reports -description: TODO +description: Contains data for calculating DevOps score. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/commit/26dde5f55f1dac2e6bea4f7e1dfa51c72dc756cb milestone: '9.3' diff --git a/db/docs/dora_configurations.yml b/db/docs/dora_configurations.yml new file mode 100644 index 00000000000..e13cf088670 --- /dev/null +++ b/db/docs/dora_configurations.yml @@ -0,0 +1,9 @@ +--- +table_name: dora_configurations +classes: +- Dora::Configuration +feature_categories: +- continuous_delivery +description: Stores project specific configurations for DORA4 calculations. +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96561 +milestone: '15.4' diff --git a/db/docs/dora_daily_metrics.yml b/db/docs/dora_daily_metrics.yml index 210af9f6472..09f2ad02bfe 100644 --- a/db/docs/dora_daily_metrics.yml +++ b/db/docs/dora_daily_metrics.yml @@ -3,7 +3,7 @@ table_name: dora_daily_metrics classes: - Dora::DailyMetrics feature_categories: -- value_stream_management -description: TODO +- continuous_delivery +description: Stores daily snapshots of DORA4 metrics per environment. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/55473 milestone: '13.10' diff --git a/db/docs/events.yml b/db/docs/events.yml index 9ad923a25c7..d766bc7cae3 100644 --- a/db/docs/events.yml +++ b/db/docs/events.yml @@ -4,7 +4,7 @@ classes: - Event - PushEvent feature_categories: -- value_stream_management -description: TODO +- users +description: Stores user generated events. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/commit/a847501fd2ffc1c4becc7d0d352d80168d9b3568 milestone: "<6.0" diff --git a/db/docs/fork_networks.yml b/db/docs/fork_networks.yml index f0978b3fcc4..51123405baf 100644 --- a/db/docs/fork_networks.yml +++ b/db/docs/fork_networks.yml @@ -3,7 +3,7 @@ table_name: fork_networks classes: - ForkNetwork feature_categories: -- devops_reports -description: TODO +- source_code_management +description: When a project is first forked, a row is created in this table. Also referenced by the fork_network_members table. This is used to know which projects can send merge reqeusts to each other. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3098 milestone: '10.1' diff --git a/db/docs/ghost_user_migrations.yml b/db/docs/ghost_user_migrations.yml new file mode 100644 index 00000000000..f4e69e71baa --- /dev/null +++ b/db/docs/ghost_user_migrations.yml @@ -0,0 +1,9 @@ +--- +table_name: ghost_user_migrations +classes: +- GhostUserMigration +feature_categories: +- users +description: Users records awaiting for their associated records to be migrated to ghost user +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95473 +milestone: '15.4' diff --git a/db/docs/insights.yml b/db/docs/insights.yml index 988893208a7..2439f289340 100644 --- a/db/docs/insights.yml +++ b/db/docs/insights.yml @@ -4,6 +4,6 @@ classes: - Insight feature_categories: - value_stream_management -description: TODO +description: The table is used to specify a project which contains the group level insights configuration. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9665 milestone: '11.9' diff --git a/db/docs/issue_metrics.yml b/db/docs/issue_metrics.yml index a451e649128..3d2055a155c 100644 --- a/db/docs/issue_metrics.yml +++ b/db/docs/issue_metrics.yml @@ -4,6 +4,6 @@ classes: - Issue::Metrics feature_categories: - value_stream_management -description: TODO +description: Store various metrics for issues. introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/commit/516c838a1846d049814765afa85c28a3c14a5b9f milestone: '8.12' diff --git a/db/docs/merge_request_metrics.yml b/db/docs/merge_request_metrics.yml index 5faf14d0875..0b166eee455 100644 --- a/db/docs/merge_request_metrics.yml +++ b/db/docs/merge_request_metrics.yml @@ -5,6 +5,6 @@ classes: feature_categories: - value_stream_management - code_review -description: Store various metrics for merge requests +description: Store various metrics for merge requests. introduced_by_url: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5986 milestone: '8.12' diff --git a/db/docs/merge_request_predictions.yml b/db/docs/merge_request_predictions.yml new file mode 100644 index 00000000000..7495f0934a4 --- /dev/null +++ b/db/docs/merge_request_predictions.yml @@ -0,0 +1,9 @@ +--- +table_name: merge_request_predictions +classes: +- MergeRequest::Prediction +feature_categories: +- workflow_automation +description: Includes machine learning model predictions +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/97622 +milestone: '15.4' diff --git a/db/docs/onboarding_progresses.yml b/db/docs/onboarding_progresses.yml index 4166b934570..80b70fe0b1f 100644 --- a/db/docs/onboarding_progresses.yml +++ b/db/docs/onboarding_progresses.yml @@ -1,7 +1,7 @@ --- table_name: onboarding_progresses classes: -- OnboardingProgress +- Onboarding::Progress feature_categories: - onboarding description: TODO diff --git a/db/docs/packages_rpm_metadata.yml b/db/docs/packages_rpm_metadata.yml new file mode 100644 index 00000000000..cd34529ff0c --- /dev/null +++ b/db/docs/packages_rpm_metadata.yml @@ -0,0 +1,9 @@ +--- +table_name: packages_rpm_metadata +classes: +- Packages::Rpm::Metadatum +feature_categories: +- package_registry +description: Rpm package metadata +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/96019 +milestone: '15.4' diff --git a/db/docs/protected_environment_deploy_access_levels.yml b/db/docs/protected_environment_deploy_access_levels.yml index cd3bba9171f..c25044dc7e2 100644 --- a/db/docs/protected_environment_deploy_access_levels.yml +++ b/db/docs/protected_environment_deploy_access_levels.yml @@ -1,7 +1,7 @@ --- table_name: protected_environment_deploy_access_levels classes: -- ProtectedEnvironment::DeployAccessLevel +- ProtectedEnvironments::DeployAccessLevel feature_categories: - continuous_delivery description: https://docs.gitlab.com/ee/ci/environments/protected_environments.html diff --git a/db/docs/sbom_vulnerable_component_versions.yml b/db/docs/sbom_vulnerable_component_versions.yml new file mode 100644 index 00000000000..147af9c046b --- /dev/null +++ b/db/docs/sbom_vulnerable_component_versions.yml @@ -0,0 +1,11 @@ +--- +table_name: sbom_vulnerable_component_versions +classes: +- Sbom::VulnerableComponentVersion +feature_categories: +- container_scanning +- dependency_scanning +- license_compliance +description: Stores information about vulnerable SBoM components +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95622 +milestone: '15.4' diff --git a/db/docs/spam_logs.yml b/db/docs/spam_logs.yml index 35fa08ef46d..6e16b3600c8 100644 --- a/db/docs/spam_logs.yml +++ b/db/docs/spam_logs.yml @@ -3,7 +3,7 @@ table_name: spam_logs classes: - SpamLog feature_categories: -- authentication_and_authorization -description: TODO -introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/commit/d20e75a8d80c2828336cd22897ea6868d666f8a5 +- instance_resiliency +description: Logs users flagged by the Akismet anti-spam integration. +introduced_by_url: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2266 milestone: '8.5' diff --git a/db/docs/vulnerability_advisories.yml b/db/docs/vulnerability_advisories.yml new file mode 100644 index 00000000000..2c88be94a11 --- /dev/null +++ b/db/docs/vulnerability_advisories.yml @@ -0,0 +1,11 @@ +--- +table_name: vulnerability_advisories +classes: +- Vulnerabilities::Advisory +feature_categories: +- container_scanning +- dependency_scanning +- license_compliance +description: Stores vulnerability advisories +introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95622 +milestone: '15.4' |