ดาวน์โหลด squabble - ดาวน์โหลดซอร์สโค้ด squabble

squabble

หมวดหมู่อื่นๆ

v1.4.0

ดาวน์โหลด

การทะเลาะกัน

จับการอพยพ SQL ที่ไม่ปลอดภัย

$ squabble sql/migration.sql
sql/migration.sql:4:46 ERROR: column "uh_oh" has a disallowed constraint [1004]
ALTER TABLE big_table ADD COLUMN uh_oh integer DEFAULT 0;
                                               ^
# Use --explain to get more information on a lint violation
$ squabble --explain 1004
ConstraintNotAllowed
     When adding a column to an existing table, certain constraints can have
     unintentional side effects, like locking the table or introducing
     performance issues.
     ...

การทะเลาะกันสามารถรวมเข้ากับตัวแก้ไขของคุณเพื่อจับข้อผิดพลาดในไฟล์ SQL

$ echo ' SELECT * FROM WHERE x = y; ' | squabble --reporter=plain
stdin:1:15 CRITICAL: syntax error at or near "WHERE"

ปัจจุบันกฎส่วนใหญ่มุ่งเน้นไปที่ postgres และนิสัยใจคอ อย่างไรก็ตามการทะเลาะกันสามารถแยกวิเคราะห์ ANSI SQL และกฎใหม่ที่เฉพาะเจาะจงกับฐานข้อมูลอื่น ๆ ได้รับการชื่นชม!

การติดตั้ง

$ pip3 install squabble
$ squabble --help

บันทึก

การทะเลาะกันเท่านั้นที่รองรับใน Python 3.5+

หากคุณต้องการติดตั้งจากแหล่งที่มา:

$ git clone https://github.com/erik/squabble.git && cd squabble
$ python3 -m venv ve && source ve/bin/activate
$ python setup.py install
$ squabble --help

การกำหนดค่า

หากต้องการดูรายการกฎลอง

$ squabble --list-rules

จากนั้นเพื่อแสดงข้อมูล verbose เพิ่มเติมเกี่ยวกับกฎ (เช่นตัวเลือกเหตุผลและการกำหนดค่า)

$ squabble --show-rule AddColumnDisallowConstraints

เมื่อมีการกำหนดค่าไฟล์แล้วจะสามารถส่งผ่านได้อย่างชัดเจนบนบรรทัดคำสั่งหรือค้นหาโดยอัตโนมัติ

$ squabble -c path/to/config ...

หากไม่ได้รับอย่างชัดเจนในบรรทัดคำสั่งการทะเลาะกันจะมองหาไฟล์ชื่อ .squabblerc ในสถานที่ต่อไปนี้ (ตามลำดับ):

./.squabblerc
(git_repo_root)/.squabblerc
~/.squabblerc

การกำหนดค่าต่อไฟล์

การกำหนดค่ายังสามารถนำไปใช้ในระดับไฟล์โดยใช้ความคิดเห็นของ SQL Line ในรูปแบบ -- squabble-enable:RuleName หรือ -- squabble-disable:RuleName

ตัวอย่างเช่นเพื่อปิดการใช้งาน RuleA และเปิดใช้งาน RuleB เพียงไฟล์เดียวสิ่งนี้สามารถทำได้:

 -- squabble-disable:RuleA
-- squabble-enable:RuleB config=value array=1,2,3
SELECT email FROM users WHERE ...;

เพื่อป้องกันการทะเลาะกันจากการรันในไฟล์ให้ใช้ -- squabble-disable โปรดทราบว่าสิ่งนี้จะปิดใช้งานการตรวจสอบไวยากรณ์ โปรดทราบว่าการตั้งค่าสถานะนี้จะมีความสำคัญกว่าชุดการกำหนดค่าอื่น ๆ ทั้งในบรรทัดคำสั่งหรือในส่วนที่เหลือของไฟล์

การกำหนดค่าตัวอย่าง

{
  "reporter" : " color " ,

  "plugins" : [
    " /some/directory/with/custom/rules "
  ],

  "rules" : {
    "AddColumnsDisallowConstraints" : {
      "disallowed" : [ " DEFAULT " , " FOREIGN " , " NOT NULL " ]
    }
  }
}

ศิลปะก่อนหน้านี้

แน่นอนว่า squabble ไม่ใช่เครื่องมือแรกในพื้นที่นี้ หากไม่ตรงกับความต้องการของคุณให้พิจารณาเครื่องมือเหล่านี้:

SQLCHECK - การแสดงออกปกติ (แทนที่จะแยกวิเคราะห์) มุ่งเน้นไปที่คำสั่ง SELECT มากกว่าการย้ายถิ่น
SQLINT - ตรวจสอบว่าไวยากรณ์ของไฟล์นั้นถูกต้อง ใช้ห้องสมุดการแยกวิเคราะห์เช่นเดียวกับการทะเลาะกัน
SQLFLUFF - มุ่งเน้นไปที่สไตล์และการจัดรูปแบบมากขึ้นดูเหมือนว่าจะยังคงเป็นงานที่กำลังดำเนินอยู่