Turso Quickstart (Ruby)

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=

Inside your Ruby project, install the following Rubygem:

gem install turso_libsql

You must first initialize libSQL, create a libsql_database_t object, and then open a libsql_connection_t to it:

require_relative 'turso_libsql'

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

require_relative 'turso_libsql'

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

require_relative 'turso_libsql'

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

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:

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