Menu
Squawk LogoSquawk LogoSquawkDocsRules
Quick StartGitHub
Squawk LogoSquawk LogoSquawk
  • Docs
  • Rules
  • Quick Start
  • GitHub
  • General
    • Quick Start
    • Applying migrations safely
    • CLI
    • GitHub Integration
    • Web Frameworks
    • Postgres locks and further reading
    • Troubleshooting
  • Rules
    • Rules Overview
    • adding-field-with-default
    • adding-foreign-key-constraint
    • adding-not-nullable-field
    • adding-serial-primary-key-field
    • ban-char-field
    • ban-drop-database
    • changing-column-type
    • constraint-missing-not-valid
    • disallowed-unique-constraint
    • prefer-robust-stmts
    • prefer-text-field
    • renaming-column
    • renaming-table
    • require-concurrent-index-creation
    • require-concurrent-index-deletion

Rules Overview

Squawk's rules focus on ensuring safe migrations and warn about statements that could block reads / writes or break existing clients. See the sidebar for documentation for each rule.

The rule docs should provide actionable, user friendly error messages. If you find a rule, error message, or docs page lacking, please open an issue.

Reminder

Read "Running Migrations to learn about safely applying migrations after linting.

index#

  • rules
  • adding-field-with-default
  • adding-foreign-key-constraint
  • adding-not-nullable-field
  • adding-serial-primary-key-field
  • ban-char-field
  • ban-drop-database
  • changing-column-type
  • constraint-missing-not-valid
  • disallowed-unique-constraint
  • prefer-robust-stmts
  • prefer-text-field
  • renaming-column
  • renaming-table
  • require-concurrent-index-creation
  • require-concurrent-index-deletion
Edit this page
Previous
« Troubleshooting
Next
adding-field-with-default »
  • index

Docs

  • Quick Start
  • Rules

More

  • GitHub
  • Changelog
  • Help
Copyright © 2022 Squawk Authors.