baza - GitLite

KO | EN

gitlite — search

#developer-tools #javascript #chatgpt #command-line #monitoring #security #cloud-native #git #computer-vision #java

baza

(★ 12)

A database abstraction layer and framework for Ruby.

File Explorer

ZIP Download

- dependabot.yml
- best_project_practice_rubocop.yml
- best_project_practice_rubocop_todo.yml
- - base_sql_driver.rb
  - cloner.rb
  - column.rb
  - commands.rb
  - database.rb
  - database_model.rb
  - database_model_functionality.rb
  - database_model_name.rb
  - db.rb
  - dbtime.rb
  - driver.rb
  - dump.rb
  - errors.rb
  - foreign_key.rb
  - idquery.rb
  - index.rb
  - jdbc_driver.rb
  - jdbc_result.rb
  - mysql_base_driver.rb
  - query_buffer.rb
  - result_base.rb
  - row.rb
  - sql_queries.rb
  - sqlspecs.rb
  - table.rb
  - tables.rb
- baza.rb
- - cloner_spec.rb
- - driver_active_record_collection.rb
  - driver_collection.rb
  - driver_columns_collection.rb
  - driver_databases_collection.rb
  - driver_foreign_keys_collection.rb
  - driver_importer_collection.rb
  - driver_indexes_collection.rb
  - driver_tables_collection.rb
  - driver_users_collection.rb
- info_active_record_example.rb
- info_active_record_mysql2_example.rb
- info_active_record_mysql2_peak_flow.rb
- info_active_record_mysql_example.rb
- info_active_record_mysql_peak_flow.rb
- info_active_record_pg_example.rb
- info_active_record_pg_peak_flow.rb
- info_active_record_sqlite3.rb
- info_mysql2_example.rb
- info_mysql2_peak_flow.rb
- info_mysql_example.rb
- info_mysql_peak_flow.rb
- info_pg_example.rb
- info_pg_peak_flow.rb
- info_sqlite3.rb
- spec_helper.rb
.document
.gitignore
.rspec
.rubocop.yml
.rubocop_todo.yml
.ruby-version
baza.gemspec
Gemfile
Gemfile.lock
LICENSE.txt
peak_flow.yml
Rakefile
README.md
VERSION

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`gem`

View Details ▼

A package manager for the Ruby programming language.

gem search {{regex}} {{[-a|--all]}}

Search for remote gem(s) and show all available versions:

gem install {{gem_name}}

Install the latest version of a gem:

gem install {{gem_name}} {{[-v|--version]}} {{1.0.0}}

Install a specific version of a gem:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

A database abstraction layer for Ruby. Also supports JRuby.

## Installation

Is fairly painless.
```
gem install baza
```

Or in your Gemfile:
```ruby
gem 'baza'
```

## Connection to a database.

### MySQL
```ruby
db = Baza::Db.new(type: :mysql2, host: "localhost", user: "my_user", pass: "my_password", port: 3306, db: "my_database")
```

### PostgreSQL
```ruby
db = Baza::Db.new(type: :pg, host: "localhost", user: "my_user", pass: "my_password", db: "my_database")
```

### SQLite3
```ruby
db = Baza::Db.new(type: :sqlite3, path: "/path/to/file.sqlite3")
```

## Queries

### Select
```ruby
db.select(:users, {name: "Kasper"}, {orderby: "age"}) do |row|
  puts "Row: #{row}"
end

name = "Kasper"
db.q("SELECT * FROM users WHERE name = '#{db.esc(name)}' ORDER BY age") do |row|
  puts "Row: #{row}"
end
```

### Inserting
```ruby
db.insert(:users, {name: "Kasper", age: 27})
id = db.last_id
```

It can also return the ID at the same time
```ruby
id = db.insert(:users, {name: "Kasper", age: 27}, return_id: true)
```

Inserting multiple rows in one query is also fairly painless:
```ruby
db.insert_multi(:users, [
  {name: "Kasper", age: 27},
  {name: "Christina", age: 25},
  {name: "Charlotte", age: 23}
])
```

### Update
```ruby
db.update(:users, {name: "Kasper Johansen"}, {name: "Kasper"})
```

