dbviewer 0.3.5 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 648be97f775ec9c5d18dabf9ebe90e164d760fde2b1e3c9c9ff2442eb6dba9fe
-  data.tar.gz: f0510fd50eabd5ba176d99e9dd3b66d074d1ccaf6cf15aa43a82beec0e45e923
+  metadata.gz: 65e50cbafa3a2fc1372ce4150c0de4d54001345af9e7d487b048ba3d59929fd2
+  data.tar.gz: 3e84c14c32a912f5c447dc2d4525231f83cd2bd272f99a3b4e19261b692ee2c3
 SHA512:
-  metadata.gz: 84bdca42e27ed6dbcf2dfdcdb2756558796b0e2ecc727fa46ffe7fd734bf66d21d5fd76c47d9ae632a003292048c78151a412fcc98c6b33954d2f23cd7b71c19
-  data.tar.gz: 9f1204704614413b211b1814c96660656e03579712015152b3323f9dff0d64caaff5b96017cbbe203ed9a77ce15bc23e0e1d9473143edca14824f1380b925a25
+  metadata.gz: 5d12f7e3bc158c902256ce416e7770d95436deefcb12f7a54673200d06706d57e5368a8ddd2d6ed374c5c64ebe753c82619fa505864b5f002cf805e6d3d11146
+  data.tar.gz: 645d438dd54e867e6f58c2d0e2f1cdc09c49652b97cfd93ce39758440dea8f58e14910a5718d677513762195a5346a225c11fa289597ef6a7b28e4cf75541e2a

data/README.md

@@ -24,6 +24,7 @@ It's designed for development, debugging, and database analysis, offering a clea
   - Navigate through large datasets with an intuitive pagination interface
   - Scrollable table with fixed headers for improved navigation
   - Single-line cell display with ellipsis for wide content (tooltips on hover)
+  - Export table data to CSV format (configurable via `enable_data_export` option)
 - **SQL Queries**:
   - Run custom SELECT queries against your database in a secure, read-only environment
   - View table structure reference while writing queries
@@ -179,6 +180,7 @@ Dbviewer.configure do |config|
   config.query_timeout = 30                          # SQL query timeout in seconds
 
   # Query logging options
+  config.enable_query_logging = true                 # Enable or disable query logging completely (default: true)
   config.query_logging_mode = :memory                # Storage mode for SQL queries (:memory or :file)
   config.query_log_path = "log/dbviewer.log"         # Path for query log file when in :file mode
   config.max_memory_queries = 1000                   # Maximum number of queries to store in memory
@@ -194,6 +196,14 @@ The configuration is accessed through `Dbviewer.configuration` throughout the co
 
 DBViewer includes a powerful SQL query logging system that captures and analyzes database queries. You can access this log through the `/dbviewer/logs` endpoint. The logging system offers two storage backends:
 
+### Disabling Query Logging
+
+You can completely disable query logging if you don't need this feature:
+
+```ruby
+config.enable_query_logging = false       # Disable query logging completely
+```
+
 ### In-Memory Storage (Default)
 
 By default, queries are stored in memory. This provides fast access but queries are lost when the application restarts:

data/app/controllers/concerns/dbviewer/database_operations.rb

@@ -65,6 +65,19 @@ module Dbviewer
         empty_tables: tables.select { |t| t[:record_count] == 0 }
       }
 
+      # Calculate total foreign key relationships
+      begin
+        total_relationships = 0
+        tables.each do |table|
+          metadata = fetch_table_metadata(table[:name])
+          total_relationships += metadata[:foreign_keys].size if metadata && metadata[:foreign_keys]
+        end
+        analytics[:total_relationships] = total_relationships
+      rescue => e
+        Rails.logger.error("Error calculating relationship count: #{e.message}")
+        analytics[:total_relationships] = 0
+      end
+
       # Calculate schema size if possible
       begin
         analytics[:schema_size] = calculate_schema_size
@@ -207,6 +220,130 @@ module Dbviewer
       relationships
     end
 
