https://github.com/ruby/sdbm
Provides a simple file-based key-value store with String keys and values.
https://github.com/ruby/sdbm
ruby sdbm
Last synced: 8 months ago
JSON representation
Provides a simple file-based key-value store with String keys and values.
- Host: GitHub
- URL: https://github.com/ruby/sdbm
- Owner: ruby
- License: bsd-2-clause
- Created: 2017-03-28T07:09:19.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T04:02:23.000Z (over 1 year ago)
- Last Synced: 2025-03-31T16:15:22.039Z (9 months ago)
- Topics: ruby, sdbm
- Language: C
- Homepage:
- Size: 145 KB
- Stars: 22
- Watchers: 30
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# SDBM
[](https://github.com/ruby/sdbm/actions/workflows/test.yml)
SDBM provides a simple file-based key-value store, which can only store String keys and values.
Note that Ruby comes with the source code for SDBM, while the DBM and GDBM standard libraries rely on external libraries and headers.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sdbm'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sdbm
## Usage
### Insert values:
```ruby
require 'sdbm'
SDBM.open 'my_database' do |db|
db['apple'] = 'fruit'
db['pear'] = 'fruit'
db['carrot'] = 'vegetable'
db['tomato'] = 'vegetable'
end
```
### Bulk update:
```ruby
require 'sdbm'
SDBM.open 'my_database' do |db|
db.update('peach' => 'fruit', 'tomato' => 'fruit')
end
```
### Retrieve values:
```ruby
require 'sdbm'
SDBM.open 'my_database' do |db|
db.each do |key, value|
puts "Key: #{key}, Value: #{value}"
end
end
```
### Outputs:
```ruby
Key: apple, Value: fruit
Key: pear, Value: fruit
Key: carrot, Value: vegetable
Key: peach, Value: fruit
Key: tomato, Value: fruit
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/sdbm.
## License
The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).