Enhance load schema with filtering

[morgo]

A Pull Request should be associated with an Issue.

We wish to have discussions in Issues. A single issue may be targeted by multiple PRs.
If you're offering a new feature or fixing anything, we'd like to know beforehand in Issues,
and potentially we'll be able to point development in a particular direction.
Further notes in https://github.com/block/spirit/blob/main/.github/CONTRIBUTING.md

This adds optional filtering to the LoadSchemaFromDB API. We are always filtering out the same things in our downstream API usage, so it makes sense to push it into here.

[Copilot]

Pull request overview

Adds optional filtering and normalization capabilities to pkg/table’s schema loader so callers can exclude internal/archived tables and remove volatile AUTO_INCREMENT table options when retrieving SHOW CREATE TABLE output.

Changes:

• Introduces FilterOptions to control underscore-table exclusion, archive-table exclusion, and AUTO_INCREMENT stripping.
• Updates LoadSchemaFromDB to accept optional filtering/transform behavior via variadic options.
• Adds integration tests covering each filter/transform option and a combined scenario.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
pkg/table/table_schema.go	Adds filter options, regex helpers, and applies filtering/DDL transformation during schema load.
pkg/table/table_schema_test.go	Adds MySQL-backed tests to validate filtering and AUTO_INCREMENT stripping behavior.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.