dolthub/dolt#5862: Add ignore system table by codeaucafe · Pull Request #10227 · dolthub/dolt

codeaucafe · 2025-12-18T07:25:06Z

Summary

Adds a new dolt_status_ignored system table that extends dolt_status functionality by including an ignored column to identify which unstaged tables match patterns defined in dolt_ignore. This provides a SQL interface equivalent to dolt status --ignored.

Changes

New System Table

dolt_status_ignored - Same schema as dolt_status plus an ignored column:

table_name (text): Name of the table
staged (boolean): Whether the table is staged
status (text): Status of the table (e.g., "new table", "modified", "conflict")
ignored (boolean): Whether the table matches a dolt_ignore pattern

Implementation Details

The implementation started with logic similar to status_table.go and was then refactored to share common code between both tables while adding the ignore-checking functionality.

go/libraries/doltcore/doltdb/system_table.go

Added StatusIgnoredTableName constant
Registered table in GeneratedSystemTableNames() and DoltGeneratedTableNames

go/libraries/doltcore/sqle/database.go

Added switch case for StatusIgnoredTableName in getTableInsensitiveWithRoot()
Extracted getStatusTableRootsProvider() helper to eliminate duplicate logic between dolt_status and dolt_status_ignored switch cases

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

Added getStatusRowsData() function using existing statusTableRow struct to share status collection logic between both tables
Refactored newStatusItr() to use shared function

go/libraries/doltcore/sqle/dtables/status_ignored_table.go (new file)

Implements StatusIgnoredTable and StatusIgnoredItr
Uses shared getStatusRowsData() from status_table.go
Uses adapter pattern via DoltTableAdapterRegistry similar to StatusTable
Adds ignore-checking logic via helper functions:
- getIgnorePatterns(): Fetches patterns from dolt_ignore
- buildUnstagedTableNameSet(): Creates set for quick lookup
- checkIfIgnored(): Checks if table matches ignore pattern (returns error on failure)

Behavior

Unstaged tables: ignored=1 if table name matches a pattern in dolt_ignore, ignored=0 otherwise
Staged tables: Always ignored=0 (staging overrides ignore patterns, matching git behavior)
Constraint violations, merge conflicts, schema conflicts: Always ignored=0

Tests

BATS integration tests

integration-tests/bats/system-tables.bats:

Basic functionality: Verifies ignored column correctly identifies ignored tables while non-ignored tables have ignored=0
Staged tables: Confirms staged tables always have ignored=0 regardless of ignore patterns
System table visibility: Ensures table appears in dolt ls --system

integration-tests/bats/ls.bats:

Updated "ls: --system shows system tables" to include dolt_status_ignored (27 tables instead of 26)

Go enginetests

go/libraries/doltcore/sqle/enginetest/dolt_queries.go:

Closes #5862

Add new dolt_status_ignored system table that extends dolt_status with an "ignored" column to show which unstaged tables match dolt_ignore patterns. This provides SQL equivalent of dolt status --ignored functionality. Implementation includes: - StatusIgnoredTable type with schema containing table_name, staged, status, and ignored columns - Registration in system table constants and generated table names lists - Helper function getStatusTableRootsProvider to eliminate duplicate switch case logic between StatusTableName and StatusIgnoredTableName in database.go - Shared getStatusRowsData function used by both dolt_status and dolt_status_ignored to collect status data from roots and working set - Unexported helper functions in status_ignored_table.go for ignore pattern checking: getIgnorePatterns, buildUnstagedTableNameSet, and checkIfIgnored - bats integration tests verifying behavior The ignored column is only set for unstaged tables that match patterns in dolt_ignore. Staged tables, constraint violations, merge conflicts, and schema conflicts always have ignored = 0. Refs: dolthub#5862

nicktobey · 2025-12-18T21:14:06Z

It looks like the refactor may have changed the behavior of dolt_status, as seen in the newly failingTestDoltMergeArtifacts:

--- FAIL: TestDoltMergeArtifacts (0.22s)
    --- FAIL: TestDoltMergeArtifacts/divergent_type_change_causes_schema_conflict (0.01s)
        --- FAIL: TestDoltMergeArtifacts/divergent_type_change_causes_schema_conflict/select_*_from_dolt_status (0.00s)
            evaluation.go:854: 
                	Error Trace:	/Users/runner/go/pkg/mod/github.com/dolthub/go-mysql-server@v0.20.1-0.20251218001312-084240aa6481/enginetest/evaluation.go:854
                	            				/Users/runner/go/pkg/mod/github.com/dolthub/go-mysql-server@v0.20.1-0.20251218001312-084240aa6481/enginetest/evaluation.go:598
                	            				/Users/runner/go/pkg/mod/github.com/dolthub/go-mysql-server@v0.20.1-0.20251218001312-084240aa6481/enginetest/evaluation.go:471
                	            				/Users/runner/go/pkg/mod/github.com/dolthub/go-mysql-server@v0.20.1-0.20251218001312-084240aa6481/enginetest/evaluation.go:442
                	            				/Users/runner/hostedtoolcache/go/1.25.3/arm64/src/runtime/asm_arm64.s:1268
                	Error:      	Not equal: 
                	            	expected: []sql.Row{sql.Row{"t", 0x0, "schema conflict"}}
                	            	actual  : []sql.Row{sql.Row{"t", 0x0, "merged"}}
                	            	
                	            	Diff:
                	            	--- Expected
                	            	+++ Actual
                	            	@@ -4,3 +4,3 @@
                	            	   (uint64) 0,
                	            	-  (string) (len=15) "schema conflict"
                	            	+  (string) (len=6) "merged"
                	            	  }
                	Test:       	TestDoltMergeArtifacts/divergent_type_change_causes_schema_conflict/select_*_from_dolt_status
                	Messages:   	Unexpected result for query select * from dolt_status

