Module: Dbwatcher

Defined in:
lib/dbwatcher.rb,
lib/dbwatcher/engine.rb,
lib/dbwatcher/logging.rb,
lib/dbwatcher/storage.rb,
lib/dbwatcher/tracker.rb,
lib/dbwatcher/version.rb,
lib/dbwatcher/middleware.rb,
lib/dbwatcher/sql_logger.rb,
lib/dbwatcher/configuration.rb,
lib/dbwatcher/storage/errors.rb,
lib/dbwatcher/model_extension.rb,
lib/dbwatcher/storage/session.rb,
lib/dbwatcher/storage/date_helper.rb,
lib/dbwatcher/storage/api/base_api.rb,
lib/dbwatcher/storage/base_storage.rb,
lib/dbwatcher/storage/file_manager.rb,
lib/dbwatcher/storage/null_session.rb,
lib/dbwatcher/services/base_service.rb,
lib/dbwatcher/services/diagram_data.rb,
lib/dbwatcher/storage/api/query_api.rb,
lib/dbwatcher/storage/api/table_api.rb,
lib/dbwatcher/storage/query_storage.rb,
lib/dbwatcher/storage/session_query.rb,
lib/dbwatcher/storage/table_storage.rb,
app/helpers/dbwatcher/diagram_helper.rb,
app/helpers/dbwatcher/session_helper.rb,
lib/dbwatcher/services/diagram_system.rb,
lib/dbwatcher/storage/api/session_api.rb,
lib/dbwatcher/storage/query_validator.rb,
lib/dbwatcher/storage/session_storage.rb,
lib/dbwatcher/storage/change_processor.rb,
app/helpers/dbwatcher/formatting_helper.rb,
app/helpers/dbwatcher/application_helper.rb,
lib/dbwatcher/services/diagram_data/base.rb,
lib/dbwatcher/services/diagram_generator.rb,
lib/dbwatcher/storage/session_operations.rb,
app/controllers/dbwatcher/base_controller.rb,
lib/dbwatcher/storage/system_info_storage.rb,
lib/dbwatcher/services/diagram_data/entity.rb,
lib/dbwatcher/storage/concerns/validatable.rb,
app/controllers/dbwatcher/tables_controller.rb,
lib/dbwatcher/services/api/base_api_service.rb,
lib/dbwatcher/services/diagram_data/dataset.rb,
app/controllers/dbwatcher/queries_controller.rb,
lib/dbwatcher/services/diagram_error_handler.rb,
lib/dbwatcher/services/diagram_type_registry.rb,
lib/dbwatcher/services/timeline_data_service.rb,
lib/dbwatcher/storage/concerns/error_handler.rb,
lib/dbwatcher/storage/concerns/timestampable.rb,
app/controllers/dbwatcher/sessions_controller.rb,
lib/dbwatcher/services/diagram_data/attribute.rb,
lib/dbwatcher/services/mermaid_syntax_builder.rb,
lib/dbwatcher/services/query_filter_processor.rb,
app/controllers/dbwatcher/dashboard_controller.rb,
lib/dbwatcher/services/api/tables_data_service.rb,
lib/dbwatcher/storage/concerns/data_normalizer.rb,
lib/dbwatcher/services/api/diagram_data_service.rb,
lib/dbwatcher/services/api/summary_data_service.rb,
lib/dbwatcher/services/mermaid_syntax/sanitizer.rb,
lib/dbwatcher/services/dashboard_data_aggregator.rb,
lib/dbwatcher/services/diagram_data/relationship.rb,
lib/dbwatcher/services/mermaid_syntax/erd_builder.rb,
lib/dbwatcher/services/table_statistics_collector.rb,
lib/dbwatcher/storage/api/concerns/table_analyzer.rb,
lib/dbwatcher/services/mermaid_syntax/base_builder.rb,
app/controllers/dbwatcher/api/v1/sessions_controller.rb,
lib/dbwatcher/services/analyzers/table_summary_builder.rb,
lib/dbwatcher/services/diagram_analyzers/base_analyzer.rb,
app/controllers/dbwatcher/api/v1/system_info_controller.rb,
lib/dbwatcher/services/analyzers/session_data_processor.rb,
lib/dbwatcher/services/diagram_data/relationship_params.rb,
lib/dbwatcher/services/mermaid_syntax/flowchart_builder.rb,
lib/dbwatcher/services/mermaid_syntax/cardinality_mapper.rb,
lib/dbwatcher/services/system_info/system_info_collector.rb,
lib/dbwatcher/services/system_info/machine_info_collector.rb,
lib/dbwatcher/services/system_info/runtime_info_collector.rb,
app/controllers/dbwatcher/dashboard/system_info_controller.rb,
lib/dbwatcher/services/mermaid_syntax/class_diagram_helper.rb,
lib/dbwatcher/services/system_info/database_info_collector.rb,
lib/dbwatcher/services/timeline_data_service/entry_builder.rb,
lib/dbwatcher/services/mermaid_syntax/class_diagram_builder.rb,
lib/dbwatcher/services/diagram_analyzers/foreign_key_analyzer.rb,
lib/dbwatcher/services/timeline_data_service/metadata_builder.rb,
lib/dbwatcher/services/diagram_strategies/erd_diagram_strategy.rb,
lib/dbwatcher/services/diagram_strategies/base_diagram_strategy.rb,
lib/dbwatcher/services/diagram_strategies/class_diagram_strategy.rb,
lib/dbwatcher/services/diagram_strategies/diagram_strategy_helpers.rb,
lib/dbwatcher/services/timeline_data_service/enhancement_utilities.rb,
lib/dbwatcher/services/diagram_analyzers/model_association_analyzer.rb,
lib/dbwatcher/services/diagram_strategies/standard_diagram_strategy.rb,
lib/dbwatcher/services/diagram_strategies/flowchart_diagram_strategy.rb,
lib/dbwatcher/services/diagram_analyzers/inferred_relationship_analyzer.rb,
lib/dbwatcher/services/diagram_analyzers/model_analysis/dataset_builder.rb,
lib/dbwatcher/services/diagram_analyzers/model_analysis/model_discovery.rb,
lib/dbwatcher/services/diagram_analyzers/concerns/activerecord_introspection.rb,
lib/dbwatcher/services/diagram_analyzers/concerns/association_scope_filtering.rb,
lib/dbwatcher/services/diagram_analyzers/model_analysis/association_extractor.rb

