libsql-ruby

KO | EN

gitlite — search

#javascript #react #ai #go #android #machine-learning #rust #linux #nodejs #java #cli #awesome-list #security #open-source

(★ 29)

Ruby bindings for libSQL

libsql-ruby Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a href="https://tur.so/turso-ruby">
 <picture>
 <img src="/.github/cover.png" alt="libSQL Ruby" />
 </picture>
 </a>
 <h1 align="center">libSQL Ruby</h1>

Databases for Ruby multi-tenant AI Apps.

<a href="https://tur.so/turso-ruby">Turso</a> ·
 <a href="https://docs.turso.tech">Docs</a> ·
 <a href="https://turso.tech/blog">Blog &amp; Tutorials</a>

## Features

- 🔌 Works offline with [Embedded Replicas](https://docs.turso.tech/features/embedded-replicas/introduction)
- 🌎 Works with remote Turso databases
- ✨ Works with Turso [AI & Vector Search](https://docs.turso.tech/features/ai-and-embeddings)

> [!WARNING]
> This SDK is currently in technical preview. <a href="https://tur.so/discord-ruby">Join us in Discord</a> to report any issues.

## Install

```bash
gem install turso_libsql
```

## Quickstart

The example below uses Embedded Replicas and syncs data every 1000ms from Turso.

```rb
require_relative 'turso_libsql'

db =
  Libsql::Database.new(
    path: 'local.db',
    url: ENV['TURSO_DATABASE_URL'],
    auth_token: ENV['TURSO_AUTH_TOKEN'],
    sync_interval: 1000
  )

db.sync

db.connect do |conn|
 conn.execute_batch <<-SQL
 CREATE TABLE IF NOT EXISTS users (
 id INTEGER PRIMARY KEY AUTOINCREMENT,
 name TEXT
 );
 INSERT INTO users (name) VALUES ('Iku');
 SQL

rows = conn.query 'SELECT * FROM users'
  print "Users: #{rows.to_a}\n"
  rows.close
end
```

## Examples

| Example                                  | Description                                                                             |
| ---------------------------------------- | --------------------------------------------------------------------------------------- |
| [local](examples/local.rb)               | Uses libsql with a local SQLite file. Creates database, inserts data, and queries.      |
| [remote](examples/remote.rb)             | Connects to a remote database. Requires environment variables for URL and auth token.   |
| [sync](examples/sync.rb)                 | Demonstrates synchronization between local and remote databases.                        |
| [transactions](examples/transactions.rb) | Shows transaction usage: starting, performing operations, and committing/rolling back.  |
| [memory](examples/memory.rb)             | Uses an in-memory SQLite database for temporary storage or fast access.                 |
| [vector](examples/vector.rb)             | Works with vector embeddings, storing and querying for similarity search.               |
| [encryption](examples/encryption.rb)     | Creates and uses an encrypted SQLite database, demonstrating setup and data operations. |

## Documentation

Visit our [official documentation](https://docs.turso.tech).

## Support

Join us [on Discord](https://tur.so/discord-ruby) to get help using this SDK. Report security issues [via email](mailto:security@turso.tech).

## Contributors

See the [contributing guide](CONTRIBUTING.md) to learn how to get involved.

![Contributors](https://contrib.nn.ci/api?repo=tursodatabase/libsql-ruby)

libsql-ruby

libsql-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

libsql-ruby

libsql-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README