Ruby binding for chDB

Overview

Quick start

gem install chdb-ruby

require'chdb'# Open a database# Parameter explanation:# 1. path supports two formats:#    - ":memory:" in-memory temporary database (data destroyed on close)#    - "file:/path/to/db" file-based persistent database#    Configuration parameters can be appended via URL-style query (e.g. 'file:test.db?results_as_hash=true')# 2. options hash supports:#    - results_as_hash: controls whether result sets return as hashes (default: arrays)db=ChDB::Database.new('file:test.db',results_as_hash:true)# Create a databasedb.execute('CREATE DATABASE IF NOT EXISTS test')# Create a tabledb.execute('DROP TABLE IF EXISTS test.test_table')rows=db.execute<<-SQL  CREATE TABLE test.test_table(    id Int32,    name String)    ENGINE = MergeTree()    ORDER BY idSQL# Execute a few inserts{1=>'Alice',2=>'Bob'}.eachdo |pair|db.execute'INSERT INTO test.test_table VALUES ( ?, ? )',pairend# Find a few rowsdb.execute('SELECT * FROM test.test_table ORDER BY id')do |row|prowend# [{ 'id' => '1', 'name' => 'Alice' },#  { 'id' => '2', 'name' => 'Bob' }]# When you need to open another database, you must first close the previous databasedb.close()# Open another databasedb=ChDB::Database.new'file:test.db'# Create another tabledb.execute('DROP TABLE IF EXISTS test.test2_table')rows=db.execute<<-SQL  CREATE TABLE test.test2_table(    id Int32,    name String)    ENGINE = MergeTree()    ORDER BY idSQL# Execute inserts with parameter markersdb.execute('INSERT INTO test.test2_table (id, name)            VALUES (?, ?)',[3,'Charlie'])# Find rows with the first row displaying column namesdb.execute2('SELECT * FROM test.test2_table')do |row|prowend# ["id", "name"]# ["3", "Charlie"]# Close the databasedb.close()# Use ChDB::Database.open to automatically close the database connection:ChDB::Database.open('file:test.db')do |db|result=db.execute('SELECT 1')presult.to_a# => [["1"]]end# Query with specific output formats (CSV, JSON, etc.):# See more details at https://clickhouse.com/docs/interfaces/formats.ChDB::Database.open(':memory:')do |db|csv_data=db.query_with_format('SELECT 1 as a, 2 as b','CSV')pcsv_data# "1,2\n"json_data=db.query_with_format('SELECT 1 as a, 2 as b','JSON')pjson_dataend# Execute streaming queryChDB::Database.open(':memory:')do |db|total_rows=0collected=[]db.send_query('SELECT * FROM numbers(200000)')do |chunk|collected <<chunk.buftotal_rows +=chunk.rows_readendptotal_rows# => 200000end

Thread Safety

require'chdb'db=ChDB::Database.new':memory:'latch=Queue.newts=10.times.map{Thread.new{latch.popdb.execute'SELECT 1'}}10.times{latch <<nil}pts.map(&:value)# [[["1"]], [["1"]], [["1"]], [["1"]], [["1"]], [["1"]], [["1"]], [["1"]], [["1"]], [["1"]]]db.close()

Support

Installation

Bug reports

License

Acknowledgments