full support for CHECK and FORIEGN KEY index conditions.

avoid some out of band reads

Author: iamcal

src/SQLParser.php

@@ -296,7 +296,7 @@ function parse_create_definition($tokens, &$i){
 		$fields = array();
 		$indexes = array();
 
-		while ($tokens[$i] != ')'){
+		while ($i < count($tokens) && $tokens[$i] != ')'){
 
 			$these_tokens = $this->slice_until_next_field($tokens, $i);
 
@@ -452,23 +452,54 @@ function parse_field_or_key(&$tokens, &$fields, &$indexes){
 				return;
 
 
-			# unsupported
+			# FOREIGN KEY [index_name] (index_col_name,...) reference_definition
+			#  reference_definition:
+			#    REFERENCES tbl_name (index_col_name,...)
+			#      [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE]
+			#      [ON DELETE reference_option]
+			#      [ON UPDATE reference_option]
 
 			case 'FOREIGN KEY':
 
-				# TODO
-				$fields[] = array(
-					'_'		=> 'FOREIGN KEY',
-					'tokens'	=> $tokens,
+				$index = array(
+					'type' => 'FOREIGN',
 				);
+
+				array_shift($tokens);
+
+				if ($tokens[0] != '('){
+					$index['name'] = $this->decode_identifier(array_shift($tokens));
+				}
+
+				$this->parse_index_columns($tokens, $index);
+
+				if ($tokens[0] == 'REFERENCES'){
+					array_shift($tokens);
+					$index['ref_table'] = $this->decode_identifier(array_shift($tokens));
+
+					$old_cols = $index['cols'];
+					$index['cols'] = array();
+					$this->parse_index_columns($tokens, $index);
+					$index['ref_cols'] = $index['cols'];
+					$index['cols'] = $old_cols;
+
+					if (count($tokens) >= 1 && $tokens[0] == 'MATCH FULL'   ){ $index['ref_match'] = 'FULL'   ; array_shift($tokens); }
+					if (count($tokens) >= 1 && $tokens[0] == 'MATCH PARTIAL'){ $index['ref_match'] = 'PARTIAL'; array_shift($tokens); }
+					if (count($tokens) >= 1 && $tokens[0] == 'MATCH SIMPLE' ){ $index['ref_match'] = 'SIMPLE' ; array_shift($tokens); }
+
+					if (count($tokens) > 1 && $tokens[0] == 'ON DELETE'){ array_shift($tokens); $index['ref_on_delete'] = array_shift($tokens); }
+					if (count($tokens) > 1 && $tokens[0] == 'ON UPDATE'){ array_shift($tokens); $index['ref_on_delete'] = array_shift($tokens); }
+				}
+
+				if (count($tokens)) $index['more'] = $tokens;
+				$indexes[] = $index;
 				return;
 
 			case 'CHECK':
 
-				# TODO
-				$fields[] = array(
-					'_'		=> 'CHECK',
-					'tokens'	=> $tokens,
+				$indexes[] = array(
+					'type'		=> 'CHECK',
+					'tokens'	=> array_slice($tokens, 1),
 				);
 				return;
 		}
@@ -481,7 +512,7 @@ function slice_until_next_field($tokens, &$i){
 		$out = array();
 		$stack = 0;
 
-		while ($i <= count($tokens)){
+		while ($i < count($tokens)){
 			$next = $tokens[$i];
 			if ($next == '('){
 				$stack++;
@@ -748,6 +779,14 @@ function _extract_tokens($sql, &$source_map){
 			'IF NOT EXISTS',
 			'NOT NULL',
 			'WITH PARSER',
+			'MATCH FULL',
+			'MATCH PARTIAL',
+			'MATCH SIMPLE',
+			'ON DELETE',
+			'ON UPDATE',
+			'SET NULL',
+			'NO ACTION',
+			'SET DEFAULT',
 		);
 
 		$singles = array(

tests/IndexTest.php

@@ -174,6 +174,41 @@ function testIndexOptions(){
 			$this->assertEquals($tbl['indexes'][0]['parser'], "foo");
 		}
 
+		function testForeignKeys(){
+
+			# [CONSTRAINT [symbol]] FOREIGN KEY [index_name] (index_col_name,...) reference_definition
+			#   reference_definition:
+			#    REFERENCES tbl_name (index_col_name,...)
+			#      [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE]
+			#      [ON DELETE reference_option]
+			#      [ON UPDATE reference_option]
+
+
+			$tbl = $this->get_first_table("CREATE TABLE foo (bar INT, FOREIGN KEY (bar) REFERENCES f_foo (f_bar) MATCH FULL ON DELETE SET NULL");
+			$this->assertEquals($tbl['indexes'][0]['type'], "FOREIGN");
+			$this->assertEquals($tbl['indexes'][0]['cols'], array(array("name" => "bar")));
+			$this->assertEquals($tbl['indexes'][0]['ref_table'], "f_foo");
+			$this->assertEquals($tbl['indexes'][0]['ref_cols'], array(array("name" => "f_bar")));
+			$this->assertEquals($tbl['indexes'][0]['ref_match'], "FULL");
+			$this->assertEquals($tbl['indexes'][0]['ref_on_delete'], "SET NULL");
+		}
+
+		function testChecks(){
+
+			# CHECK (expr)
+
+			# checks are not actually supported in MySQL, but can be defined.
+			# just extract the expression
+
+			$tbl = $this->get_first_table("CREATE TABLE foo (bar INT, CHECK (bar > 4)");
+			$this->assertEquals($tbl['indexes'][0]['type'], 'CHECK');
+			$this->assertEquals(count($tbl['indexes'][0]['tokens']), 5);
+
+			$tbl = $this->get_first_table("CREATE TABLE foo (bar INT, CHECK (bar > 2 AND (bar <> 5 OR bar=6))");
+			$this->assertEquals($tbl['indexes'][0]['type'], 'CHECK');
+			$this->assertEquals(count($tbl['indexes'][0]['tokens']), 16);
+		}
+
 		function get_first_table($str){
 			$obj = new iamcal\SQLParser();
 			$obj->parse($str);