DbSchema::Reader::Postgres

DbSchema::Reader::Postgres is a library for reading the database structure from PostgreSQL.

Add this line to your application's Gemfile:

gem 'db_schema-reader-postgres'

And then execute:

$ bundle

Or install it yourself as:

$ gem install db_schema-reader-postgres

First you need a Sequel connection object with :pg_enum and :pg_array Sequel extensions enabled; once you have that object just pass it to DbSchema::Reader::Postgres.new to construct the reader:

connection = Sequel.connect(adapter: 'postgres', database: 'db_schema_test').tap do |db|
  db.extension :pg_enum
  db.extension :pg_array
end

reader = DbSchema::Reader::Postgres.new(connection)

You can call #read_schema to get the full database schema definition:

reader.read_schema
# => #<DbSchema::Definitions::Schema ...>

Other useful methods are #read_tables, #read_enums & #read_extensions; they return definitions of respective parts of the database schema:

reader.read_tables
# => [#<DbSchema::Definitions::Table ...>, #<DbSchema::Definitions::Table ...>, ...]

reader.read_enums
# => [#<DbSchema::Definitions::Enum ...>, #<DbSchema::Definitions::Enum ...>, ...]

reader.read_extensions
# => [#<DbSchema::Definitions::Extension ...>, #<DbSchema::Definitions::Extension ...>, ...]

DbSchema::Reader::Postgres emits objects of classes from DbSchema::Definitions. Read here how to analyze the schema and all of it's parts.

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Bug reports and pull requests are welcome on GitHub at db-schema/reader-postgres. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

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

Everyone interacting in the DbSchema::Definitions project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.