### Delete
```ruby
db.delete(:users, name: "Kasper")
```

### Upsert
The following example handels a row that will be inserted with {name: "Kasper", age: 27} if it doesnt exist or rows with {name: "Kasper"} will have their their age updated to 27.
```ruby
db.upsert(:users, {name: "Kasper"}, {age: 27})
```

## Structure

### Database creation
```ruby
db.databases.create(name: "test-db")
```

### Database renaming
```ruby
database = db.databases["test-db"]
database.name = "new-name"
database.save!
```

### Listing databases
```ruby
db.databases.list.each do |database|
  puts "Database: #{database.name}"
end
```

### Dropping a database
```ruby
database = db.databases["test-db"]
database.drop
```

### Listing tables on non-used-database
```ruby
database = db.database["test-db"]
database.tables.each do |table|
  puts "TableName: #{table.name}"
  puts "Columns: #{table.columns.map(&:name)}"
end
```

### Table creation
```ruby
db.tables.create(:users, {
  columns: [
    {name: :id, type: :int, autoincr: true, primarykey: true},
    {name: :name, type: :varchar}
  ],
  indexes: [
    :name
  ]
})
```

### Table dropping
```ruby
table = db.tables[:users]
table.drop
```

### Table listing
```ruby
array_of_tables = db.tables.list
```

Or you can use blocks:
```ruby
db.tables.list do |table|
  puts "Table-name: #{table.name}"
end
```

### Table renaming
```ruby
table = db.tables[:users]
table.rename(:new_table_name)
```

### Table optimizing
```ruby
table.optimize
```

### Table rows counting
```ruby
table.rows_count
```

### Column listing
```ruby
table = db.tables["users"]
cols = table.columns
```

Or a specific column:
```ruby
column = table.column(:id)
puts "Column: #{column.name} #{column.type}(#{column.maxlength})"
puts "Default: #{column.default}"
```

### Column altering
```ruby
column.change(name: "newname", type: :varchar, default: "")
```

### Drop column
```ruby
column.drop
```

### Get an index by name
```ruby
index = table.index("index_name")
```

### Rename index
```ruby
index.rename("new name")
```

### Dropping an index
```ruby
index.drop
```

### Getting various data from an index
```ruby
puts "Unique: #{index.unique?}"
puts "Primary: #{index.primary?}"
puts "Autoincr: #{index.autoincr?}"
puts "Table: #{index.table}"
```

## Copying databases
```ruby
db_mysql = Baza::Db.new(type: :mysql, ...)
db_mysql2 = Baza::Db.new(type: :mysql2, ...)
db_sqlite = Baza::Db.new(type: :sqlite3, path: ...)

db_mysql.copy_to(db_sqlite)
```

## Dumping SQL to an IO
```ruby
db = Baza::Db.new(...)
dump = Baza::Dump.new(db: db)
str_io = StringIO.new
dump.dump(str_io)
```

## Transactions
```ruby
db.transaction do
  1000.times do
    db.insert(:users, name: "Kasper")
  end
end
```

## Users

### Listing users
```ruby
db.users.list do |user|
  puts "User found: #{user.name}"
end
```

```ruby
root_user = db.users.find_by_name("root")
root_user.name #=> "root"
```

### Dropping users
```ruby
user.drop
```

### Creating users
```ruby
user = db.users.create(name: "myuser", host: "localhost")
```

## Query Buffer
In order to speed things up, but without using transactions directly, you can use a query buffer. This stores various instructions in memory and flushes them every now and then through transactions or intelligent queries (like multi-insertion). The drawback is that it will not be possible to test the queries for errors before a flush is executed and it wont be possible to read results from any of the queries.

It is fairly simple do:
```ruby
db.q_buffer do |buffer|
  100_000.times do |count|
    buffer.insert(:table_name, name: "Kasper #{count}")

buffer.query("UPDATE table SET ...")
    buffer.query("DELETE FROM table WHERE ...")
  end
end
```

## Contributing to baza

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

## Copyright

Copyright (c) 2013 Kasper Johansen. See LICENSE.txt for
further details.