Skip to content

Latest commit

 

History

History
executable file
·
239 lines (161 loc) · 8.99 KB

README.md

File metadata and controls

executable file
·
239 lines (161 loc) · 8.99 KB
Raw

Rails DB

Please share this gem with your friends to get more feedback. I would really appreciate for the gem review if you have a blog. If you have ideas - please create an issue or contact me by email: igorkasyanchuk[@]gmail.com.

Build Status Gem Version

Quick way to inspect your Rails database http://localhost:12345/rails/db, see content of tables, export them to CSV, EXPLAIN SQL and run SQL queries.

Demo available on: https://rails-db.herokuapp.com/rails/db/

Video Demos: https://youtu.be/TYsRxXRFp1g, https://youtu.be/dfViQPZw9zE

Requirements

Version >2.0 100% works with Ruby 2.3+, and Rails 5+. As for other versions of RoR use 1.6 version of gem. Also there are automated tests running on Travis CI. Supports: PostgresSQL, MySQL, SQLite. Not sure about other adapters. Since gem is using ActiveRecord it will work with others DBs.

For older versions of Rails please user gem "rails_db", "1.6".

Note (!)

Gem works with ruby 1.9.3 but you need to use kaminari < 1.0.0 gem and rails_db <= 1.6. Please add to gemfile gem 'kaminari', '< 1.0.0'.

Main Features

  • command line tools railsdb and runsql to run app and sql for your apps.
  • view content and schema of DB tables (including indexes)
  • create, edit content
  • sort content of DB tables
  • filtering data (multiple filters supported too)
  • execute SQL queries
  • autocomplete for SQL queries
  • filter tables for easier navigation
  • show/hide columns in tables
  • use history of you SQL queries
  • see EXPLAIN results for your queries
  • export data to CSV and Excel
  • import SQL files
  • expand/collapse sidebar
  • hide/show columns
  • allow access for current user for example with appropriate role
  • added HTTP_BASIC auth for Rails DB
  • ability to turn on/off using initializer
  • white/black list of tables
  • data-tables inside your app
  • ajax-ify Rails DB
  • delete records, truncate tables
  • visualize SQL schema (future)
  • CRUD for table records (future)

Install

Add this to the development group in your Gemfile

For all environments (be careful with production environment):

  gem 'rails_db', '2.0.4'

Or only for development:

  group :development do
    gem 'rails_db', '2.0.4'
  end

Run bundle install

Visit http://localhost:3000/rails/db and you will see your database tables and SQL editors.

Use port 12345 if running in 'standalone' mode

Optionally, add gem 'axlsx_rails' to your application's Gemfile to be able to export to excel .xlsx files.

Customization

If you want to customize gem (create initializer) run in console:

rails g rails_db initializer

If will create file config/initializers/rails_db.rb.

Options

  • enabled - enable or disable gem (default: true).
  • automatic_routes_mount - automatically mount engine routes in your app (default: true).
  • http_basic_authentication_enabled - Enable HTTP_BASIC authentication (default: false).
  • http_basic_authentication_user_name - HTTP_BASIC authentication user name.
  • http_basic_authentication_password - HTTP_BASIC authentication password.
  • black_list_tables - black list for tables (hide tables from sidebar).
  • white_list_tables - black list for tables (show only these tables in sidebar).
  • verify_access_proc - allow access by specific conditions, for example by role for current_user, or you can use for example Pundit here (default: proc { |controller| true })

If you want to add routes manually (or customize the mounted location) you need to first turn off automatic_routes_mount and then add to your routes.rb

  mount RailsDb::Engine => '/rails/db', :as => 'rails_db'

If you wanted to only allow access to admins and, for example, you are using Devise you could do following (in config/initializers/rails_db.rb)

  config.verify_access_proc = proc { |controller| controller.current_user.admin? }

Data Tables

You can easily embed data-tables into your App with content from DB.

You can build data tables for the whole Table, Table with specific columns or based on SQL query.

Below you can see samples on how you can embed data-tables directly in your app.

<h3>Table</h3>

<%= rails_db_data_table 'accounts',
                        footer: true,
                        columns: ['id', 'name', 'users_count'],
                        header: true,
                        style: :bootstrap %>

<h3>SQL</h3>

<%= rails_db_data_table_sql 'select id, name, age from users order by age desc limit 10',
                            footer: false,
                            header: true %>

Samples & Screenshots

Schema

SQL Editor

Rails App SQL editor with syntax highlight and code complete.

Install & visit http://localhost:3000/rails/db to see it in action.

RailsDB Standalone

Run RailsDB Standalone commands locally withing configuration of your config/database.yml.

RailsDB Standalone and runsql doesn't require to be added to Gemfile or you application.

RunSQL Util

Run SQL commands locally withing configuration of your config/database.yml

Edit Content in Rails DB

===

++There is a dependency on MySQL. You may need to gem install mysql2 -v '0.3.20'

Contributing

  • Fork it
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Added some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create new Pull Request

Local Development

Local Build

  • in gem root folder run gem build rails_db.gemspec
  • then try to install local version of the gem gem install rails_db-0.X.X.gem
  • now you can use this gem locally
  • don't forget to uninstall it

Run Tests

To run tests locally you need to execute rake test withing root folder of project.

After your push to git, all tests will be executed on Travis CI environment.

You can also change locally DB to verify gem accross multiple Databases (mysql, postgres, sqlite). For more details see test/dummy/config/database.yml (you need to set DB ENV variable).

Common Issues and Solutions

  • "Invalid css error" - igorkasyanchuk#11
  • "Automatic routes mounting" - igorkasyanchuk#4
  • gems(mysql, pg) are not found - RailsDB doesn't have any strict dependency inside. So you need to install gems manually gem install pg or gem install mysql -v=0.3.18.
  • "ActionView::Template::Error (No input found for jsonb):" - igorkasyanchuk#39
  • issue with Ransack gem (in rails_db search method is removed), try to use method ransack instead because search is deprectated.

Plans

  • Add more tests
  • Verify all environments
  • Add DB schema visualization
  • Create WIKI pages, improve documentation
  • Add favicon for standalone and dummy apps
  • Add ERD schema

License

This project uses MIT-LICENSE.