add dolt adapter to standardize table overwrites by integrators

Author: elianddb

go/libraries/doltcore/doltdb/system_table.go

@@ -367,11 +367,6 @@ var GetSchemaConflictsTableName = func() string {
 	return SchemaConflictsTableName
 }
 
-// GetStatusTableName returns the status system table name.
-var GetStatusTableName = func() string {
-	return StatusTableName
-}
-
 // GetTagsTableName returns the tags table name
 var GetTagsTableName = func() string {
 	return TagsTableName

go/libraries/doltcore/sqle/adapters/table_adapter.go

@@ -0,0 +1,26 @@
+package adapters
+
+import (
+	"github.com/dolthub/go-mysql-server/sql"
+
+	"github.com/dolthub/dolt/go/libraries/doltcore/doltdb"
+	"github.com/dolthub/dolt/go/libraries/doltcore/env"
+)
+
+// TableAdapter provides a hook for extensions to customize or wrap table implementations. For example, this allows
+// libraries like Doltgres to intercept system table creation and apply type conversions, schema modifications, or other
+// customizations without modifying the core Dolt implementation for their compatibility.
+type TableAdapter interface {
+	// CreateTable creates or wraps a system table. The function receives all necessary parameters to construct the
+	// table and can either build it from scratch or call the default Dolt constructor and wrap it.
+	CreateTable(ctx *sql.Context, tableName string, dDb *doltdb.DoltDB, workingSet *doltdb.WorkingSet, rootsProvider env.RootsProvider[*sql.Context]) sql.Table
+
+	// TableName returns the preferred name for the adapter's table. This allows extensions to rename tables while
+	// preserving the underlying implementation. For example, Doltgres uses "status" while Dolt uses "dolt_status",
+	// enabling cleaner Postgres-style naming.
+	TableName() string
+}
+
+// TableAdapters is a registry for TableAdapter implementations, keyed by table name. It is populated during package
+// initialization and intended to be read-only thereafter.
+var TableAdapters = make(map[string]TableAdapter)

go/libraries/doltcore/sqle/database.go

@@ -44,6 +44,7 @@ import (
 	"github.com/dolthub/dolt/go/libraries/doltcore/rebase"
 	"github.com/dolthub/dolt/go/libraries/doltcore/ref"
 	"github.com/dolthub/dolt/go/libraries/doltcore/schema"
+	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/adapters"
 	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/dprocedures"
 	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/dsess"
 	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/dtables"
@@ -747,7 +748,7 @@ func (db Database) getTableInsensitiveWithRoot(ctx *sql.Context, head *doltdb.Co
 		if !resolve.UseSearchPath || isDoltgresSystemTable {
 			dt, found = dtables.NewCommitAncestorsTable(ctx, db.Name(), lwrName, db.ddb), true
 		}
-	case doltdb.GetStatusTableName(), doltdb.StatusTableName:
+	case doltdb.StatusTableName, adapters.TableAdapters[doltdb.StatusTableName].TableName():
 		isDoltgresSystemTable, err := resolve.IsDoltgresSystemTable(ctx, tname, root)
 		if err != nil {
 			return nil, false, err
@@ -804,7 +805,12 @@ func (db Database) getTableInsensitiveWithRoot(ctx *sql.Context, head *doltdb.Co
 				}
 			}
 
-			dt, found = dtables.NewStatusTable(ctx, lwrName, db.ddb, ws, rootsProvider), true
+			if tableAdapter, ok := adapters.TableAdapters[lwrName]; ok {
+				dt, found = tableAdapter.CreateTable(ctx, lwrName, db.ddb, ws, rootsProvider), true
+			}
+			if !ok {
+				return nil, false, sql.ErrTableNotFound.New(tblName)
+			}
 		}
 	case doltdb.MergeStatusTableName, doltdb.GetMergeStatusTableName():
 		isDoltgresSystemTable, err := resolve.IsDoltgresSystemTable(ctx, tname, root)

go/libraries/doltcore/sqle/dtables/status_table.go

@@ -25,11 +25,35 @@ import (
 	"github.com/dolthub/dolt/go/libraries/doltcore/doltdb"
 	"github.com/dolthub/dolt/go/libraries/doltcore/env"
 	"github.com/dolthub/dolt/go/libraries/doltcore/schema"
+	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/adapters"
 	"github.com/dolthub/dolt/go/libraries/doltcore/sqle/index"
 )
 
 const statusDefaultRowCount = 10
 
+func init() {
+	adapters.TableAdapters[doltdb.StatusTableName] = DoltStatusTableAdapter{}
+}
+
+// DoltStatusTableAdapter implements the adapters.TableAdapter interface. It serves as the default dolt_status table
+// implementation, applying zero modifications. This exists in case no adapters are initialized by the integrator, i.e.
+// Doltgres.
+type DoltStatusTableAdapter struct{}
+
+var _ adapters.TableAdapter = DoltStatusTableAdapter{}
+
+// CreateTable implements the adapters.TableAdapter interface. It returns the default constructor for the dolt_status
+// table, applying zero modifications.
+func (d DoltStatusTableAdapter) CreateTable(ctx *sql.Context, tableName string, dDb *doltdb.DoltDB, workingSet *doltdb.WorkingSet, rootsProvider env.RootsProvider[*sql.Context]) sql.Table {
+	return NewStatusTable(ctx, tableName, dDb, workingSet, rootsProvider)
+}
+
+// TableName implements the adapters.TableAdapter interface. It returns the default name for the dolt_status table,
+// applying zero modifications.
+func (d DoltStatusTableAdapter) TableName() string {
+	return doltdb.StatusTableName
+}
+
 // StatusTable is a sql.Table implementation that implements a system table which shows the dolt branches
 type StatusTable struct {
 	rootsProvider env.RootsProvider[*sql.Context]
@@ -61,22 +85,14 @@ func (st StatusTable) String() string {
 	return st.tableName
 }
 
-func getDoltStatusSchema(tableName string) sql.Schema {
+func (st StatusTable) Schema() sql.Schema {
 	return []*sql.Column{
-		{Name: "table_name", Type: types.Text, Source: tableName, PrimaryKey: true, Nullable: false},
-		{Name: "staged", Type: types.Boolean, Source: tableName, PrimaryKey: true, Nullable: false},
-		{Name: "status", Type: types.Text, Source: tableName, PrimaryKey: true, Nullable: false},
+		{Name: "table_name", Type: types.Text, Source: doltdb.StatusTableName, PrimaryKey: true, Nullable: false},
+		{Name: "staged", Type: types.Boolean, Source: doltdb.StatusTableName, PrimaryKey: true, Nullable: false},
+		{Name: "status", Type: types.Text, Source: doltdb.StatusTableName, PrimaryKey: true, Nullable: false},
 	}
 }
 
-// GetDoltStatusSchema returns the schema of the dolt_status system table. This is used
-// by Doltgres to update the dolt_status schema using Doltgres types.
-var GetDoltStatusSchema = getDoltStatusSchema
-
-func (st StatusTable) Schema() sql.Schema {
-	return GetDoltStatusSchema(st.tableName)
-}
-
 func (st StatusTable) Collation() sql.CollationID {
 	return sql.Collation_Default
 }