Skip to content

Commit

Permalink
Add support for SQLite
Browse files Browse the repository at this point in the history
  • Loading branch information
dbackeus committed Jun 17, 2024
1 parent bbf7748 commit f91f017
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 74 deletions.
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@

# Optional:
# BASIC_AUTH_PASSWORD=<password>
# DB_ADAPTER=sqlite # defaults to postgres
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ FROM base
# libcurl required by typhoeus
# wget for talosctl installation
# curl is required for the heroku release command output
RUN apk add wget libc6-compat tzdata libcurl libpq curl
# sqlite-libs required by sqlite3 (only used if DB_ADAPTER=sqlite)
RUN apk add wget libc6-compat tzdata libcurl libpq curl sqlite-libs

COPY --from=gems /app /app
COPY --from=talosctl /usr/local/bin/talosctl /usr/local/bin/talosctl
Expand Down
5 changes: 4 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,24 @@ source "https://rubygems.org"

ruby "3.2.0"

# Keep dotenv at top to ensure ENV variables are loaded before other gems initialize
gem "dotenv", require: "dotenv/load", groups: %i[development test]

gem "bootsnap", require: false
gem "importmap-rails"
gem "net-ssh"
gem "pg"
gem "propshaft"
gem "puma"
gem "rails"
gem "sqlite3"
gem "stimulus-rails"
gem "turbo-rails"
gem "typhoeus"

group :development, :test do
# See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
gem "debug", platforms: %i[mri mingw x64_mingw]
gem "dotenv"
gem "rspec-rails"
end

Expand Down
2 changes: 2 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ GEM
rspec-mocks (~> 3.13)
rspec-support (~> 3.13)
rspec-support (3.13.1)
sqlite3 (1.6.8-arm64-darwin)
stimulus-rails (1.3.3)
railties (>= 6.0.0)
stringio (3.1.0)
Expand Down Expand Up @@ -250,6 +251,7 @@ DEPENDENCIES
puma
rails
rspec-rails
sqlite3
stimulus-rails
turbo-rails
typhoeus
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ docker push registry.heroku.com/<heroku-app-name>/web
heroku container:release web --app <heroku-app-name>
```

## Using SQLite instead of Postgres

Set `DB_ADAPTER=sqlite` and `config/database.yml` will be configured to use SQLite.

## Config Patch Examples

### Basic
Expand Down
86 changes: 18 additions & 68 deletions config/database.yml
Original file line number Diff line number Diff line change
@@ -1,86 +1,36 @@
# PostgreSQL. Versions 9.3 and up are supported.
#
# Install the pg driver:
# gem install pg
# On macOS with Homebrew:
# gem install pg -- --with-pg-config=/usr/local/bin/pg_config
# On macOS with MacPorts:
# gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
# On Windows:
# gem install pg
# Choose the win32 build.
# Install PostgreSQL and put its /bin directory on your path.
#
# Configure Using Gemfile
# gem "pg"
#
default: &default
<% if ENV["DB_ADAPTER"] == "sqlite" %>
adapter: sqlite3
timeout: 5000
<% else %>
adapter: postgresql
encoding: unicode
<% end %>
# For details on connection pooling, see Rails configuration guide
# https://guides.rubyonrails.org/configuring.html#database-pooling
pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
<<: *default
<% if ENV["DB_ADAPTER"] == "sqlite" %>
database: storage/development.sqlite3
<% else %>
database: talos_manager_development
<% end %>

# The specified database role being used to connect to postgres.
# To create additional roles in postgres see `$ createuser --help`.
# When left blank, postgres will use the default role. This is
# the same name as the operating system user running Rails.
#username: talos_manager

# The password associated with the postgres role (username).
#password:

# Connect on a TCP socket. Omitted by default since the client uses a
# domain socket that doesn't need configuration. Windows does not have
# domain sockets, so uncomment these lines.
#host: localhost

# The TCP port the server listens on. Defaults to 5432.
# If your server runs on a different port number, change accordingly.
#port: 5432

# Schema search path. The server defaults to $user,public
#schema_search_path: myapp,sharedapp,public

# Minimum log levels, in increasing order:
# debug5, debug4, debug3, debug2, debug1,
# log, notice, warning, error, fatal, and panic
# Defaults to warning.
#min_messages: notice

# Warning: The database defined as "test" will be erased and
# re-generated from your development database when you run "rake".
# Do not set this db to the same as development or production.
test:
<<: *default
<% if ENV["DB_ADAPTER"] == "sqlite" %>
database: storage/test.sqlite3
<% else %>
database: talos_manager_test
<% end %>

# As with config/credentials.yml, you never want to store sensitive information,
# like your database password, in your source code. If your source code is
# ever seen by anyone, they now have access to your database.
#
# Instead, provide the password or a full connection URL as an environment
# variable when you boot the app. For example:
#
# DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
#
# If the connection URL is provided in the special DATABASE_URL environment
# variable, Rails will automatically merge its configuration values on top of
# the values provided in this file. Alternatively, you can specify a connection
# URL environment variable explicitly:
#
# production:
# url: <%= ENV["MY_APP_DATABASE_URL"] %>
#
# Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
# for a full overview on how database connection configuration can be specified.
#
production:
<<: *default
<% if ENV["DB_ADAPTER"] == "sqlite" %>
database: storage/production.sqlite3
<% else %>
# NOTE: You should be relying on DATABASE_URL when using Postgres in production
database: talos_manager_production
username: talos_manager
password: <%= ENV["talos_manager_DATABASE_PASSWORD"] %>
<% end %>
5 changes: 1 addition & 4 deletions db/schema.rb

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f91f017

Please sign in to comment.