Balkan Ruby 2024 — How and why to run SQLite on Rails in production

Slide 1

Slide 1 text

Stephen Margheim · 27 April 2024 SQLite on Rails How (and why) to run SQLite in production Balkan Ruby

Slide 2

Slide 2 text

Who am I? Stephen Margheim · @fractaledmind 🇺🇸 🛫 🇩🇪 💒 🇩🇰 📍 🇯🇲 💕 🐶🐕

Slide 3

Slide 3 text

Who am I? • Head of Engineering at Test IO • Open source developer rails/rails sparklemotion/sqlite3-ruby oldmoe/litestack joeldrapper/phlex joeldrapper/literal fractaledmind/activerecord-enhancedsqlite3-adapter fractaledmind/litestream-ruby fractaledmind/acidic_job • Writer: https://fractaledmind.github.io Stephen Margheim · @fractaledmind 🇺🇸 🛫 🇩🇪 💒 🇩🇰 📍 🇯🇲 💕 🐶🐕

Slide 4

Slide 4 text

rails new . --database=sqlite3 --asset-pipeline=propshaft --javascript=esbuild --css=tailwind --skip-jbuilder --skip-spring

Slide 5

Slide 5 text

$ rails new . --database=sqlite3 --asset-pipeline=propshaft --javascript=esbuild --css=tailwind --skip-jbuilder --skip-spring

Slide 6

Slide 6 text

Why?

Slide 7

Slide 7 text

Why not?

Slide 8

Slide 8 text

Linear Writes

Slide 9

Slide 9 text

No content

Slide 10

Slide 10 text

Why?

Slide 11

Slide 11 text

No content

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

No content

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

Simplicity

Slide 17

Slide 17 text

Simplicity Control

Slide 18

Slide 18 text

Simplicity Control Speed

Slide 19

Slide 19 text

Why?

Slide 20

Slide 20 text

No content

Slide 21

Slide 21 text

How?

Slide 22

Slide 22 text

Running SQLite on Rails out-of-the-box isn’t viable today.

Slide 23

Slide 23 text

$ bundle add activerecord-enhancedsqlite3-adapter $ bundle add litestream $ rails generate litestream:install

Slide 24

Slide 24 text

Thank you

Slide 25

Slide 25 text

$ bundle add activerecord-enhancedsqlite3-adapter $ bundle add litestream $ rails generate litestream:install

Slide 26

Slide 26 text

Performance

Slide 27

Slide 27 text

1. Write-Ahead-Logging journal mode 2. IMMEDIATE transactions 3. non-GVL-blocking timeout mechanism 4. fair retry interval 5. isolated connection pools for reading and writing

Slide 28

Slide 28 text

$ bundle add activerecord-enhancedsqlite3-adapter https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter

Slide 29

Slide 29 text

config.enhanced_sqlite3.isolate_connection_pools = true

Slide 30

Slide 30 text

Performance 👍

Slide 31

Slide 31 text

Resilience

Slide 32

Slide 32 text

https://litestream.io

Slide 33

Slide 33 text

$ bundle add litestream $ bin/rails generate litestream:install https://github.com/fractaledmind/litestream-ruby

Slide 34

Slide 34 text

# config/litestream.yml dbs: - path: storage/production.sqlite3 replicas: - type: s3 bucket: $LITESTREAM_REPLICA_BUCKET path: storage/production.sqlite3 access-key-id: $LITESTREAM_ACCESS_KEY_ID secret-access-key: $LITESTREAM_SECRET_ACCESS_KEY

Slide 35

Slide 35 text

# config/initializers/litestream.rb Litestream.configure do |config| creds = Rails.application.credentials.litestream config.replica_bucket = creds.replica_bucket config.replica_key_id = creds.replica_key_id config.replica_access_key = creds.replica_access_key end

Slide 36

Slide 36 text

$ bin/rails litestream:replicate

Slide 37

Slide 37 text

$ bin/rails litestream:restore -- \ —database=storage/production.sqlite3

Slide 38

Slide 38 text

$ bin/rails litestream:verify -- \ —database=storage/production.sqlite3 size original 21688320 restored 21688320 delta 0 tables original 9 restored 9 delta 0

Slide 39

Slide 39 text

No content

Slide 40

Slide 40 text

$ bundle add litestream_rails # config/routes.rb mount LitestreamRails::Engine => "/litestream" https://github.com/fractaledmind/litestream_rails

Slide 41

Slide 41 text

Resilience 👍

Slide 42

Slide 42 text

Enhancements

Slide 43

Slide 43 text

• deferred foreign keys, • generated columns, • returning values from inserts, • PRAGMA tuning, • extension loading, and • improved concurrency support $ bundle add activerecord-enhancedsqlite3-adapter

Slide 44

Slide 44 text

add_reference :person, :alias, foreign_key: { deferrable: :deferred } add_reference :alias, :person, foreign_key: { deferrable: :deferred }

Slide 45

Slide 45 text

create_table :virtual_columns, force: true do |t| t.string :name t.virtual :upper_name, type: :string, as: "UPPER(name)", stored: true t.virtual :lower_name, type: :string, as: "LOWER(name)", stored: false t.virtual :octet_name, type: :integer, as: "LENGTH(name)" end

Slide 46

Slide 46 text

Post.insert({ title: Faker::Lorem.sentence, description: Faker::Lorem.paragraphs.join("\n"), created_at: Faker::Time.forward(days: 23) }, returning: [ :id, :created_at ])

Slide 47

Slide 47 text

default: &default adapter: sqlite3 pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> timeout: 5000 pragmas: temp_store: MEMORY

Slide 48

Slide 48 text

$ bundle add sqlite-vss # /config/database.yml default: &default adapter: sqlite3 pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> timeout: 5000 extensions: - sqlite_vss

Slide 49

Slide 49 text

• Active Record (e.g. PostgreSQL, MySQL) • Solid Cache (e.g. Redis, Memcached) • Solid Queue (e.g. Sidekiq, Goodjob) • Solid Cable* (e.g. Redis, PostgreSQL)

Slide 50

Slide 50 text

$ bundle config set build.sqlite3 \ "--with-sqlite-cflags=' -DSQLITE_DQS=0 -DSQLITE_THREADSAFE=0 -DSQLITE_DEFAULT_MEMSTATUS=0 -DSQLITE_LIKE_DOESNT_MATCH_BLOBS -DSQLITE_MAX_EXPR_DEPTH=0 -DSQLITE_OMIT_SHARED_CACHE -DSQLITE_USE_ALLOCA'"

Slide 51

Slide 51 text

# /config/database.yml development: <<: *default database: storage/<%= `git branch --show-current`.chomp || 'development' %>.sqlite3 # /config/environments/development.rb config.after_initialize do ActiveRecord::Tasks::DatabaseTasks.prepare_all end