Class: DatabaseDocumenter::DatabaseComment::BaseDatabaseComment

Inherits:
Object
  • Object
show all
Defined in:
lib/database_documenter/database_comment/base_database_comment.rb

Overview

A base class for reading column database comments

Class Method Summary collapse

Class Method Details

.database_name ⇒ Object 



14
15
16
 
# File 'lib/database_documenter/database_comment/base_database_comment.rb', line 14

def self.database_name
  Rails.application.config.database_configuration[Rails.env]['database'].freeze
end

.read_columns_comment(_table_name) ⇒ Object

Raises:

  • (NotImplementedError) 


6
7
8
 
# File 'lib/database_documenter/database_comment/base_database_comment.rb', line 6

def self.read_columns_comment(_table_name)
  raise NotImplementedError
end

.read_table_comment(_table_name) ⇒ Object

Raises:

  • (NotImplementedError) 


10
11
12
 
# File 'lib/database_documenter/database_comment/base_database_comment.rb', line 10

def self.read_table_comment(_table_name)
  raise NotImplementedError
end