+    # Get mini ERD data for a specific table and its relationships
+    def fetch_mini_erd_for_table(table_name)
+      related_tables = []
+      relationships = []
+
+      # Validate the table exists
+      unless database_manager.tables.include?(table_name)
+        Rails.logger.error("[DBViewer] Table not found for mini ERD: #{table_name}")
+        return {
+          tables: [],
+          relationships: [],
+          error: "Table '#{table_name}' not found in the database"
+        }
+      end
+
+      # Add current table
+      related_tables << { name: table_name }
+
+      Rails.logger.info("[DBViewer] Generating mini ERD for table: #{table_name}")
+
+      # Get foreign keys from this table to others (outgoing relationships)
+      begin
+        metadata = fetch_table_metadata(table_name)
+        Rails.logger.debug("[DBViewer] Table metadata: #{metadata.inspect}")
+
+        if metadata && metadata[:foreign_keys].present?
+          metadata[:foreign_keys].each do |fk|
+            # Ensure all required fields are present
+            next unless fk[:to_table].present? && fk[:column].present?
+
+            # Sanitize table and column names for display
+            from_table = table_name.to_s
+            to_table = fk[:to_table].to_s
+            from_column = fk[:column].to_s
+            to_column = fk[:primary_key].to_s.presence || "id"
+            relationship_name = fk[:name].to_s.presence || "#{from_table}_to_#{to_table}"
+
+            relationship = {
+              from_table: from_table,
+              to_table: to_table,
+              from_column: from_column,
+              to_column: to_column,
+              name: relationship_name,
+              direction: "outgoing"
+            }
+
+            relationships << relationship
+            Rails.logger.debug("[DBViewer] Added outgoing relationship: #{relationship.inspect}")
+
+            # Add the related table if not already included
+            unless related_tables.any? { |t| t[:name] == to_table }
+              related_tables << { name: to_table }
+            end
+          end
+        end
+      rescue => e
+        Rails.logger.error("[DBViewer] Error fetching outgoing relationships for #{table_name}: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+      end
+
+      # Get foreign keys from other tables to this one (incoming relationships)
+      begin
+        database_manager.tables.each do |other_table_name|
+          next if other_table_name == table_name # Skip self
+
+          begin
+            other_metadata = fetch_table_metadata(other_table_name)
+            if other_metadata && other_metadata[:foreign_keys].present?
+              other_metadata[:foreign_keys].each do |fk|
+                if fk[:to_table] == table_name
+                  # Ensure all required fields are present
+                  next unless fk[:column].present?
+
+                  # Sanitize table and column names for display
+                  from_table = other_table_name.to_s
+                  to_table = table_name.to_s
+                  from_column = fk[:column].to_s
+                  to_column = fk[:primary_key].to_s.presence || "id"
+                  relationship_name = fk[:name].to_s.presence || "#{from_table}_to_#{to_table}"
+
+                  relationship = {
+                    from_table: from_table,
+                    to_table: to_table,
+                    from_column: from_column,
+                    to_column: to_column,
+                    name: relationship_name,
+                    direction: "incoming"
+                  }
+
+                  relationships << relationship
+                  Rails.logger.debug("[DBViewer] Added incoming relationship: #{relationship.inspect}")
+
+                  # Add the related table if not already included
+                  unless related_tables.any? { |t| t[:name] == from_table }
+                    related_tables << { name: from_table }
+                  end
+                end
+              end
+            end
+          rescue => e
+            Rails.logger.error("[DBViewer] Error processing relationships for table #{other_table_name}: #{e.message}")
+            # Continue to the next table
+          end
+        end
+      rescue => e
+        Rails.logger.error("[DBViewer] Error fetching incoming relationships for #{table_name}: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+      end
+
+      # If no relationships were found, make sure to still include at least the current table
+      if relationships.empty?
+        Rails.logger.info("[DBViewer] No relationships found for table: #{table_name}")
+      end
+
+      result = {
+        tables: related_tables,
+        relationships: relationships,
+        timestamp: Time.now.to_i
+      }
+
+      Rails.logger.info("[DBViewer] Mini ERD data generated: #{related_tables.length} tables, #{relationships.length} relationships")
+      result
+    end
+
     # Prepare the SQL query - either from params or default
     def prepare_query
       quoted_table = safe_quote_table_name(@table_name)

data/app/controllers/dbviewer/logs_controller.rb

@@ -1,6 +1,7 @@
 module Dbviewer
   class LogsController < ApplicationController
     before_action :set_filters, only: [ :index ]
+    before_action :check_logging_enabled
 
     def index
       @queries = dbviewer_logger.recent_queries(
@@ -28,6 +29,13 @@ module Dbviewer
 
     private
 
+    def check_logging_enabled
+      unless Dbviewer.configuration.enable_query_logging
+        flash[:warning] = "Query logging is disabled. Enable it in the configuration to use this feature."
+        redirect_to root_path
+      end
+    end
+
     def set_filters
       @table_filter = params[:table_filter]
       @request_id = params[:request_id]

data/app/controllers/dbviewer/tables_controller.rb

@@ -27,6 +27,12 @@ module Dbviewer
       @total_pages = calculate_total_pages(@total_count, @per_page)
       @records = fetch_table_records(@table_name)
 
+      # Ensure @records is never nil to prevent template errors
+      if @records.nil?
+        column_names = fetch_table_columns(@table_name).map { |c| c[:name] }
+        @records = ActiveRecord::Result.new(column_names, [])
+      end
+
       # Fetch timestamp visualization data if the table has a created_at column
       if has_timestamp_column?(@table_name)
         @time_grouping = params[:time_group] || "daily"
@@ -46,6 +52,34 @@ module Dbviewer
       end
     end
 
+    def mini_erd
+      @table_name = params[:id]
+
+      begin
+        @erd_data = fetch_mini_erd_for_table(@table_name)
+
+        if @erd_data[:error].present?
+          Rails.logger.error("Mini ERD error: #{@erd_data[:error]}")
+        end
+
+        respond_to do |format|
+          format.json { render json: @erd_data }
+          format.html { render layout: false }
+        end
+      rescue => e
+        Rails.logger.error("Error generating Mini ERD: #{e.message}")
+        Rails.logger.error(e.backtrace.join("\n"))
+
+        @error_message = e.message
+        @erd_data = { tables: [], relationships: [], error: @error_message }
+
+        respond_to do |format|
+          format.json { render json: { error: @error_message }, status: :internal_server_error }
+          format.html { render layout: false }
+        end
+      end
+    end
+
     def query
       @table_name = params[:id]
       @read_only_mode = true # Flag to indicate we're in read-only mode
@@ -62,6 +96,12 @@ module Dbviewer
     end
 
     def export_csv
+      unless Dbviewer.configuration.enable_data_export
+        flash[:alert] = "Data export is disabled in the configuration"
+        redirect_to table_path(params[:id])
+        return
+      end
+
       table_name = params[:id]
       limit = (params[:limit] || 10000).to_i
       include_headers = params[:include_headers] != "0"

data/app/views/dbviewer/home/index.html.erb

@@ -15,37 +15,58 @@
 
   <div class="row g-3 mb-4">
     <div class="col-md-3">
-      <div class="card h-100 text-center border-0 <%= stat_card_bg_class %>">
-        <div class="card-body">
-          <h5 class="mb-1">Tables</h5>
-          <h2 class="mb-0"><%= @analytics[:total_tables] %></h2>
+      <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
+        <div class="card-body d-flex align-items-center">
+          <div class="metric-icon me-3">
+            <i class="bi bi-table fs-4"></i>
+          </div>
+          <div class="text-start">
+            <h5 class="mb-1">Tables</h5>
+            <h2 class="mb-0"><%= @analytics[:total_tables] %></h2>
+          </div>
         </div>
       </div>
     </div>
     
     <div class="col-md-3">
-      <div class="card h-100 text-center border-0 <%= stat_card_bg_class %>">
-        <div class="card-body">
-          <h5 class="mb-1">Records</h5>
-          <h2 class="mb-0"><%= number_with_delimiter(@analytics[:total_records]) %></h2>
+      <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
+        <div class="card-body d-flex align-items-center">
+          <div class="metric-icon me-3">
+            <i class="bi bi-database fs-4"></i>
+          </div>
+          <div class="text-start">
+            <h5 class="mb-1">Records</h5>
+            <h2 class="mb-0"><%= number_with_delimiter(@analytics[:total_records]) %></h2>
+          </div>
         </div>
       </div>
     </div>
     
     <div class="col-md-3">
-      <div class="card h-100 text-center border-0 <%= stat_card_bg_class %>">
-        <div class="card-body">
-          <h5 class="mb-1">Columns</h5>
-          <h2 class="mb-0"><%= @analytics[:total_columns] %></h2>
+      <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
+        <div class="card-body d-flex align-items-center">
+          <div class="metric-icon me-3">
+            <i class="bi bi-link-45deg fs-4"></i>
+          </div>
+          <div class="text-start">
+            <h5 class="mb-1">Relationships</h5>
+            <h2 class="mb-0"><%= @analytics[:total_relationships] %></h2>
+            <small class="text-muted d-block">Foreign Key Connections</small>
+          </div>
         </div>
       </div>
     </div>
     
     <div class="col-md-3">
-      <div class="card h-100 text-center border-0 <%= stat_card_bg_class %>">
-        <div class="card-body">
-          <h5 class="mb-1">Database Size</h5>
-          <h2 class="mb-0"><%= number_to_human_size(@analytics[:schema_size]) %></h2>
+      <div class="card h-100 border-0 shadow-sm <%= stat_card_bg_class %>">
+        <div class="card-body d-flex align-items-center">
+          <div class="metric-icon me-3">
+            <i class="bi bi-hdd fs-4"></i>
+          </div>
+          <div class="text-start">
+            <h5 class="mb-1">Database Size</h5>
+            <h2 class="mb-0"><%= number_to_human_size(@analytics[:schema_size]) %></h2>
+          </div>
         </div>
       </div>
     </div>
@@ -94,46 +115,55 @@
       <div class="card shadow-sm">
         <div class="card-header d-flex justify-content-between align-items-center">
           <h5 class="card-title mb-0">Recent SQL Queries</h5>
-          <a href="<%= dbviewer.logs_path %>" class="btn btn-sm btn-primary">View All Logs</a>
+          <% if Dbviewer.configuration.enable_query_logging %>
+            <a href="<%= dbviewer.logs_path %>" class="btn btn-sm btn-primary">View All Logs</a>
+          <% end %>
         </div>
         <div class="card-body p-0">
           <% begin %>
             <% require_dependency "dbviewer/logger" %>
-            <% queries = Dbviewer::Logger.instance.recent_queries(limit: 10) %>
-            
-            <% if queries.any? %>
-              <div class="table-responsive">
-                <table class="table table-sm table-hover mb-0">
+            <% if Dbviewer.configuration.enable_query_logging %>
+              <% queries = Dbviewer::Logger.instance.recent_queries(limit: 10) %>
+              
+              <% if queries.any? %>
+                <div class="table-responsive">
+                  <table class="table table-sm table-hover mb-0">
 
-                <thead>
-                  <tr>
-                    <th>Query</th>
-                    <th class="text-end" style="width: 120px">Duration</th>
-                    <th class="text-end" style="width: 180px">Time</th>
-                  </tr>
-                </thead>
-                <tbody>
-                  <% queries.each do |query| %>
+                  <thead>
                     <tr>
-                      <td class="text-truncate" style="max-width: 500px;">
-                        <code class="sql-query-code"><%= query[:sql] %></code>
-                      </td>
-                      <td class="text-end">
-                        <span class="<%= query[:duration_ms] > 100 ? 'query-duration-slow' : 'query-duration' %>">
-                          <%= query[:duration_ms] %> ms
-                        </span>
-                      </td>
-                      <td class="text-end query-timestamp">
-                        <small><%= query[:timestamp].strftime("%H:%M:%S") %></small>
-                      </td>
+                      <th>Query</th>
+                      <th class="text-end" style="width: 120px">Duration</th>
+                      <th class="text-end" style="width: 180px">Time</th>
                     </tr>
-                  <% end %>
-                </tbody>
-              </table>
-            </div>
+                  </thead>
+                  <tbody>
+                    <% queries.each do |query| %>
+                      <tr>
+                        <td class="text-truncate" style="max-width: 500px;">
+                          <code class="sql-query-code"><%= query[:sql] %></code>
+                        </td>
+                        <td class="text-end">
+                          <span class="<%= query[:duration_ms] > 100 ? 'query-duration-slow' : 'query-duration' %>">
+                            <%= query[:duration_ms] %> ms
+                          </span>
+                        </td>
+                        <td class="text-end query-timestamp">
+                          <small><%= query[:timestamp].strftime("%H:%M:%S") %></small>
+                        </td>
+                      </tr>
+                    <% end %>
+                  </tbody>
+                </table>
+              </div>
+              <% else %>
+                <div class="text-center my-4 empty-data-message">
+                  <p>No queries recorded yet</p>
+                </div>
+              <% end %>
             <% else %>
               <div class="text-center my-4 empty-data-message">
-                <p>No queries recorded yet</p>
+                <p>Query logging is disabled</p>
+                <small class="text-muted">Enable it in the configuration to see SQL queries here</small>
               </div>
             <% end %>
           <% rescue => e %>