https://github.com/covermymeds/sql_footprint
A Ruby gem that keeps a footprint of your sql queries that you can check into source control.
https://github.com/covermymeds/sql_footprint
database footprint sql usage
Last synced: about 1 year ago
JSON representation
A Ruby gem that keeps a footprint of your sql queries that you can check into source control.
- Host: GitHub
- URL: https://github.com/covermymeds/sql_footprint
- Owner: covermymeds
- Created: 2016-03-18T05:15:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-11-01T19:38:29.000Z (over 2 years ago)
- Last Synced: 2025-05-24T08:51:35.274Z (about 1 year ago)
- Topics: database, footprint, sql, usage
- Language: Ruby
- Homepage:
- Size: 71.3 KB
- Stars: 12
- Watchers: 32
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
Awesome Lists containing this project
README
# SqlFootprint [](https://travis-ci.org/covermymeds/sql_footprint)
This gem allows you to keep a "footprint" of the sql queries that your application runs.
It's like logging all the sql you're executing except that we remove all the value parameters
and dedupe similar queries. This footprint should be valuable in determining if changes you've
made will significantly change the way you're querying the database.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'sql_footprint', group: [:development, :test]
```
And then execute:
$ bundle
## Usage
Typically, you would want to run this while you're running your specs.
For example w/ RSpec:
```ruby
RSpec.configure do |config|
config.before(:suite) { SqlFootprint.start }
config.after(:suite) { SqlFootprint.stop }
end
```
Minitest (in `test_helper.rb`) add the following:
```ruby
SqlFootprint.start
Minitest.after_run { SqlFootprint.stop }
```
You can also add a Custom rule to SqlAnonymizer before running `start`:
```ruby
RSpec.configure do |config|
SqlFootprint::SqlAnonymizer.add_rule(/SELECT (.+) AS (.+)/, 'SELECT [redacted] AS [redacted]')
config.before(:suite) { SqlFootprint.start }
config.after(:suite) { SqlFootprint.stop }
end
```
#### Outputs
After running your specs you'll find a 'footprint.*.sql' file in your project.
Footprints are per-database. For example, if you're using DB1 AND DB2 in your app, you would end up with two footprint files. (footprint.db1.sql, footprint.db2.sql)
If you're using an in-memory database, you'll end up with `footprint.:memory:.sql`.
#### Excluding Setup Code
If you want to exclude queries that your tests generate for fixture data, you can use the ```.exclude``` method. For example:
```ruby
before do
SqlFootprint.exclude do
Model.create!(args*) # this query will not be included in your footprint
end
end
```
Or if you're using FactoryBot you could do something like this:
```ruby
RSpec.configure do |config|
module FactoryKid
def create(*args)
SqlFootprint.exclude { FactoryBot.create(*args) }
end
end
config.include FactoryKid
end
```
## Compatibility
- For Rails < 6.0 compatibility, please use v2.0.1.
- For Rails >= 6.0 compatibility, please use v3.0.0.
- For Rails >= 7.0, please use v3.0.1
DO NOT run SqlFootprint in production!