refactor: rename DefaultKeyspace() to CurrentKeyspace() (#17303)

systay · web-flow · commit 99d534bc629e · 2024-12-03T13:43:18.000+01:00
Signed-off-by: Andres Taylor &lt;andres@planetscale.com&gt;
diff --git a/go/test/vschemawrapper/vschema_wrapper.go b/go/test/vschemawrapper/vschema_wrapper.go
@@ -299,12 +299,12 @@ func (vw *VSchemaWrapper) getActualKeyspace() string {
 	return ks.Name
 }
 
-func (vw *VSchemaWrapper) DefaultKeyspace() (*vindexes.Keyspace, error) {
+func (vw *VSchemaWrapper) SelectedKeyspace() (*vindexes.Keyspace, error) {
 	return vw.V.Keyspaces["main"].Keyspace, nil
 }
 
 func (vw *VSchemaWrapper) AnyKeyspace() (*vindexes.Keyspace, error) {
-	return vw.DefaultKeyspace()
+	return vw.SelectedKeyspace()
 }
 
 func (vw *VSchemaWrapper) FirstSortedKeyspace() (*vindexes.Keyspace, error) {
diff --git a/go/vt/vtgate/planbuilder/builder.go b/go/vt/vtgate/planbuilder/builder.go
@@ -275,7 +275,7 @@ func buildDBDDLPlan(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vschema
 	dbDDLstmt := stmt.(sqlparser.DBDDLStatement)
 	ksName := dbDDLstmt.GetDatabaseName()
 	if ksName == "" {
-		ks, err := vschema.DefaultKeyspace()
+		ks, err := vschema.SelectedKeyspace()
 		if err != nil {
 			return nil, err
 		}
@@ -310,7 +310,7 @@ func buildDBDDLPlan(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vschema
 }
 
 func buildLoadPlan(query string, vschema plancontext.VSchema) (*planResult, error) {
-	keyspace, err := vschema.DefaultKeyspace()
+	keyspace, err := vschema.SelectedKeyspace()
 	if err != nil {
 		return nil, err
 	}
@@ -355,7 +355,7 @@ func buildFlushOptions(stmt *sqlparser.Flush, vschema plancontext.VSchema) (*pla
 		return nil, vterrors.VT09012("FLUSH", vschema.TabletType().String())
 	}
 
-	keyspace, err := vschema.DefaultKeyspace()
+	keyspace, err := vschema.SelectedKeyspace()
 	if err != nil {
 		return nil, err
 	}
diff --git a/go/vt/vtgate/planbuilder/bypass.go b/go/vt/vtgate/planbuilder/bypass.go
@@ -26,7 +26,7 @@ import (
 )
 
 func buildPlanForBypass(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vschema plancontext.VSchema) (*planResult, error) {
-	keyspace, err := vschema.DefaultKeyspace()
+	keyspace, err := vschema.SelectedKeyspace()
 	if err != nil {
 		return nil, err
 	}
diff --git a/go/vt/vtgate/planbuilder/ddl.go b/go/vt/vtgate/planbuilder/ddl.go
@@ -81,7 +81,7 @@ func buildGeneralDDLPlan(ctx context.Context, sql string, ddlStatement sqlparser
 }
 
 func buildByPassPlan(sql string, vschema plancontext.VSchema, isDDL bool) (*planResult, error) {
-	keyspace, err := vschema.DefaultKeyspace()
+	keyspace, err := vschema.SelectedKeyspace()
 	if err != nil {
 		return nil, err
 	}
diff --git a/go/vt/vtgate/planbuilder/operator_transformers.go b/go/vt/vtgate/planbuilder/operator_transformers.go
@@ -545,7 +545,7 @@ func routeToEngineRoute(ctx *plancontext.PlanningContext, op *operators.Route, h
 }
 
 func newRoutingParams(ctx *plancontext.PlanningContext, opCode engine.Opcode) *engine.RoutingParameters {
-	ks, _ := ctx.VSchema.DefaultKeyspace()
+	ks, _ := ctx.VSchema.SelectedKeyspace()
 	if ks == nil {
 		// if we don't have a selected keyspace, any keyspace will do
 		// this is used by operators that do not set the keyspace
diff --git a/go/vt/vtgate/planbuilder/plancontext/planning_context.go b/go/vt/vtgate/planbuilder/plancontext/planning_context.go
@@ -91,7 +91,7 @@ func CreatePlanningContext(stmt sqlparser.Statement,
 	version querypb.ExecuteOptions_PlannerVersion,
 ) (*PlanningContext, error) {
 	ksName := ""
-	if ks, _ := vschema.DefaultKeyspace(); ks != nil {
+	if ks, _ := vschema.SelectedKeyspace(); ks != nil {
 		ksName = ks.Name
 	}
 
diff --git a/go/vt/vtgate/planbuilder/plancontext/planning_context_test.go b/go/vt/vtgate/planbuilder/plancontext/planning_context_test.go
@@ -201,7 +201,7 @@ func (v *vschema) FindTableOrVindex(tablename sqlparser.TableName) (*vindexes.Ta
 	panic("implement me")
 }
 
-func (v *vschema) DefaultKeyspace() (*vindexes.Keyspace, error) {
+func (v *vschema) SelectedKeyspace() (*vindexes.Keyspace, error) {
 	// TODO implement me
 	panic("implement me")
 }
diff --git a/go/vt/vtgate/planbuilder/plancontext/vschema.go b/go/vt/vtgate/planbuilder/plancontext/vschema.go
@@ -27,7 +27,9 @@ type VSchema interface {
 	FindTable(tablename sqlparser.TableName) (*vindexes.Table, string, topodatapb.TabletType, key.Destination, error)
 	FindView(name sqlparser.TableName) sqlparser.SelectStatement
 	FindTableOrVindex(tablename sqlparser.TableName) (*vindexes.Table, vindexes.Vindex, string, topodatapb.TabletType, key.Destination, error)
-	DefaultKeyspace() (*vindexes.Keyspace, error)
+
+	// SelectedKeyspace returns the current keyspace if set, otherwise returns an error
+	SelectedKeyspace() (*vindexes.Keyspace, error)
 	TargetString() string
 	Destination() key.Destination
 	TabletType() topodatapb.TabletType
diff --git a/go/vt/vtgate/planbuilder/select.go b/go/vt/vtgate/planbuilder/select.go
@@ -46,7 +46,7 @@ func gen4SelectStmtPlanner(
 		}
 		if p != nil {
 			used := "dual"
-			keyspace, ksErr := vschema.DefaultKeyspace()
+			keyspace, ksErr := vschema.SelectedKeyspace()
 			if ksErr == nil {
 				// we are just getting the ks to log the correct table use.
 				// no need to fail this if we can't find the default keyspace
@@ -101,7 +101,7 @@ func gen4SelectStmtPlanner(
 
 func gen4planSQLCalcFoundRows(vschema plancontext.VSchema, sel *sqlparser.Select, query string, reservedVars *sqlparser.ReservedVars) (*planResult, error) {
 	ksName := ""
-	if ks, _ := vschema.DefaultKeyspace(); ks != nil {
+	if ks, _ := vschema.SelectedKeyspace(); ks != nil {
 		ksName = ks.Name
 	}
 	semTable, err := semantics.Analyze(sel, ksName, vschema)
diff --git a/go/vt/vtgate/planbuilder/show.go b/go/vt/vtgate/planbuilder/show.go
@@ -676,7 +676,7 @@ func buildVschemaKeyspacesPlan(vschema plancontext.VSchema) (engine.Primitive, e
 
 func buildVschemaTablesPlan(vschema plancontext.VSchema) (engine.Primitive, error) {
 	vs := vschema.GetVSchema()
-	ks, err := vschema.DefaultKeyspace()
+	ks, err := vschema.SelectedKeyspace()
 	if err != nil {
 		return nil, err
 	}
diff --git a/go/vt/vtgate/vcursor_impl.go b/go/vt/vtgate/vcursor_impl.go
@@ -392,10 +392,10 @@ func (vc *vcursorImpl) getActualKeyspace() string {
 	return ks.Name
 }
 
-// DefaultKeyspace returns the default keyspace of the current request
+// SelectedKeyspace returns the selected keyspace of the current request
 // if there is one. If the keyspace specified in the target cannot be
 // identified, it returns an error.
-func (vc *vcursorImpl) DefaultKeyspace() (*vindexes.Keyspace, error) {
+func (vc *vcursorImpl) SelectedKeyspace() (*vindexes.Keyspace, error) {
 	if ignoreKeyspace(vc.keyspace) {
 		return nil, errNoKeyspace
 	}
@@ -409,7 +409,7 @@ func (vc *vcursorImpl) DefaultKeyspace() (*vindexes.Keyspace, error) {
 var errNoDbAvailable = vterrors.NewErrorf(vtrpcpb.Code_FAILED_PRECONDITION, vterrors.NoDB, "no database available")
 
 func (vc *vcursorImpl) AnyKeyspace() (*vindexes.Keyspace, error) {
-	keyspace, err := vc.DefaultKeyspace()
+	keyspace, err := vc.SelectedKeyspace()
 	if err == nil {
 		return keyspace, nil
 	}

Original file line number	Diff line number	Diff line change
`@@ -299,12 +299,12 @@ func (vw *VSchemaWrapper) getActualKeyspace() string {`
`299`	`299`	`return ks.Name`
`300`	`300`	`}`
`301`	`301`
`302`		`-func (vw VSchemaWrapper) DefaultKeyspace() (vindexes.Keyspace, error) {`
	`302`	`+func (vw VSchemaWrapper) SelectedKeyspace() (vindexes.Keyspace, error) {`
`303`	`303`	`return vw.V.Keyspaces["main"].Keyspace, nil`
`304`	`304`	`}`
`305`	`305`
`306`	`306`	`func (vw VSchemaWrapper) AnyKeyspace() (vindexes.Keyspace, error) {`
`307`		`- return vw.DefaultKeyspace()`
	`307`	`+ return vw.SelectedKeyspace()`
`308`	`308`	`}`
`309`	`309`
`310`	`310`	`func (vw VSchemaWrapper) FirstSortedKeyspace() (vindexes.Keyspace, error) {`
Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ func buildDBDDLPlan(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vschema`
`275`	`275`	`dbDDLstmt := stmt.(sqlparser.DBDDLStatement)`
`276`	`276`	`ksName := dbDDLstmt.GetDatabaseName()`
`277`	`277`	`if ksName == "" {`
`278`		`- ks, err := vschema.DefaultKeyspace()`
	`278`	`+ ks, err := vschema.SelectedKeyspace()`
`279`	`279`	`if err != nil {`
`280`	`280`	`return nil, err`
`281`	`281`	`}`
`@@ -310,7 +310,7 @@ func buildDBDDLPlan(stmt sqlparser.Statement, _ *sqlparser.ReservedVars, vschema`
`310`	`310`	`}`
`311`	`311`
`312`	`312`	`func buildLoadPlan(query string, vschema plancontext.VSchema) (*planResult, error) {`
`313`		`- keyspace, err := vschema.DefaultKeyspace()`
	`313`	`+ keyspace, err := vschema.SelectedKeyspace()`
`314`	`314`	`if err != nil {`
`315`	`315`	`return nil, err`
`316`	`316`	`}`
`@@ -355,7 +355,7 @@ func buildFlushOptions(stmt sqlparser.Flush, vschema plancontext.VSchema) (pla`
`355`	`355`	`return nil, vterrors.VT09012("FLUSH", vschema.TabletType().String())`
`356`	`356`	`}`
`357`	`357`
`358`		`- keyspace, err := vschema.DefaultKeyspace()`
	`358`	`+ keyspace, err := vschema.SelectedKeyspace()`
`359`	`359`	`if err != nil {`
`360`	`360`	`return nil, err`
`361`	`361`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`	`)`
`27`	`27`
`28`	`28`	`func buildPlanForBypass(stmt sqlparser.Statement, _ sqlparser.ReservedVars, vschema plancontext.VSchema) (planResult, error) {`
`29`		`- keyspace, err := vschema.DefaultKeyspace()`
	`29`	`+ keyspace, err := vschema.SelectedKeyspace()`
`30`	`30`	`if err != nil {`
`31`	`31`	`return nil, err`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ func buildGeneralDDLPlan(ctx context.Context, sql string, ddlStatement sqlparser`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`func buildByPassPlan(sql string, vschema plancontext.VSchema, isDDL bool) (*planResult, error) {`
`84`		`- keyspace, err := vschema.DefaultKeyspace()`
	`84`	`+ keyspace, err := vschema.SelectedKeyspace()`
`85`	`85`	`if err != nil {`
`86`	`86`	`return nil, err`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -545,7 +545,7 @@ func routeToEngineRoute(ctx plancontext.PlanningContext, op operators.Route, h`
`545`	`545`	`}`
`546`	`546`
`547`	`547`	`func newRoutingParams(ctx plancontext.PlanningContext, opCode engine.Opcode) engine.RoutingParameters {`
`548`		`- ks, _ := ctx.VSchema.DefaultKeyspace()`
	`548`	`+ ks, _ := ctx.VSchema.SelectedKeyspace()`
`549`	`549`	`if ks == nil {`
`550`	`550`	`// if we don't have a selected keyspace, any keyspace will do`
`551`	`551`	`// this is used by operators that do not set the keyspace`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ func CreatePlanningContext(stmt sqlparser.Statement,`
`91`	`91`	`version querypb.ExecuteOptions_PlannerVersion,`
`92`	`92`	`) (*PlanningContext, error) {`
`93`	`93`	`ksName := ""`
`94`		`- if ks, _ := vschema.DefaultKeyspace(); ks != nil {`
	`94`	`+ if ks, _ := vschema.SelectedKeyspace(); ks != nil {`
`95`	`95`	`ksName = ks.Name`
`96`	`96`	`}`
`97`	`97`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ func (v vschema) FindTableOrVindex(tablename sqlparser.TableName) (vindexes.Ta`
`201`	`201`	`panic("implement me")`
`202`	`202`	`}`
`203`	`203`
`204`		`-func (v vschema) DefaultKeyspace() (vindexes.Keyspace, error) {`
	`204`	`+func (v vschema) SelectedKeyspace() (vindexes.Keyspace, error) {`
`205`	`205`	`// TODO implement me`
`206`	`206`	`panic("implement me")`
`207`	`207`	`}`
Original file line number	Diff line number	Diff line change
`@@ -676,7 +676,7 @@ func buildVschemaKeyspacesPlan(vschema plancontext.VSchema) (engine.Primitive, e`
`676`	`676`
`677`	`677`	`func buildVschemaTablesPlan(vschema plancontext.VSchema) (engine.Primitive, error) {`
`678`	`678`	`vs := vschema.GetVSchema()`
`679`		`- ks, err := vschema.DefaultKeyspace()`
	`679`	`+ ks, err := vschema.SelectedKeyspace()`
`680`	`680`	`if err != nil {`
`681`	`681`	`return nil, err`
`682`	`682`	`}`
Original file line number	Diff line number	Diff line change
`@@ -392,10 +392,10 @@ func (vc *vcursorImpl) getActualKeyspace() string {`
`392`	`392`	`return ks.Name`
`393`	`393`	`}`
`394`	`394`
`395`		`-// DefaultKeyspace returns the default keyspace of the current request`
	`395`	`+// SelectedKeyspace returns the selected keyspace of the current request`
`396`	`396`	`// if there is one. If the keyspace specified in the target cannot be`
`397`	`397`	`// identified, it returns an error.`
`398`		`-func (vc vcursorImpl) DefaultKeyspace() (vindexes.Keyspace, error) {`
	`398`	`+func (vc vcursorImpl) SelectedKeyspace() (vindexes.Keyspace, error) {`
`399`	`399`	`if ignoreKeyspace(vc.keyspace) {`
`400`	`400`	`return nil, errNoKeyspace`
`401`	`401`	`}`
`@@ -409,7 +409,7 @@ func (vc vcursorImpl) DefaultKeyspace() (vindexes.Keyspace, error) {`
`409`	`409`	`var errNoDbAvailable = vterrors.NewErrorf(vtrpcpb.Code_FAILED_PRECONDITION, vterrors.NoDB, "no database available")`
`410`	`410`
`411`	`411`	`func (vc vcursorImpl) AnyKeyspace() (vindexes.Keyspace, error) {`
`412`		`- keyspace, err := vc.DefaultKeyspace()`
	`412`	`+ keyspace, err := vc.SelectedKeyspace()`
`413`	`413`	`if err == nil {`
`414`	`414`	`return keyspace, nil`
`415`	`415`	`}`