Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watson1978/ilios
Cassandra driver written by C language for Ruby
https://github.com/watson1978/ilios
c cassandra ruby
Last synced: about 1 month ago
JSON representation
Cassandra driver written by C language for Ruby
- Host: GitHub
- URL: https://github.com/watson1978/ilios
- Owner: Watson1978
- License: mit
- Created: 2023-09-11T09:33:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-27T15:50:47.000Z (about 1 month ago)
- Last Synced: 2024-12-27T16:32:47.333Z (about 1 month ago)
- Topics: c, cassandra, ruby
- Language: C
- Homepage:
- Size: 166 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ilios
[](https://badge.fury.io/rb/ilios)
[](https://github.com/Watson1978/ilios/actions/workflows/CI.yml)
Ilios that Cassandra driver written by C language for Ruby using [DataStax C/C++ Driver](https://github.com/datastax/cpp-driver).
## Installation
Install the gem and add to the application's Gemfile by executing:
```sh
$ bundle add ilios
```
If bundler is not being used to manage dependencies, install the gem by executing:
```sh
$ gem install ilios
```
This gem's installer will install the DataStax C/C++ Driver to the appropriate location automatically.
However, if you prefer to install the DataStax C/C++ Driver manually, you can do so by executing:
```sh
$ bundle config set --local build.ilios --with-libuv-dir=/path/to/libuv-installed-dir
$ bundle config set --local build.ilios --with-cassandra-driver-dir=/path/to/cassandra-cpp-driver-installed-dir
$ bundle add ilios
```
or
```sh
$ gem install ilios -- --with-libuv-dir=/path/to/libuv-installed-dir --with-cassandra-driver-dir=/path/to/cassandra-cpp-driver-installed-dir
```
## Requirements
- cmake (in order to build the DataStax C/C++ Driver and libuv)
- C/C++ compiler
- install_name_tool (macOS only)
## Supported
- Ruby 3.1 or later
- Cassandra 3.0 or later
- Linux and macOS platform
## Example
### Basic usage
Create the keyspace in advance using the `cqlsh` command.
```cql
CREATE KEYSPACE IF NOT EXISTS ilios
WITH REPLICATION = {
'class' : 'SimpleStrategy',
'replication_factor' : 1
};
```
Then, you can run the following code.
```ruby
require 'ilios'
cluster = Ilios::Cassandra::Cluster.new
cluster.keyspace('ilios')
cluster.hosts(['127.0.0.1'])
session = cluster.connect
# Create the table
statement = session.prepare(<<~CQL)
CREATE TABLE IF NOT EXISTS ilios.example (
id bigint,
message text,
created_at timestamp,
PRIMARY KEY (id)
) WITH compaction = { 'class' : 'LeveledCompactionStrategy' }
AND gc_grace_seconds = 691200;
CQL
session.execute(statement)
# Insert the records
statement = session.prepare(<<~CQL)
INSERT INTO ilios.example (
id,
message,
created_at
) VALUES (?, ?, ?)
CQL
100.times do |i|
statement.bind({
id: i,
message: 'Hello World',
created_at: Time.now,
})
session.execute(statement)
end
# Select the records
statement = session.prepare(<<~CQL)
SELECT * FROM ilios.example
CQL
statement.idempotent = true
statement.page_size = 25
result = session.execute(statement)
result.each do |row|
p row
end
while(result.next_page)
result.each do |row|
p row
end
end
```
### Synchronous API
`Ilios::Cassandra::Session#prepare` and `Ilios::Cassandra::Session#execute` are provided as synchronous API.
```ruby
statement = session.prepare(<<~CQL)
SELECT * FROM ilios.example
CQL
result = session.execute(statement)
```
### Asynchronous API
`Ilios::Cassandra::Session#prepare_async` and `Ilios::Cassandra::Session#execute_async` are provided as asynchronous API.
```ruby
prepare_future = session.prepare_async(<<~CQL)
INSERT INTO ilios.example (
id,
message,
created_at
) VALUES (?, ?, ?)
CQL
prepare_future.on_success { |statement|
futures = []
10.times do |i|
statement.bind({
id: i,
message: 'Hello World',
created_at: Time.now,
})
result_future = session.execute_async(statement)
result_future.on_success { |result|
p result
p "success"
}
result_future.on_failure {
p "fail"
}
futures << result_future
end
futures.each(&:await)
}
prepare_future.await
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Watson1978/ilios.