Sha256: 6284a588d10f85b27e9b0026630bb9963efac66ea0a7556f17d15d6e8063b099

Contents?: true

Size: 1.71 KB

Versions: 1

Compression:

Stored size: 1.71 KB

Contents

# Sequel::XTDB

Adapter to connect to XTDB v2 using Sequel.

## Installation

Install the gem and add to the application's Gemfile by executing:

```bash
bundle add sequel-xtdb
```

If bundler is not being used to manage dependencies, install the gem by executing:

```bash
gem install sequel-xtdb
```

## Usage

Shortcut to happiness:
```ruby
# Get a Ruby console using the sequel CLI
$ sequel 'xtdb://localhost:5432/xtdb'

# ..or from repl/your project
DB = Sequel.connect("xtdb://localhost:54321/xtdb")

# then
irb(main)> DB << "insert into products(_id, name, price) values(1, 'Spam', 1000), (2, 'Ham', 1200)"
irb(main)> DB["select * from products"].all
=> [{:_id=>2, :name=>"Ham", :price=>1200}, {:_id=>1, :name=>"Spam", :price=>1100}]
```

## Status

Very early days :)  
Currently it's essentially the postgres-adapter with support for a xtdb-scheme url.


## 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 [xtdb-url]` for an interactive prompt that will allow you to experiment. The script will pick up on env-var `XTDB_URL`, though the argument takes precedence.

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 the created tag, 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/eval/sequel-xtdb.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
sequel-xtdb-0.2.1 README.md