README.md in koine-db_bkp-0.1.0 vs README.md in koine-db_bkp-0.1.1
- old
+ new
@@ -30,44 +30,56 @@
)
backup.to_sql_file('/bkp/file.sql')
```
-### MySql on Rails
+### Rake tasks
```ruby
-require 'koine/db_bkp/mysql/rails_dump'
+# Rakefile
-# credentials taken from current Rails.configuration.database_configuration[Rails.env]
-backup = Koine::DbBkp::Mysql::RailsDump.new
-backup.to_sql_file('/bkp/file.sql')
+require "koine/db_bkp"
+
+Koine::Tasks::MysqlDump.new do |t|
+ t.task_name = 'some_task' # defaults to 'mysql:dump'
+ t.output_file = 'backup_{timestamp}.sql' # defaults to ENV['MYSQL_BACKUP_FILE']
+ # {timestamp} is a placeholder for the autogenerated timestamp
+
+ # database config
+ t.url = 'mysql2://username:password@hostname/database_name' # defaults to ENV['DB_URL']
+
+ # or database config
+ t.hostname = 'hostname' # defaults to ENV['DB_HOST']
+ t.database = 'database_name' # defaults to ENV['DB_NAME']
+ t.username = 'username' # defaults to ENV['DB_USER']
+ t.password = 'password' # defaults to ENV['DB_PASSWORD']
+
+ # rake task dependencies
+ t.dependencies = [:environment] # defaults to []
+end
```
-### Rake tasks
+#### Rails task
```ruby
+# Rakefile
+
require "koine/db_bkp"
-import 'lib/koine/tasks/mysql_dump.rake'
-import 'lib/koine/tasks/mysql_rails_dump.rake'
+# same options of Koine::Tasks::RailsMysqlDump apply
+Koine::Tasks::RailsMysqlDump.new
```
```bash
-export DB_HOST=some_host
-export DB_NAME=some_name
-export DB_USER=some_user
-export DB_PASSWORD=some_password
-export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
-
-rake koine:mysql:dump
+rake rake mysql:dump
```
```bash
# database config will be taken from the Rails.configuration.database_configuration[ENV['RAILS_ENV']]
export MYSQL_BACKUP_FILE='/foo/bar_{timestamp}.sql'
-rake koine:mysql:rails_dump
+rake mysql:rails_dump
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.