sqlftw

sqlftw

mysql (สำหรับตอนนี้) lexer, parser, รูปแบบภาษาและเครื่องวิเคราะห์แบบคงที่ที่เขียนใน PHP

มันเป็นตัวแยกวิเคราะห์ที่ตรวจสอบแล้วซึ่งสร้างวัตถุที่ใช้งานอินเตอร์เฟส SQLFTW SQL Interface สำหรับแต่ละคำสั่ง SQL ที่รองรับประมาณ 140 คำสั่ง คำสั่งทำแบบจำลองแง่มุมทางไวยากรณ์ของรหัส SQL ไม่ใช่แง่มุมของโดเมน (โมเดลวิธีการเขียนแบบสอบถาม) อย่างไรก็ตามไม่ได้ติดตามพื้นที่สีขาวและในปัจจุบันไม่สนใจความคิดเห็นบางอย่าง

ตัวแยกวิเคราะห์นี้มีจุดประสงค์เพื่อเป็นพื้นฐานสำหรับสองโครงการอื่น ๆ :

• หนึ่งกำลังทำการวิเคราะห์แบบคงที่ของรหัส SQL โดยเฉพาะอย่างยิ่งความปลอดภัยและประสิทธิภาพของการย้ายถิ่น (ปัจจุบันใช้ตัวแยกวิเคราะห์ SQL ขั้นพื้นฐานจากโครงการ phpmyadmin)
• หวังว่าอีกอย่างหนึ่งจะช่วย PHPSTAN (เครื่องมือวิเคราะห์แบบคงที่สำหรับ PHP) เข้าใจการสืบค้น SQL และผลลัพธ์ของพวกเขาได้ดีขึ้น

ด้วยตัวเองสามารถใช้เพื่อตรวจสอบไวยากรณ์ของรหัส SQL (เช่นการย้ายข้อมูล)

การสนับสนุนไวยากรณ์ SQL:

รองรับคำสั่ง SQL ทั้งหมดจาก MySQL 5.X ถึง MySQL 8.0.34 และคุณสมบัติภาษาเกือบทั้งหมด

ไม่รองรับคุณสมบัติที่จะล้มเหลวในการแยกวิเคราะห์:

• รองรับการเข้ารหัส multibyte ที่ไม่เข้ากัน ASCII-Conpatible เช่น shift-jis , gb18030 หรือ utf-16 (ไม่สามารถแยกวิเคราะห์ได้)
• ตัวคั่นที่ยกมา (ไม่ได้ดำเนินการอาจจะล้มเหลว)
• การเชื่อมต่อสตริงโดยปริยายของชื่อที่อ้างถึงสองครั้งในโหมด ANSI ( "foo" "bar" ; นี่คือการสนับสนุนในสตริง แต่ไม่ใช่ชื่อ)

คุณสมบัติที่ได้รับการยอมรับ แต่ไม่สนใจ (ไม่มีแบบจำลองและการทำให้เป็นอนุกรม):

• การแก้ไขลำดับความสำคัญของผู้ประกอบการในนิพจน์ (สำหรับผู้ดำเนินการในขณะนี้ของระดับเดียวกันนั้นเพิ่งแยกวิเคราะห์จากซ้ายไปขวา; จะถูกนำไปใช้ในภายหลัง)
• ความคิดเห็นปกติภายในข้อความ (ความคิดเห็นก่อนที่จะรวบรวมคำสั่ง)
• คุณสมบัติปลั๊กอิน Heatwave (Secondary_Engine)
• SELECT ... PROCEDURE ANALYSE (...) - ลบใน mysql 8
• WEIGHT_STRING(... LEVEL ...) - ลบใน mysql 8

ฟีเจอร์ใช้วิธีอื่นนอกเหนือจาก MySQL:

• Parser สร้างข้อผิดพลาดในความคิดเห็นที่ไม่ได้ยกเลิกการยกเลิกเช่นเดียวกับ PostgreSQL (MySQL เงียบและตามการทดสอบนี่อาจเป็นข้อผิดพลาด)
• Parser สร้างข้อผิดพลาดเมื่ออ่านตัวแปรผู้ใช้ที่มีชื่อไม่ถูก
• Parser สร้างข้อผิดพลาดเกี่ยวกับคำใบ้ของ Optimiz

สถาปัตยกรรม:

ชั้นหลัก:

