lib/gitlab/database/dictionary.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# frozen_string_literal: true

module Gitlab
  module Database
    class Dictionary
      def initialize(file_path)
        @file_path = file_path
        @data = YAML.load_file(file_path)
      end

      def name_and_schema
        [key_name, gitlab_schema.to_sym]
      end

      def table_name
        data['table_name']
      end

      def view_name
        data['view_name']
      end

      def milestone
        data['milestone']
      end

      def gitlab_schema
        data['gitlab_schema']
      end

      def schema?(schema_name)
        gitlab_schema == schema_name.to_s
      end

      def key_name
        table_name || view_name
      end

      def validate!
        return true unless gitlab_schema.nil?

        raise(
          GitlabSchema::UnknownSchemaError,
          "#{file_path} must specify a valid gitlab_schema for #{key_name}. " \
          "See #{help_page_url}"
        )
      end

      private

      attr_reader :file_path, :data

      def help_page_url
        # rubocop:disable Gitlab/DocUrl -- link directly to docs.gitlab.com, always
        'https://docs.gitlab.com/ee/development/database/database_dictionary.html'
        # rubocop:enable Gitlab/DocUrl
      end
    end
  end
end