Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.turso.tech/llms.txt

Use this file to discover all available pages before exploring further.

This is currently in technical preview. Join us in Discord to report any issues.
In this Ruby quickstart we will learn how to:
  • Retrieve database credentials
  • Install the libSQL package
  • Connect to a local or remote Turso database
  • Execute a query using SQL
  • Sync changes to local database (optional)
1

Retrieve database credentials

You will need an existing database to continue. If you don’t have one, create one.Get the database URL:
turso db show --url <database-name>
Get the database authentication token:
turso db tokens create <database-name>
Assign credentials to the environment variables inside .env.
TURSO_DATABASE_URL=
TURSO_AUTH_TOKEN=
You will want to make sure to handle database tokens securely.
2

Install

Inside your Ruby project, install the following Rubygem:
bundle add turso_libsql
3

Connect

require 'turso_libsql'

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

require 'turso_libsql'

db = Libsql::Database.new(path: 'local.db')

require 'turso_libsql'

db = Libsql::Database.new(
  url: ENV['TURSO_DATABASE_URL'],
  auth_token: ENV['TURSO_AUTH_TOKEN']
)
4

Execute

You can execute a SQL query against your existing database by preparing a statement and then executing it:
db.connect do |conn|
  rows = conn.query 'SELECT * FROM users'
  rows.close
end
If you need to use placeholders for values, you can do that:
name = 'Iku'
rows = conn.execute 'INSERT INTO users (id) VALUES (?)', [name]
5

Sync (Embedded Replicas only)

When using embedded replicas, you should call sync on the database to sync your local database with the primary database, unless you are using sync_interval (though there is no issue with calling sync with sync_interval enabled):
db.sync