• Lexer - Tokenizes SQL ส่งคืนเครื่องกำเนิดของ Tokens Parser
• Parser (S) - ตรวจสอบไวยากรณ์และส่งคืนเครื่องกำเนิดของวัตถุคำสั่งที่แยกวิเคราะห์
• คำสั่ง - คำสั่ง SQL แยกวิเคราะห์จากข้อความธรรมดาไปยังการแสดงวัตถุที่ไม่เปลี่ยนรูป สามารถทำให้เป็นอนุกรมกลับไปยังข้อความธรรมดา
• แพลตฟอร์ม - รายการคุณสมบัติที่รองรับโดยแพลตฟอร์มเฉพาะ
• Formatter - คำสั่ง SQL ที่กำหนดค่าได้ Serializer
• ตัววิเคราะห์ - กฎการวิเคราะห์แบบคงที่และเครื่องมือสำหรับพวกเขา

การใช้งานขั้นพื้นฐาน:

 <?php

use ...

$platform = Platform::get(Platform::MYSQL, '8.0'); // version defaults to x.x.99 when no patch number is given
$config = new ParserConfig($platform);
$session = new Session($platform);
$parser = new Parser($config, $session);

// returns a Generator. will not parse anything if you don't iterate over it
$commands = $parser->parse('SELECT foo FROM ...');
foreach ($commands as $command) {
    // Parser does not throw exceptions. this allows to parse partially invalid code and not fail on first error
    if ($command instanceof InvalidCommand) {
        $e = $command->getException();
        ...
    }
    ...
}

สถานะการพัฒนาปัจจุบัน:

ตอนนี้เราอยู่ที่ไหน:

• ☑ ~ 99.9% คุณสมบัติภาษา MySQL นำไปใช้
• ☑การทดสอบหน่วยพื้นฐานด้วยการทำให้เป็นอนุกรม
• ☑ทดสอบกับตารางและการอพยพหลายพันครั้ง
• ☑วิเคราะห์เกือบทุกอย่างจาก MySQL Test Suite (ไม่มีเชิงลบที่ผิดพลาด)
• ☑ล้มเหลวในการทดสอบข้อผิดพลาดเกือบทั้งหมดจาก MySQL Test Suite (ไม่มีข้อดีที่ผิดพลาด)
• ☑การทดสอบการทำให้เป็นอนุกรมในชุดทดสอบ MySQL (คุณสมบัติ SQL ทั้งหมดแสดงตามที่คาดไว้)
• ☐การทดสอบแบบขนานและอัตโนมัติกับชุดทดสอบ MySQL หลายรุ่น
• ☐การทดสอบการกลายพันธุ์ (การจัดการ SQL กลายพันธุ์เหมือนกับ DB จริง;
• ☐เวอร์ชันแพลตฟอร์มที่แตกต่าง (การแยกวิเคราะห์สำหรับเวอร์ชันแพตช์ที่แน่นอนของเซิร์ฟเวอร์ DB)
• ☐พอร์ตเครื่องมือวิเคราะห์การย้ายถิ่นของฉันไปยังห้องสมุดนี้
• ☐การเปิดตัวรุ่นแรกที่มีเสถียรภาพ?
• ☐แพลตฟอร์มอื่น ๆ (Mariadb, Sqlite, PostgreSQL ... )

เวอร์ชัน:

เราทุกคนรักการกำหนดเวอร์ชันความหมายใช่มั้ย -

แต่ห้องสมุดนี้เป็นกิจการที่ยิ่งใหญ่และยังคงผ่านขั้นตอนการพัฒนาเบื้องต้นอย่างรวดเร็ว ฉันตัดสินใจที่จะติดแท็กและปล่อยเวอร์ชันแม้ในขั้นตอนนี้เพราะฉันคิดว่ามันดีกว่าไม่มีอะไรดีกว่าการปล่อยรุ่นอัลฟ่าหลายสิบรุ่น ดังนั้น อย่าคาดหวังความเข้ากันได้ย้อนหลังจนกว่าเราจะออกจาก "0.1" การออกแบบระบบขนาดใหญ่ในการลองครั้งแรกเป็นไปไม่ได้แนวคิดจำนวนมากจะต้องตั้งถิ่นฐานและคลิกเข้าไปในสถานที่และดังนั้นการเปลี่ยนแปลงจำนวนมากยังคงมา

เมื่อใช้นักแต่งเพลงให้ล็อคการพึ่งพาของคุณในแพ็คเกจนี้เป็นเวอร์ชันที่แน่นอน เช่น sqlftw/sqlftw:0.1.14

ผู้เขียน:

Vlasta Neubauer, @paranoiq, https://github.com/paranoiq