carrierwave-postgresql-table

carrierwave-postgresql-table

A PostgreSQL storage adapter for CarrierWave. Files are stored as PostgreSQL large objects.

This gem is similar to carrierwave-postgresql, but differs in how it stores file metadata. This gem uses an extra table to store additional file metadata, allowing it to support multiple CarrierWave versions on a single uploader.

Installation

Add this line to your application's Gemfile:

gem "carrierwave-postgresql-table"

Compatibility

carrierwave-postgresql-table is tested against the following versions of CarrierWave, Rails, and Ruby:

• CarrierWave 0.11, 1.0, 1.1, 1.2
• Rails 4.2, 5.0, 5.1, 5.2
• Ruby 2.2, 2.3, 2.4, 2.5

Usage

Generate the table to store the file uploads:

$ rails generate carrierwave_postgresql_table:migration
$ rake db:migrate

Adjust your uploader to use the postgresql_table storage adapter:

class AvatarUploader < CarrierWave::Uploader::Base
  storage :postgresql_table

  def store_dir
    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
  end
end

An optional Rack application is available to provide an endpoint that will stream your files from PostgreSQL. To enable this endpoint, you can mount it in your config/routes.rb file:

Rails.application.routes.draw do
  mount CarrierWave::PostgresqlTable::RackApp.new => "/uploads"
end

The Rack application can also be combined with other routing functionality. For example, to limit uploads to authenticated users when used with Devise:

Rails.application.routes.draw do
  authenticate :user do
    mount CarrierWave::PostgresqlTable::RackApp.new => "/uploads"
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/GUI/carrierwave-postgresql-table.

Acknowledgments

Hat tip to the people behind carrierwave-postgresql and refile-postgres, which this code is based on.

License

The gem is available as open source under the terms of the MIT License.