Class: Dbviewer::TableMetadataManager

Inherits:
Object
  • Object
show all
Defined in:
lib/dbviewer/table_metadata_manager.rb

Overview

TableMetadataManager handles retrieving and managing table structure information

Instance Method Summary collapse

Constructor Details

#initialize(connection, cache_manager) ⇒ TableMetadataManager

Initialize with a connection and cache manager

Parameters:

  • connection (ActiveRecord::ConnectionAdapters::AbstractAdapter) —

    Database connection

  • cache_manager (Dbviewer::CacheManager) —

    Cache manager instance



7
8
9
10
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 7

def initialize(connection, cache_manager)
  @connection = connection
  @cache_manager = cache_manager
end

Instance Method Details

#column_exists?(table_name, column_name) ⇒ Boolean

Check if a column exists in a table

Parameters:

  • table_name (String) —

    Name of the table

  • column_name (String) —

    Name of the column

Returns:

  • (Boolean) —

    true if column exists, false otherwise



71
72
73
74
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 71

def column_exists?(table_name, column_name)
  columns = table_columns(table_name)
  columns.any? { |col| col[:name].to_s == column_name.to_s }
end

#fetch_foreign_keys(table_name) ⇒ Array<Hash>

Get foreign keys

Parameters:

  • table_name (String) —

    Name of the table

Returns:

  • (Array<Hash>) —

    List of foreign keys with details



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 92

def fetch_foreign_keys(table_name)
  @connection.foreign_keys(table_name).map do |fk|
    {
      name: fk.name,
      from_table: fk.from_table,
      to_table: fk.to_table,
      column: fk.column,
      primary_key: fk.primary_key
    }
  end
end

#fetch_indexes(table_name) ⇒ Array<Hash>

Get table indexes

Parameters:

  • table_name (String) —

    Name of the table

Returns:

  • (Array<Hash>) —

    List of indexes with details



79
80
81
82
83
84
85
86
87
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 79

def fetch_indexes(table_name)
  @connection.indexes(table_name).map do |index|
    {
      name: index.name,
      columns: index.columns,
      unique: index.unique
    }
  end
end

#primary_key(table_name) ⇒ String?

Get the primary key of a table

Parameters:

  • table_name (String) —

    Name of the table

Returns:

  • (String, nil) —

    Primary key column name or nil if not found



60
61
62
63
64
65
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 60

def primary_key(table_name)
  @connection.primary_key(table_name)
rescue => e
  Rails.logger.error("[DBViewer] Error retrieving primary key for table #{table_name}: #{e.message}")
  nil
end

#table_columns(table_name) ⇒ Array<Hash>

Get column information for a table

Parameters:

  • table_name (String) —

    Name of the table

Returns:

  • (Array<Hash>) —

    List of column details



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 21

def table_columns(table_name)
  cached_columns = @cache_manager.get_columns(table_name)
  return cached_columns if cached_columns

  columns = @connection.columns(table_name).map do |column|
    {
      name: column.name,
      type: column.type,
      null: column.null,
      default: column.default,
      primary: column.name == primary_key(table_name)
    }
  end

  # Cache the result
  @cache_manager.store_columns(table_name, columns)
  columns
end

#table_metadata(table_name) ⇒ Hash

Get detailed metadata about a table

Parameters:

  • table_name (String) —

    Name of the table

Returns:

  • (Hash) —

    Table metadata



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 43

def table_metadata(table_name)
  cached_metadata = @cache_manager.get_metadata(table_name)
  return cached_metadata if cached_metadata

  metadata = {
    primary_key: primary_key(table_name),
    indexes: fetch_indexes(table_name),
    foreign_keys: fetch_foreign_keys(table_name)
  }

  @cache_manager.store_metadata(table_name, metadata)
  metadata
end

#tables ⇒ Array<String>

Get all tables in the database

Returns:

  • (Array<String>) —

    List of table names



14
15
16
 
# File 'lib/dbviewer/table_metadata_manager.rb', line 14

def tables
  @connection.tables.sort
end