One alternative to having two system tables that share code would be to make dolt_status a system view equal to SELECT table_name, staged, status FROM DOLT_STATUS WHERE ignored = false. We do that in some other places: for example, DOLT_BLAME is implemented as a view over DOLT_DIFF, and you can see how that's implemented in go/libraries/doltcore/sqle/dtables/blame_view.go

Fix bugs introduced in initial dolt_status_ignored implementation commit and refactor to eliminate duplicate code between status tables. fixes: - Fix schema conflict status incorrectly set to "merged" instead of "schema conflict" in getStatusRowsData - Add dolt_status_ignored to expected system tables list in DOLT_SHOW_SYSTEM_TABLES test (should fix existing test failures) Refs: dolthub#5862

Address PR review feedback for dolt_status_ignored implementation with refactors to error handling, adapter pattern, test coverage, and copyright year. Changes: - Fix copyright year from 2020 to 2025 in status_ignored_table.go - Add adapter pattern to NewStatusIgnoredTable; matches StatusTable implementation. - Add NewStatusIgnoredTableWithNoAdapter for default behavior - Fix error handling in checkIfIgnored to return errors instead of silently returning byte(0) - Propagate ignore pattern errors up the call stack Test coverage additions: - Empty dolt_ignore table test verifying all tables show ignored=0 - Conflicting patterns test with wildcard (test_*=true) vs specific override (test_special=false) - Update ls.bats to expect 27 system tables instead of 26 Error handling refactored to now matches patterns in status.go, commit .go, and diff.go where IsTableNameIgnored errors are properly propagated up rather than swallowed. Refs: dolthub#5862

codeaucafe · 2025-12-20T21:10:23Z

I think this is good to be reviewed again now

nicktobey · 2025-12-18T21:18:33Z

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

 }

