Added additional analyzer hooks for integrators

Author: Hydrocharged

sql/analyzer/analyzer.go

@@ -79,9 +79,12 @@ type Builder struct {
 // NewBuilder creates a new Builder from a specific catalog.
 // This builder allow us add custom Rules and modify some internal properties.
 func NewBuilder(pro sql.DatabaseProvider) *Builder {
+	allBeforeDefault := make([]Rule, len(OnceBeforeDefault)+len(AlwaysBeforeDefault))
+	copy(allBeforeDefault, OnceBeforeDefault)
+	copy(allBeforeDefault[len(OnceBeforeDefault):], AlwaysBeforeDefault)
 	return &Builder{
 		provider:        pro,
-		onceBeforeRules: OnceBeforeDefault,
+		onceBeforeRules: allBeforeDefault,
 		defaultRules:    DefaultRules,
 		onceAfterRules:  OnceAfterDefault,
 		validationRules: DefaultValidationRules,

sql/analyzer/node_batches.go

@@ -16,6 +16,11 @@ func getBatchesForNode(n sql.Node, orig []*Batch) ([]*Batch, bool) {
 	case *plan.InsertInto:
 		if n.LiteralValueSource {
 			return []*Batch{
+				{
+					Desc:       "alwaysBeforeDefault",
+					Iterations: 1,
+					Rules:      AlwaysBeforeDefault,
+				},
 				{
 					Desc:       "simpleInsert",
 					Iterations: 1,
@@ -48,6 +53,11 @@ func getBatchesForNode(n sql.Node, orig []*Batch) ([]*Batch, bool) {
 	case *plan.Update:
 		if n.HasSingleRel && !n.IsJoin {
 			return []*Batch{
+				{
+					Desc:       "alwaysBeforeDefault",
+					Iterations: 1,
+					Rules:      AlwaysBeforeDefault,
+				},
 				{
 					Desc:       "simpleUpdate",
 					Iterations: 1,
@@ -88,6 +98,11 @@ func getBatchesForNode(n sql.Node, orig []*Batch) ([]*Batch, bool) {
 	case *plan.DeleteFrom:
 		if !n.HasExplicitTargets() && n.RefsSingleRel {
 			return []*Batch{
+				{
+					Desc:       "alwaysBeforeDefault",
+					Iterations: 1,
+					Rules:      AlwaysBeforeDefault,
+				},
 				{
 					Desc:       "simpleDelete",
 					Iterations: 1,

sql/analyzer/rule_ids.go

@@ -41,7 +41,7 @@ const (
 	resolveTableFunctionsId                      // resolveTableFunctions
 	resolveDeclarationsId                        // resolveDeclarations
 	resolveColumnDefaultsId                      // resolveColumnDefaults
-	validateColumnDefaultsId                     // validateColumnDefaults
+	ValidateColumnDefaultsId                     // validateColumnDefaults
 	validateCreateTriggerId                      // validateCreateTrigger
 	validateCreateProcedureId                    // validateCreateProcedure
 	resolveCreateProcedureId                     // resolveCreateProcedure
@@ -128,7 +128,7 @@ const (
 	validateGroupById           // validateGroupBy
 	validateSchemaSourceId      // validateSchemaSource
 	validateIndexCreationId     // validateIndexCreation
-	validateOperandsId          // validateOperands
+	ValidateOperandsId          // validateOperands
 	validateCaseResultTypesId   // validateCaseResultTypes
 	validateIntervalUsageId     // validateIntervalUsage
 	validateExplodeUsageId      // validateExplodeUsage

sql/analyzer/ruleid_string.go

@@ -54,7 +54,7 @@ var OnceBeforeDefault = []Rule{
 	{resolveUnionsId, resolveUnions},
 	{resolveDescribeQueryId, resolveDescribeQuery}, //TODO
 	{validateCreateTriggerId, validateCreateTrigger},
-	{validateColumnDefaultsId, validateColumnDefaults},
+	{ValidateColumnDefaultsId, validateColumnDefaults},
 	{validateReadOnlyDatabaseId, validateReadOnlyDatabase},
 	{validateReadOnlyTransactionId, validateReadOnlyTransaction},
 	{validateDatabaseSetId, validateDatabaseSet},
@@ -65,6 +65,12 @@ var OnceBeforeDefault = []Rule{
 	{hoistOutOfScopeFiltersId, hoistOutOfScopeFilters},
 }
 
+// AlwaysBeforeDefault contains the rules to be applied just once before the
+// DefaultRules. These are an extension of the OnceBeforeDefault rules that
+// will always apply to nodes, unlike the OnceBeforeDefault rules that may
+// be excluded depending on the node. This is only used by integrators.
+var AlwaysBeforeDefault []Rule
+
 // DefaultRules to apply when analyzing nodes.
 var DefaultRules = []Rule{
 	{validateStarExpressionsId, validateStarExpressions}, //TODO
@@ -105,7 +111,7 @@ var DefaultValidationRules = []Rule{
 	{validateGroupById, validateGroupBy},
 	{validateSchemaSourceId, validateSchemaSource},
 	{validateIndexCreationId, validateIndexCreation},
-	{validateOperandsId, validateOperands},
+	{ValidateOperandsId, validateOperands},
 	{validateIntervalUsageId, validateIntervalUsage},
 	{validateSubqueryColumnsId, validateSubqueryColumns},
 	{validateUnionSchemasMatchId, validateUnionSchemasMatch},

sql/analyzer/rules.go

@@ -483,7 +483,7 @@ func TestValidateOperands(t *testing.T) {
 		},
 	}
 
-	rule := getValidationRule(validateOperandsId)
+	rule := getValidationRule(ValidateOperandsId)
 	for _, tt := range testCases {
 		t.Run(tt.name, func(t *testing.T) {
 			require := require.New(t)

sql/analyzer/validation_rules_test.go

@@ -110,8 +110,14 @@ func IsSigned(t sql.Type) bool {
 
 // IsText checks if t is a CHAR, VARCHAR, TEXT, BINARY, VARBINARY, or BLOB (including TEXT and BLOB variants).
 func IsText(t sql.Type) bool {
-	_, ok := t.(StringType)
-	return ok
+	if _, ok := t.(StringType); ok {
+		return ok
+	}
+	if extendedType, ok := t.(ExtendedType); ok {
+		_, isString := extendedType.Zero().(string)
+		return isString
+	}
+	return false
 }
 
 // IsTextBlob checks if t is one of the TEXTs or BLOBs.