Overview

DBWatcher module

Defined Under Namespace

Modules: Api, ApplicationHelper, Dashboard, DiagramHelper, FormattingHelper, Logging, ModelExtension, Services, SessionHelper, Storage Classes: BaseController, Configuration, ConfigurationError, DashboardController, Engine, Error, Middleware, QueriesController, SessionsController, SqlLogger, TablesController, Tracker

Constant Summary collapse

VERSION = 
"1.1.6"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Configuration

Get configuration

Returns:



94
95
96
 
# File 'lib/dbwatcher.rb', line 94

def configuration
  @configuration ||= Configuration.new
end

Class Method Details

.clear_all ⇒ Integer

Clears all stored data (sessions and queries)

Returns:

  • (Integer) —

    total number of files removed



117
118
119
 
# File 'lib/dbwatcher.rb', line 117

def clear_all
  Storage.clear_all
end

.configure {|configuration| ... } ⇒ Configuration

Configure DBWatcher

Yields:

Returns:



102
103
104
 
# File 'lib/dbwatcher.rb', line 102

def configure
  yield(configuration)
end

.current_session ⇒ Object 



110
111
112
 
# File 'lib/dbwatcher.rb', line 110

def current_session
  Tracker.current_session
end

.track(name: nil, metadata: {}, &block) ⇒ Object 



106
107
108
 
# File 'lib/dbwatcher.rb', line 106

def track(name: nil, metadata: {}, &block)
  Tracker.track(name: name, metadata: metadata, &block)
end