+// statusRowData contains the data for a single status row.
+type statusRowData struct {


This is identical to statusTableRow declared immediately above it. I don't think we need it.

nicktobey · 2025-12-18T21:23:31Z

go/libraries/doltcore/sqle/dtables/status_ignored_table.go

+	rows := make([]statusIgnoredTableRow, len(statusRows))
+	for i, row := range statusRows {
+		ignored := byte(0)
+		// Only check ignore patterns for unstaged tables


We also should only check the ignore patterns for tables whose status is being added, not tables being modified or removed. That's what git does, and we want to match git here.

nicktobey · 2025-12-18T21:32:43Z

go/libraries/doltcore/sqle/dtables/status_ignored_table.go

+	result, err := ignorePatterns.IsTableNameIgnored(tblNameObj)
+	if err != nil {
+		return byte(0)
+	}


We don't want to silently swallow the error here. I'm not sure it makes sense to outline this function if it's small and only gets called in one place.

Propagating the error is good, but I'm still skeptical that this should be in it's own function, since it only gets called in one place, and casting it to a byte only really makes sense in the context of the status table.

nicktobey · 2026-01-07T01:04:16Z

go/libraries/doltcore/sqle/dtables/status_ignored_table.go

+	result, err := ignorePatterns.IsTableNameIgnored(tblNameObj)
+	if err != nil {
+		return byte(0)
+	}


Propagating the error is good, but I'm still skeptical that this should be in it's own function, since it only gets called in one place, and casting it to a byte only really makes sense in the context of the status table.

nicktobey · 2026-01-07T01:06:07Z

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

 				tableName: tbl.String(),
 				isStaged:  byte(0),
-				status:    mergedStatus,
+				status:    "schema conflict",


This and "constraint violation" should probably be stored in a constant, like mergeConflictStatus does below.

oddly enough I thought I made this change, but not sure what happened. good call out. I'll fix this and the other comments you made.

codeaucafe · 2026-01-07T05:39:36Z

Thanks Nick, I'll update accordingly. Was almost done ambit computer messed up so I called it a night. I'll push the fixes tomorrow

Refactor dolt_status_ignored to match Git ignore behavior and improve code quality. Logic fix: - Only check ignore patterns for tables with "new table" status Code improvements: - Add constants for status strings (schemaConflictStatus, constraintViolationStatus, newTableStatus) to match existing pattern used by mergeConflictStatus and mergedStatus - Inline checkIfIgnored function since it was only called once - Change ignored field from byte to bool in statusIgnoredTableRow since wire protocol workaround only applies to statusTableRow Refs: dolthub#5862

Update test assertions in dolt_status_ignored tests to use boolean values (true/false) instead of byte values (byte(0)/byte(1)) for the ignored column in statusIgnoredTableRow. Refs: dolthub#5862

codeaucafe · 2026-01-09T05:22:39Z

go/libraries/doltcore/sqle/dtables/status_ignored_table.go

+	tableName string
+	status    string
+	isStaged  byte // not a bool bc wire protocol confuses bools and tinyint(1)
+	ignored   bool


@nicktobey I wasn't sure I read your comment correctly about "... casting it to a byte only really makes sense in the context of the status table...". I read interpreted it as: since statusIgnoredTableRow is a separate struct from statusTableRow, the ignored field doesn't need the byte workaround for wire protocol issues, so I changed ignored from byte to bool. Is this what you meant? or if not, then I can change back to byte

codeaucafe · 2026-01-12T00:57:56Z

WARNING: please don't merge. there is a failing bats tests that appears tied to my changes that I missed. I'll work on fixing that and adding a comment when its fixed

Update test assert to check for "false" bool instead of int "0" for the ignored column. This is to align with change to use boolean type for the ignored column in the dolt_status_ignored system table. The other tests were previously fixed to handle this type change, but this one slipped through the cracks. Refs: dolthub#5862

…e/5862/make-ignore-system-table

Add adapter and test expectations for the new dolt_status_ignored system table from PR dolthub/dolt#10227. This table provides the same information as dolt_status plus an additional ignored column indicating whether unstaged new tables match a pattern in dolt_ignore. Changes: - Add DoltgresDoltStatusIgnoredTableAdapter in status_ignored.go - Register DoltgresDoltStatusIgnoredTableAdapter in init.go - Update pgcatalog_test.go with new dolt_status_ignore table to expected tables - Add new dolt_status_ignore table to sequences_test.go expected tables Refs: dolthub/dolt#5862, dolthub/dolt#10227

Due to codeaucafe's contribution being on a fork updating the doltgresql's go.mod to point to the updates in the dolt PR, dolthub/dolt#10227 this requires a replace directive. This will at least allow us to ensure this DoltgreSQL's PR can run CI. Refs: dolthub/dolt#5862, dolthub/dolt#10227

Update pg_catalog test expectations to include new status_ignored system table in the dolt schema. Refs: dolthub/dolt#5862, dolthub/dolt#10227

…2-dolt-status-ignored-adapter dolthub/dolt#10227: add dolt_status_ignored dolt system table

Remove temporary replace directive that pointed to codeaucafe fork and update to latest dolthub/dolt/go version containing the merged dolt_status_ignored system table implementation from PR dolthub/dolt#10227. Refs: dolthub/dolt#10227

coffeegoddd added the contribution label Dec 18, 2025

codeaucafe marked this pull request as ready for review December 19, 2025 08:55

nicktobey reviewed Jan 7, 2026

View reviewed changes

nicktobey approved these changes Jan 7, 2026

View reviewed changes

codeaucafe added 2 commits January 8, 2026 18:30

fix(sqle): update tests to use bool type for ignored column

a94e5be

Update test assertions in dolt_status_ignored tests to use boolean values (true/false) instead of byte values (byte(0)/byte(1)) for the ignored column in statusIgnoredTableRow. Refs: dolthub#5862

codeaucafe commented Jan 9, 2026

View reviewed changes

codeaucafe added 2 commits January 11, 2026 17:16

Merge branch 'main' of https://github.com/dolthub/dolt into codeaucaf…

5155e81

…e/5862/make-ignore-system-table

codeaucafe mentioned this pull request Jan 13, 2026

dolthub/dolt#10227: add dolt_status_ignored dolt system table dolthub/doltgresql#2196

Merged

nicktobey added a commit to dolthub/doltgresql that referenced this pull request Jan 22, 2026

Merge pull request #2196 from codeaucafe/codeaucafe/dolthub-dolt-#586…

581e3c7

…2-dolt-status-ignored-adapter dolthub/dolt#10227: add dolt_status_ignored dolt system table

nicktobey merged commit 6b5d537 into dolthub:main Jan 22, 2026
18 of 25 checks passed

BrewTestBot mentioned this pull request Jan 23, 2026

dolt 1.81.2 Homebrew/homebrew-core#264111

Merged

Uh oh!

Conversation

codeaucafe commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

New System Table

Implementation Details

Behavior

Tests

BATS integration tests

Go enginetests

Uh oh!

nicktobey commented Dec 18, 2025

Uh oh!

codeaucafe commented Dec 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codeaucafe commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codeaucafe commented Jan 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codeaucafe commented Dec 18, 2025 •

edited

Loading

codeaucafe commented Jan 7, 2026 •

edited

Loading