Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
82e86cdf39 | ||
|
|
b7ae00ab52 | ||
|
|
8f8664357e | ||
|
|
7bd61a21b5 | ||
|
|
6f6b9834ca | ||
|
|
9cc10715e3 | ||
|
|
bbab5ce936 | ||
|
|
275424c605 | ||
|
|
b6c0cd3d1b | ||
|
|
d7d1d99ebc |
+59
-113
@@ -1,145 +1,91 @@
|
|||||||
# Contributing to RelSpec
|
# Contributing to RelSpec
|
||||||
|
|
||||||
Thank you for your interest in contributing to RelSpec.
|
## Setup
|
||||||
|
|
||||||
## Development Setup
|
- Go 1.25+ (see `go.mod`), Git
|
||||||
|
- Optional: golangci-lint, Docker/Podman (PostgreSQL integration tests)
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
- Go 1.21 or higher
|
|
||||||
- Git
|
|
||||||
- (Optional) golangci-lint for linting
|
|
||||||
- (Optional) Docker for database testing
|
|
||||||
|
|
||||||
### Getting Started
|
|
||||||
|
|
||||||
1. Clone the repository:
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/wdevs/relspecgo.git
|
git clone git@git.warky.dev:wdevs/relspecgo.git
|
||||||
cd relspecgo
|
cd relspecgo
|
||||||
|
make deps
|
||||||
|
make build # outputs build/relspec
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Install dependencies:
|
## Make Targets
|
||||||
```bash
|
|
||||||
go mod download
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Run tests:
|
| Target | Purpose |
|
||||||
```bash
|
|-------------------------|------------------------------------------------------|
|
||||||
go test ./...
|
| `make test` | Unit tests (race detection, coverage) |
|
||||||
```
|
| `make test-integration` | Integration tests (needs `RELSPEC_TEST_PG_CONN`) |
|
||||||
|
| `make docker-test` | PostgreSQL integration tests via Docker/Podman |
|
||||||
|
| `make lint` | golangci-lint |
|
||||||
|
| `make fmt` / `fmt-check`| gofumpt + goimports |
|
||||||
|
| `make check` | vet, fmt-check, staticcheck, govulncheck |
|
||||||
|
| `make coverage` | Coverage report |
|
||||||
|
|
||||||
4. Build the project:
|
Single test: `go test -run TestName ./pkg/readers/dbml`
|
||||||
```bash
|
|
||||||
go build -o relspec ./cmd/relspec
|
|
||||||
```
|
|
||||||
|
|
||||||
## Project Structure
|
## Layout
|
||||||
|
|
||||||
```
|
```
|
||||||
relspecgo/
|
cmd/relspec/ CLI commands (convert, diff, merge, split, edit, inspect, job, ...)
|
||||||
├── cmd/ # CLI application entry point
|
pkg/models/ Core model: Database > Schema > Table > Column/Constraint/Index/Relationship
|
||||||
├── pkg/
|
pkg/readers/<fmt> One reader per format
|
||||||
│ ├── readers/ # Input format readers (XML, JSON, DCTX, DB, GORM, Bun)
|
pkg/writers/<fmt> One writer per format
|
||||||
│ ├── writers/ # Output format writers (GORM, Bun, JSON, YAML)
|
pkg/diff, merge, inspector, jobs, transform, ui, pgsql, sqltypes ...
|
||||||
│ ├── models/ # Internal data models for relations
|
examples/ Sample files
|
||||||
│ └── transform/ # Transformation and validation logic
|
tests/ Integration tests and assets
|
||||||
├── examples/ # Usage examples and sample files
|
docs/ Feature docs
|
||||||
├── tests/ # Integration tests
|
|
||||||
└── .claude/ # Claude Code configuration and commands
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Adding New Readers
|
## Adding a Reader
|
||||||
|
|
||||||
To add a new input format reader:
|
1. Create `pkg/readers/<format>/reader.go` with `NewReader(options *readers.ReaderOptions)`.
|
||||||
|
2. Implement `readers.Reader`: `ReadDatabase`, `ReadSchema`, `ReadTable`.
|
||||||
|
3. Add `reader_test.go` in the same package.
|
||||||
|
4. Register the format in the CLI switches (`cmd/relspec/convert.go`, `diff.go`, `edit.go`, ...).
|
||||||
|
5. Add a `README.md` in the reader directory.
|
||||||
|
|
||||||
1. Create a new file in `pkg/readers/` (e.g., `myformat_reader.go`)
|
## Adding a Writer
|
||||||
2. Implement the `Reader` interface:
|
|
||||||
```go
|
|
||||||
type Reader interface {
|
|
||||||
Read(source string) (*models.Schema, error)
|
|
||||||
}
|
|
||||||
```
|
|
||||||
3. Add tests in `pkg/readers/myformat_reader_test.go`
|
|
||||||
4. Register the reader in the CLI
|
|
||||||
|
|
||||||
## Adding New Writers
|
1. Create `pkg/writers/<format>/writer.go` with `NewWriter(options *writers.WriterOptions)`.
|
||||||
|
2. Implement `writers.Writer`: `WriteDatabase`, `WriteSchema`, `WriteTable`.
|
||||||
|
3. Add `writer_test.go` in the same package.
|
||||||
|
4. Register the format in the CLI switches.
|
||||||
|
5. Add a `README.md` in the writer directory.
|
||||||
|
|
||||||
To add a new output format writer:
|
## Code Rules
|
||||||
|
|
||||||
1. Create a new file in `pkg/writers/` (e.g., `myformat_writer.go`)
|
- Format with gofumpt/goimports (`make fmt`); `make check` must pass.
|
||||||
2. Implement the `Writer` interface:
|
- Iterate `Table.Columns`, `Constraints`, `Indexes`, `Relationships` in sorted order (maps are unordered; output must be deterministic).
|
||||||
```go
|
- Every writer stamps `buildinfo.GeneratedComment()` in its file header.
|
||||||
type Writer interface {
|
- Comment exported functions and types.
|
||||||
Write(schema *models.Schema, destination string) error
|
|
||||||
}
|
|
||||||
```
|
|
||||||
3. Add tests in `pkg/writers/myformat_writer_test.go`
|
|
||||||
4. Register the writer in the CLI
|
|
||||||
|
|
||||||
## Code Style
|
|
||||||
|
|
||||||
- Follow standard Go conventions
|
|
||||||
- Use `gofmt` for formatting
|
|
||||||
- Run `go vet` to check for issues
|
|
||||||
- Use meaningful variable and function names
|
|
||||||
- Add comments for exported functions and types
|
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
- Write unit tests for all new functionality
|
- Tests live in the same package as the code.
|
||||||
- Aim for >80% code coverage
|
- Table-driven tests; cover positive and negative cases.
|
||||||
- Use table-driven tests where appropriate
|
- Reuse existing test data in `tests/` and `examples/` before adding new data.
|
||||||
- Include both positive and negative test cases
|
- Tests run with `-race`.
|
||||||
|
|
||||||
### Running Tests
|
## Commits
|
||||||
|
|
||||||
```bash
|
- Format: `type(scope): description`
|
||||||
# All tests
|
- Types: `feat`, `fix`, `docs`, `test`, `refactor`, `chore`, `ci`
|
||||||
go test ./...
|
- Keep commits focused. Reference issues where applicable.
|
||||||
|
|
||||||
# With coverage
|
## Pull Requests
|
||||||
go test -cover ./...
|
|
||||||
|
|
||||||
# Verbose output
|
1. Branch from `master`.
|
||||||
go test -v ./...
|
2. Add tests; `make test` and `make check` pass.
|
||||||
|
3. Update docs/README if behaviour changes.
|
||||||
|
4. Open a PR with a clear description.
|
||||||
|
|
||||||
# Specific package
|
## Security
|
||||||
go test ./pkg/readers/...
|
|
||||||
```
|
|
||||||
|
|
||||||
## Committing Changes
|
Do not report vulnerabilities in public issues. See [SECURITY.md](SECURITY.md).
|
||||||
|
|
||||||
- Write clear, descriptive commit messages
|
|
||||||
- Follow conventional commits format: `type(scope): description`
|
|
||||||
- Types: feat, fix, docs, test, refactor, chore
|
|
||||||
- Example: `feat(readers): add PostgreSQL support`
|
|
||||||
- Keep commits focused and atomic
|
|
||||||
- Reference issues in commit messages when applicable
|
|
||||||
|
|
||||||
## Pull Request Process
|
|
||||||
|
|
||||||
1. Create a feature branch from `master`
|
|
||||||
2. Make your changes
|
|
||||||
3. Add tests for new functionality
|
|
||||||
4. Ensure all tests pass
|
|
||||||
5. Update documentation if needed
|
|
||||||
6. Submit a pull request with a clear description
|
|
||||||
|
|
||||||
## Claude Code Commands
|
|
||||||
|
|
||||||
This project includes Claude Code slash commands for common tasks:
|
|
||||||
|
|
||||||
- `/test` - Run all tests
|
|
||||||
- `/build` - Build the binary
|
|
||||||
- `/lint` - Run linters
|
|
||||||
- `/coverage` - Generate coverage report
|
|
||||||
|
|
||||||
## Questions or Issues?
|
|
||||||
|
|
||||||
- Open an issue for bugs or feature requests
|
|
||||||
- Start a discussion for questions or ideas
|
|
||||||
- Check existing issues before creating new ones
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
By contributing to RelSpec, you agree that your contributions will be licensed under the Apache License 2.0.
|
Contributions are licensed under the Apache License 2.0.
|
||||||
|
|||||||
@@ -243,7 +243,7 @@ release: lint fmt-check test build ## Run lint, format check, tests, build, then
|
|||||||
git push origin "$$version"; \
|
git push origin "$$version"; \
|
||||||
echo "Tag $$version created and pushed to remote repository."
|
echo "Tag $$version created and pushed to remote repository."
|
||||||
|
|
||||||
release-version: ## Auto-increment patch version, update VERSION/package files, commit, tag, and push
|
release-version: lint fmt-check ## Run lint and format check, then auto-increment patch version, update VERSION/package files, commit, tag, and push
|
||||||
@CURRENT=$$([ -f VERSION ] && cat VERSION | tr -d '[:space:]' || (git describe --tags --abbrev=0 2>/dev/null | sed 's/^v//') || echo "0.0.0"); \
|
@CURRENT=$$([ -f VERSION ] && cat VERSION | tr -d '[:space:]' || (git describe --tags --abbrev=0 2>/dev/null | sed 's/^v//') || echo "0.0.0"); \
|
||||||
MAJOR=$$(echo $$CURRENT | cut -d. -f1); \
|
MAJOR=$$(echo $$CURRENT | cut -d. -f1); \
|
||||||
MINOR=$$(echo $$CURRENT | cut -d. -f2); \
|
MINOR=$$(echo $$CURRENT | cut -d. -f2); \
|
||||||
|
|||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported versions
|
||||||
|
Security fixes are released for the latest minor version of RelSpec.
|
||||||
|
|
||||||
|
## Reporting a vulnerability
|
||||||
|
Please do not open a public issue for security problems.
|
||||||
|
|
||||||
|
Report privately by email: warkydevs@gmail.com
|
||||||
|
|
||||||
|
Reports are reviewed on a best-effort basis. No response time or fix timeline is
|
||||||
|
guaranteed. Reporters may be credited in the release notes if they wish.
|
||||||
@@ -4,20 +4,25 @@
|
|||||||
|
|
||||||
- [✔️] **Database Inspector**
|
- [✔️] **Database Inspector**
|
||||||
- [✔️] PostgreSQL driver (reader + writer)
|
- [✔️] PostgreSQL driver (reader + writer)
|
||||||
- [ ] MySQL driver
|
- [ ] MySQL driver (only MariaDB datatype conversion in pkg/mariadb, no reader/writer)
|
||||||
- [✔️] SQLite driver (reader + writer with automatic schema flattening)
|
- [✔️] SQLite driver (reader + writer with automatic schema flattening)
|
||||||
- [ ] MSSQL driver
|
- [✔️] MSSQL driver (reader + writer, generated and identity columns)
|
||||||
- [✔️] Foreign key detection
|
- [✔️] Foreign key detection
|
||||||
- [✔️] Index extraction
|
- [✔️] Index extraction
|
||||||
- [✔️] .sql file generation (PostgreSQL, SQLite)
|
- [✔️] .sql file generation (PostgreSQL, SQLite)
|
||||||
- [✔️] .dbml: Database Markup Language (DBML) for textual schema representation.
|
- [✔️] .dbml: Database Markup Language (DBML) for textual schema representation.
|
||||||
- [✔️] Prisma schema support (PSL format) .prisma
|
- [✔️] Prisma schema support (PSL format) .prisma
|
||||||
|
- [ ] Sequelize (Typescript/Javascript) (Use templates, 💲 Someone can do this, not me)
|
||||||
- [✔️] Drizzle ORM support .ts (TypeScript / JavaScript) (Mr. Edd wanted to move from Prisma to Drizzle. If you are bugs, you are welcome to do pull requests or issues)
|
- [✔️] Drizzle ORM support .ts (TypeScript / JavaScript) (Mr. Edd wanted to move from Prisma to Drizzle. If you are bugs, you are welcome to do pull requests or issues)
|
||||||
- [☠️] Entity Framework (.NET) model .edmx (Fuck no, EDMX files were bloated, verbose XML nightmares—hard to merge, error-prone, and a pain in teams. Microsoft wisely ditched them in EF Core for code-first. Classic overkill from old MS era.)
|
- [☠️] Entity Framework (.NET) model .edmx (Fuck no, EDMX files were bloated, verbose XML nightmares—hard to merge, error-prone, and a pain in teams. Microsoft wisely ditched them in EF Core for code-first. Classic overkill from old MS era.)
|
||||||
- [✔️] TypeORM support
|
- [✔️] TypeORM support
|
||||||
- [] .hbm.xml / schema.xml: Hibernate/Propel mappings (Java/PHP) (💲 Someone can do this, not me)
|
- [ ] .hbm.xml / schema.xml: Hibernate/Propel mappings (Java/PHP) (Use templates, 💲 Someone can do this, not me)
|
||||||
- [ ] Django models.py (Python classes), Sequelize migrations (JS) (💲 Someone can do this, not me)
|
- [ ] Django models.py (Python classes), Sequelize migrations (JS) (Use templates, 💲 Someone can do this, not me)
|
||||||
- [] .avsc: Avro schema (JSON format for data serialization) (💲 Someone can do this, not me)
|
- [ ] SQLAlchemy, Python (Use templates, 💲 Someone can do this, not me)
|
||||||
|
- [ ] .avsc: Avro schema (JSON format for data serialization) (Use templates, 💲 Someone can do this, not me)
|
||||||
|
- [ ] Rails schema in db/schema.rb (Use templates, 💲 Someone can do this, not me)
|
||||||
|
- [ ] Laravel migration (Use templates, 💲 Someone can do this, not me)
|
||||||
|
- [ ] Hibernate / JPA (Use templates, 💲 Someone can do this, not me)
|
||||||
- [✔️] GraphQL schema generation
|
- [✔️] GraphQL schema generation
|
||||||
|
|
||||||
## UI
|
## UI
|
||||||
@@ -39,13 +44,19 @@
|
|||||||
|
|
||||||
## Advanced Features
|
## Advanced Features
|
||||||
|
|
||||||
- [ ] Dry-run mode for validation
|
- [ ] Dry-run mode for validation (only `job run --dry-run`; not on convert/merge/split)
|
||||||
- [x] Diff tool for comparing specifications
|
- [✔️] Diff tool for comparing specifications
|
||||||
- [ ] Migration script generation
|
- [✔️] Migration script generation (PostgreSQL diff, live database by default for direct output)
|
||||||
- [ ] Custom type mapping configuration
|
- [ ] Custom type mapping configuration
|
||||||
- [ ] Batch processing support
|
- [ ] Batch processing support (partial: job files run named workflows via `relspec job run`)
|
||||||
- [ ] Watch mode for auto-regeneration
|
- [ ] Watch mode for auto-regeneration
|
||||||
|
|
||||||
|
## Distribution
|
||||||
|
|
||||||
|
- [ ] NSIS Windows installer
|
||||||
|
- [ ] Check https://git.warky.dev/wdevs/relspecgo/releases for new releases and prompt to update
|
||||||
|
- [ ] CI pipeline to build and publish the Windows installer
|
||||||
|
|
||||||
## Future Considerations
|
## Future Considerations
|
||||||
|
|
||||||
- [ ] Web UI for visual editing
|
- [ ] Web UI for visual editing
|
||||||
|
|||||||
+1
-1
@@ -844,7 +844,7 @@ func writeJobOutput(rj *resolvedJob, db *models.Database, lg *jobLogger) error {
|
|||||||
}
|
}
|
||||||
lg.logf("writing output to database env:%s", rj.outputConnEnv)
|
lg.logf("writing output to database env:%s", rj.outputConnEnv)
|
||||||
writerOpts := newWriterOptions("", o.Package, o.FlattenSchema, o.Types, o.ArrayNullable, o.ContinueOnError)
|
writerOpts := newWriterOptions("", o.Package, o.FlattenSchema, o.Types, o.ArrayNullable, o.ContinueOnError)
|
||||||
writerOpts.Metadata = map[string]interface{}{"connection_string": rj.outputConn}
|
writerOpts.Metadata = map[string]interface{}{"connection_string": rj.outputConn, "full_ddl": o.FullDDL}
|
||||||
return wpgsql.NewWriter(writerOpts).WriteDatabase(db)
|
return wpgsql.NewWriter(writerOpts).WriteDatabase(db)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -59,6 +59,7 @@ var (
|
|||||||
mergeSkipTables string // Comma-separated table names to skip
|
mergeSkipTables string // Comma-separated table names to skip
|
||||||
mergeVerbose bool
|
mergeVerbose bool
|
||||||
mergeReportPath string // Path to write merge report
|
mergeReportPath string // Path to write merge report
|
||||||
|
mergeFullDDL bool // Execute full DDL instead of diffing the live pgsql database
|
||||||
mergeFlattenSchema bool
|
mergeFlattenSchema bool
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -127,6 +128,7 @@ func init() {
|
|||||||
mergeCmd.Flags().BoolVar(&mergeSkipSequences, "skip-sequences", false, "Skip sequences during merge")
|
mergeCmd.Flags().BoolVar(&mergeSkipSequences, "skip-sequences", false, "Skip sequences during merge")
|
||||||
mergeCmd.Flags().StringVar(&mergeSkipTables, "skip-tables", "", "Comma-separated list of table names to skip during merge")
|
mergeCmd.Flags().StringVar(&mergeSkipTables, "skip-tables", "", "Comma-separated list of table names to skip during merge")
|
||||||
mergeCmd.Flags().BoolVar(&mergeVerbose, "verbose", false, "Show verbose output")
|
mergeCmd.Flags().BoolVar(&mergeVerbose, "verbose", false, "Show verbose output")
|
||||||
|
mergeCmd.Flags().BoolVar(&mergeFullDDL, "full-ddl", false, "pgsql database output: execute the full DDL instead of only the differences from the live database")
|
||||||
mergeCmd.Flags().StringVar(&mergeReportPath, "merge-report", "", "Path to write merge report (JSON format)")
|
mergeCmd.Flags().StringVar(&mergeReportPath, "merge-report", "", "Path to write merge report (JSON format)")
|
||||||
mergeCmd.Flags().BoolVar(&mergeFlattenSchema, "flatten-schema", false, "Flatten schema.table names to schema_table (useful for databases like SQLite that do not support schemas)")
|
mergeCmd.Flags().BoolVar(&mergeFlattenSchema, "flatten-schema", false, "Flatten schema.table names to schema_table (useful for databases like SQLite that do not support schemas)")
|
||||||
}
|
}
|
||||||
@@ -443,6 +445,7 @@ func writeDatabaseForMerge(dbType, filePath, connString string, db *models.Datab
|
|||||||
if connString != "" {
|
if connString != "" {
|
||||||
writerOpts.Metadata = map[string]interface{}{
|
writerOpts.Metadata = map[string]interface{}{
|
||||||
"connection_string": connString,
|
"connection_string": connString,
|
||||||
|
"full_ddl": mergeFullDDL,
|
||||||
}
|
}
|
||||||
// Add report path if merge report is enabled
|
// Add report path if merge report is enabled
|
||||||
if mergeReportPath != "" {
|
if mergeReportPath != "" {
|
||||||
|
|||||||
@@ -187,6 +187,8 @@ jobs:
|
|||||||
format: pgsql
|
format: pgsql
|
||||||
path: build/schema.sql # file output, OR:
|
path: build/schema.sql # file output, OR:
|
||||||
conn_env: TARGET_DB_URL # execute against DB (pgsql only)
|
conn_env: TARGET_DB_URL # execute against DB (pgsql only)
|
||||||
|
# default: reads live DB, executes only the diff
|
||||||
|
# (file output = full DDL); set options.full_ddl to force full DDL
|
||||||
overwrite: false # default false
|
overwrite: false # default false
|
||||||
options:
|
options:
|
||||||
flatten_schema: false
|
flatten_schema: false
|
||||||
@@ -195,6 +197,7 @@ jobs:
|
|||||||
types: sqltypes # Bun/GORM nullable types: baselib|stdlib|sqltypes
|
types: sqltypes # Bun/GORM nullable types: baselib|stdlib|sqltypes
|
||||||
array_nullable: pointer_slice # Bun: slice|pointer_slice
|
array_nullable: pointer_slice # Bun: slice|pointer_slice
|
||||||
continue_on_error: false # pgsql / scripts-exec output
|
continue_on_error: false # pgsql / scripts-exec output
|
||||||
|
full_ddl: false # pgsql database output: true = run full DDL; default diffs against live DB
|
||||||
skip_relations: false # merge only
|
skip_relations: false # merge only
|
||||||
skip_enums: false
|
skip_enums: false
|
||||||
skip_views: false
|
skip_views: false
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# Maintainer: Hein (Warky Devs) <hein@warky.dev>
|
# Maintainer: Hein (Warky Devs) <hein@warky.dev>
|
||||||
pkgname=relspec
|
pkgname=relspec
|
||||||
pkgver=1.0.84
|
pkgver=1.0.85
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc="RelSpec is a comprehensive database relations management tool that reads, transforms, and writes database table specifications across multiple formats and ORMs."
|
pkgdesc="RelSpec is a comprehensive database relations management tool that reads, transforms, and writes database table specifications across multiple formats and ORMs."
|
||||||
arch=('x86_64' 'aarch64')
|
arch=('x86_64' 'aarch64')
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
Name: relspec
|
Name: relspec
|
||||||
Version: 1.0.84
|
Version: 1.0.85
|
||||||
Release: 1%{?dist}
|
Release: 1%{?dist}
|
||||||
Summary: RelSpec is a comprehensive database relations management tool that reads, transforms, and writes database table specifications across multiple formats and ORMs.
|
Summary: RelSpec is a comprehensive database relations management tool that reads, transforms, and writes database table specifications across multiple formats and ORMs.
|
||||||
|
|
||||||
|
|||||||
+8
-5
@@ -285,11 +285,14 @@ type Options struct {
|
|||||||
Types string `yaml:"types"`
|
Types string `yaml:"types"`
|
||||||
ArrayNullable string `yaml:"array_nullable"`
|
ArrayNullable string `yaml:"array_nullable"`
|
||||||
ContinueOnError bool `yaml:"continue_on_error"`
|
ContinueOnError bool `yaml:"continue_on_error"`
|
||||||
SkipRelations bool `yaml:"skip_relations"`
|
// FullDDL makes direct pgsql output execute the full idempotent DDL instead of
|
||||||
SkipEnums bool `yaml:"skip_enums"`
|
// diffing against the live database first.
|
||||||
SkipViews bool `yaml:"skip_views"`
|
FullDDL bool `yaml:"full_ddl"`
|
||||||
SkipDomains bool `yaml:"skip_domains"`
|
SkipRelations bool `yaml:"skip_relations"`
|
||||||
SkipSequences bool `yaml:"skip_sequences"`
|
SkipEnums bool `yaml:"skip_enums"`
|
||||||
|
SkipViews bool `yaml:"skip_views"`
|
||||||
|
SkipDomains bool `yaml:"skip_domains"`
|
||||||
|
SkipSequences bool `yaml:"skip_sequences"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Dir returns the directory that a job's relative paths resolve against:
|
// Dir returns the directory that a job's relative paths resolve against:
|
||||||
|
|||||||
@@ -64,6 +64,8 @@ The reader recognizes the following Bun struct tags:
|
|||||||
- `autoincrement` - Auto-increment column
|
- `autoincrement` - Auto-increment column
|
||||||
- `default` - Default value
|
- `default` - Default value
|
||||||
- `unique` - Unique constraint
|
- `unique` - Unique constraint
|
||||||
|
- `generated` - Generated column marker (`Generated`; expression is not in the tag)
|
||||||
|
- `identity` - Identity column marker (`Identity`, `ALWAYS`)
|
||||||
- `rel` - Relationship definition
|
- `rel` - Relationship definition
|
||||||
|
|
||||||
## Example Bun Model
|
## Example Bun Model
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
package bun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestReader_GeneratedAndIdentityMarkers(t *testing.T) {
|
||||||
|
src := `package models
|
||||||
|
|
||||||
|
import "github.com/uptrace/bun"
|
||||||
|
|
||||||
|
type Person struct {
|
||||||
|
bun.BaseModel ` + "`bun:\"table:people,alias:p\"`" + `
|
||||||
|
|
||||||
|
ID int64 ` + "`bun:\"id,pk,type:bigint,autoincrement,identity\"`" + `
|
||||||
|
Seq int64 ` + "`bun:\"seq,type:bigint,scanonly,identity,notnull\"`" + `
|
||||||
|
FullName string ` + "`bun:\"full_name,type:text,scanonly,generated,nullzero\"`" + `
|
||||||
|
First string ` + "`bun:\"first,type:text,nullzero\"`" + `
|
||||||
|
}
|
||||||
|
`
|
||||||
|
path := filepath.Join(t.TempDir(), "person.go")
|
||||||
|
if err := os.WriteFile(path, []byte(src), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
db, err := NewReader(&readers.ReaderOptions{FilePath: path}).ReadDatabase()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadDatabase() error = %v", err)
|
||||||
|
}
|
||||||
|
cols := db.Schemas[0].Tables[0].Columns
|
||||||
|
|
||||||
|
if !cols["id"].Identity || cols["id"].IdentityGeneration != "ALWAYS" {
|
||||||
|
t.Errorf("id: identity = %v/%q, want true/ALWAYS", cols["id"].Identity, cols["id"].IdentityGeneration)
|
||||||
|
}
|
||||||
|
if !cols["seq"].Identity || cols["seq"].IdentityGeneration != "ALWAYS" {
|
||||||
|
t.Errorf("seq: identity = %v/%q, want true/ALWAYS", cols["seq"].Identity, cols["seq"].IdentityGeneration)
|
||||||
|
}
|
||||||
|
if !cols["full_name"].Generated {
|
||||||
|
t.Error("full_name should be generated")
|
||||||
|
}
|
||||||
|
if cols["first"].Generated || cols["first"].Identity {
|
||||||
|
t.Error("first must be an ordinary column")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -659,6 +659,13 @@ func (r *Reader) parseColumn(fieldName string, fieldType ast.Expr, tag string, s
|
|||||||
hasExplicitNullableMarker = true
|
hasExplicitNullableMarker = true
|
||||||
case "autoincrement":
|
case "autoincrement":
|
||||||
column.AutoIncrement = true
|
column.AutoIncrement = true
|
||||||
|
case "generated":
|
||||||
|
// GENERATED ... STORED marker written by the Bun writer; the expression is not in the tag
|
||||||
|
column.Generated = true
|
||||||
|
case "identity":
|
||||||
|
// GENERATED ALWAYS AS IDENTITY marker written by the Bun writer
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = "ALWAYS"
|
||||||
case "default":
|
case "default":
|
||||||
// Default value from Bun tag (e.g., default:gen_random_uuid())
|
// Default value from Bun tag (e.g., default:gen_random_uuid())
|
||||||
column.Default = value
|
column.Default = value
|
||||||
|
|||||||
@@ -157,6 +157,7 @@ grammar and the supported-directive matrix.
|
|||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
- Column notes `GENERATED ALWAYS AS (expr) STORED` and `GENERATED ALWAYS|BY DEFAULT AS IDENTITY` set `Generated`/`GenerationExpression` and `Identity`/`IdentityGeneration`; they are not kept as comments
|
||||||
- DBML is designed for database documentation and diagramming
|
- DBML is designed for database documentation and diagramming
|
||||||
- Schema name defaults to `public`
|
- Schema name defaults to `public`
|
||||||
- Relationship cardinality is preserved
|
- Relationship cardinality is preserved
|
||||||
|
|||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package dbml
|
||||||
|
|
||||||
|
import (
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
generatedNoteRegex = regexp.MustCompile(`(?is)^GENERATED\s+ALWAYS\s+AS\s*\((.*)\)\s*STORED$`)
|
||||||
|
identityNoteRegex = regexp.MustCompile(`(?i)^GENERATED\s+(ALWAYS|BY\s+DEFAULT)\s+AS\s+IDENTITY$`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// applyColumnMarkerNote interprets a column note written by the DBML writer for
|
||||||
|
// GENERATED ... STORED and GENERATED ... AS IDENTITY columns, setting the matching
|
||||||
|
// model fields. It returns true when the note was a marker, in which case it is not
|
||||||
|
// a user comment.
|
||||||
|
func applyColumnMarkerNote(column *models.Column, rawNote string) bool {
|
||||||
|
note := strings.TrimSpace(rawNote)
|
||||||
|
if len(note) >= 2 && (note[0] == '\'' || note[0] == '"') && note[len(note)-1] == note[0] {
|
||||||
|
note = note[1 : len(note)-1]
|
||||||
|
}
|
||||||
|
note = strings.ReplaceAll(strings.ReplaceAll(note, `\'`, `'`), `\\`, `\`)
|
||||||
|
note = strings.TrimSpace(note)
|
||||||
|
|
||||||
|
if m := generatedNoteRegex.FindStringSubmatch(note); m != nil {
|
||||||
|
column.Generated = true
|
||||||
|
column.GenerationExpression = strings.TrimSpace(m[1])
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if m := identityNoteRegex.FindStringSubmatch(note); m != nil {
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = strings.Join(strings.Fields(strings.ToUpper(m[1])), " ")
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -804,7 +804,9 @@ func (r *Reader) parseColumn(line, tableName, schemaName string) (*models.Column
|
|||||||
} else if strings.HasPrefix(attr, "note:") {
|
} else if strings.HasPrefix(attr, "note:") {
|
||||||
// Parse column note/comment
|
// Parse column note/comment
|
||||||
note := strings.TrimSpace(strings.TrimPrefix(attr, "note:"))
|
note := strings.TrimSpace(strings.TrimPrefix(attr, "note:"))
|
||||||
column.Comment = strings.Trim(note, "'\"")
|
if !applyColumnMarkerNote(column, note) {
|
||||||
|
column.Comment = strings.Trim(note, "'\"")
|
||||||
|
}
|
||||||
} else if strings.HasPrefix(attr, "ref:") {
|
} else if strings.HasPrefix(attr, "ref:") {
|
||||||
// Parse inline reference
|
// Parse inline reference
|
||||||
// DBML semantics depend on context:
|
// DBML semantics depend on context:
|
||||||
|
|||||||
@@ -85,6 +85,7 @@ export const postsRelations = relations(posts, ({ one }) => ({
|
|||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
- `.generatedAlwaysAs(sql`expr`)` sets `Generated` + `GenerationExpression`; `.generatedAlwaysAsIdentity()` / `.generatedByDefaultAsIdentity()` set `Identity` + `IdentityGeneration`
|
||||||
- Supports both PostgreSQL and MySQL Drizzle schemas
|
- Supports both PostgreSQL and MySQL Drizzle schemas
|
||||||
- Extracts relationship information from `relations` definitions
|
- Extracts relationship information from `relations` definitions
|
||||||
- Schema defaults to `public` for PostgreSQL
|
- Schema defaults to `public` for PostgreSQL
|
||||||
|
|||||||
@@ -495,9 +495,24 @@ func (r *Reader) parseColumnModifiers(line string, column *models.Column, table
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check for .generatedAlwaysAsIdentity()
|
// Check for .generatedAlwaysAsIdentity() / .generatedByDefaultAsIdentity()
|
||||||
if strings.Contains(line, ".generatedAlwaysAsIdentity()") {
|
if strings.Contains(line, ".generatedAlwaysAsIdentity()") {
|
||||||
column.AutoIncrement = true
|
column.AutoIncrement = true
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = "ALWAYS"
|
||||||
|
}
|
||||||
|
if strings.Contains(line, ".generatedByDefaultAsIdentity()") {
|
||||||
|
column.AutoIncrement = true
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = "BY DEFAULT"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check for .generatedAlwaysAs(sql`expr`) (generated column)
|
||||||
|
if idx := strings.Index(line, ".generatedAlwaysAs("); idx != -1 {
|
||||||
|
if expr, ok := parseGeneratedAlwaysAs(line[idx+len(".generatedAlwaysAs("):]); ok {
|
||||||
|
column.Generated = true
|
||||||
|
column.GenerationExpression = expr
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check for .references(() => otherTable.column)
|
// Check for .references(() => otherTable.column)
|
||||||
@@ -615,3 +630,34 @@ func (r *Reader) varNameToTableName(varName string) string {
|
|||||||
// For now, assume variable name matches table name
|
// For now, assume variable name matches table name
|
||||||
return varName
|
return varName
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// parseGeneratedAlwaysAs extracts the SQL expression from the argument list of
|
||||||
|
// generatedAlwaysAs(...), which follows the opening parenthesis in rest. The expression is
|
||||||
|
// the contents of a sql`...` template (backticks inside it are escaped with a backslash)
|
||||||
|
// or, failing that, a quoted string.
|
||||||
|
func parseGeneratedAlwaysAs(rest string) (string, bool) {
|
||||||
|
rest = strings.TrimSpace(rest)
|
||||||
|
rest = strings.TrimPrefix(rest, "sql")
|
||||||
|
if rest == "" {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
quote := rest[0]
|
||||||
|
if quote != '`' && quote != '\'' && quote != '"' {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
var sb strings.Builder
|
||||||
|
for i := 1; i < len(rest); i++ {
|
||||||
|
ch := rest[i]
|
||||||
|
if ch == '\\' && i+1 < len(rest) {
|
||||||
|
i++
|
||||||
|
sb.WriteByte(rest[i])
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if ch == quote {
|
||||||
|
return strings.TrimSpace(sb.String()), true
|
||||||
|
}
|
||||||
|
sb.WriteByte(ch)
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|||||||
@@ -78,6 +78,8 @@ The reader recognizes the following GORM struct tags:
|
|||||||
- `not null` - NOT NULL constraint
|
- `not null` - NOT NULL constraint
|
||||||
- `autoIncrement` - Auto-increment column
|
- `autoIncrement` - Auto-increment column
|
||||||
- `default` - Default value
|
- `default` - Default value
|
||||||
|
- `generated` - Generated column marker (`Generated`; expression is not in the tag)
|
||||||
|
- `identity` - Identity column marker (`Identity`, `ALWAYS`)
|
||||||
- `size` - Column size/length
|
- `size` - Column size/length
|
||||||
- `index` - Create index
|
- `index` - Create index
|
||||||
- `uniqueIndex` - Create unique index
|
- `uniqueIndex` - Create unique index
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
package gorm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestReader_GeneratedAndIdentityMarkers(t *testing.T) {
|
||||||
|
src := `package models
|
||||||
|
|
||||||
|
type Person struct {
|
||||||
|
ID int64 ` + "`gorm:\"column:id;primaryKey;autoIncrement;type:bigint;identity\"`" + `
|
||||||
|
Seq int64 ` + "`gorm:\"column:seq;type:bigint;<-:false;identity;not null\"`" + `
|
||||||
|
FullName string ` + "`gorm:\"column:full_name;type:text;<-:false;generated\"`" + `
|
||||||
|
First string ` + "`gorm:\"column:first;type:text\"`" + `
|
||||||
|
}
|
||||||
|
|
||||||
|
func (Person) TableName() string {
|
||||||
|
return "people"
|
||||||
|
}
|
||||||
|
`
|
||||||
|
path := filepath.Join(t.TempDir(), "person.go")
|
||||||
|
if err := os.WriteFile(path, []byte(src), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
db, err := NewReader(&readers.ReaderOptions{FilePath: path}).ReadDatabase()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadDatabase() error = %v", err)
|
||||||
|
}
|
||||||
|
cols := db.Schemas[0].Tables[0].Columns
|
||||||
|
|
||||||
|
if !cols["id"].Identity || cols["id"].IdentityGeneration != "ALWAYS" {
|
||||||
|
t.Errorf("id: identity = %v/%q, want true/ALWAYS", cols["id"].Identity, cols["id"].IdentityGeneration)
|
||||||
|
}
|
||||||
|
if !cols["seq"].Identity {
|
||||||
|
t.Error("seq should be identity")
|
||||||
|
}
|
||||||
|
if !cols["full_name"].Generated {
|
||||||
|
t.Error("full_name should be generated")
|
||||||
|
}
|
||||||
|
if cols["first"].Generated || cols["first"].Identity {
|
||||||
|
t.Error("first must be an ordinary column")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -726,6 +726,15 @@ func (r *Reader) parseColumn(fieldName string, fieldType ast.Expr, tag string, s
|
|||||||
if _, ok := parts["autoincrement"]; ok {
|
if _, ok := parts["autoincrement"]; ok {
|
||||||
column.AutoIncrement = true
|
column.AutoIncrement = true
|
||||||
}
|
}
|
||||||
|
if _, ok := parts["generated"]; ok {
|
||||||
|
// GENERATED ... STORED marker written by the GORM writer; the expression is not in the tag
|
||||||
|
column.Generated = true
|
||||||
|
}
|
||||||
|
if _, ok := parts["identity"]; ok {
|
||||||
|
// GENERATED ALWAYS AS IDENTITY marker written by the GORM writer
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = "ALWAYS"
|
||||||
|
}
|
||||||
if def, ok := parts["default"]; ok {
|
if def, ok := parts["default"]; ok {
|
||||||
// Default value from GORM tag (e.g., default:gen_random_uuid())
|
// Default value from GORM tag (e.g., default:gen_random_uuid())
|
||||||
column.Default = def
|
column.Default = def
|
||||||
|
|||||||
@@ -25,6 +25,11 @@ sqlserver://user:pass@192.168.1.100:1433/production
|
|||||||
sqlserver://localhost/testdb?encrypt=disable
|
sqlserver://localhost/testdb?encrypt=disable
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Computed and Identity Columns
|
||||||
|
|
||||||
|
- `sys.computed_columns` -> `Generated` + `GenerationExpression` (outer parentheses removed; persisted or not)
|
||||||
|
- Identity columns -> `Identity` + `IdentityGeneration = ALWAYS`
|
||||||
|
|
||||||
## Supported Constraints
|
## Supported Constraints
|
||||||
|
|
||||||
- Primary Keys
|
- Primary Keys
|
||||||
|
|||||||
@@ -104,8 +104,12 @@ func (r *Reader) queryColumns(schemaName string) (map[string]map[string]*models.
|
|||||||
c.numeric_precision,
|
c.numeric_precision,
|
||||||
c.numeric_scale,
|
c.numeric_scale,
|
||||||
ISNULL(ep.value, '') as description,
|
ISNULL(ep.value, '') as description,
|
||||||
COLUMNPROPERTY(OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name)), c.column_name, 'IsIdentity') as is_identity
|
COLUMNPROPERTY(OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name)), c.column_name, 'IsIdentity') as is_identity,
|
||||||
|
cc.definition as computed_definition
|
||||||
FROM information_schema.columns c
|
FROM information_schema.columns c
|
||||||
|
LEFT JOIN sys.computed_columns cc
|
||||||
|
ON cc.object_id = OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name))
|
||||||
|
AND cc.name = c.column_name
|
||||||
LEFT JOIN sys.extended_properties ep
|
LEFT JOIN sys.extended_properties ep
|
||||||
ON ep.major_id = OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name))
|
ON ep.major_id = OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name))
|
||||||
AND ep.minor_id = COLUMNPROPERTY(OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name)), c.column_name, 'ColumnId')
|
AND ep.minor_id = COLUMNPROPERTY(OBJECT_ID(QUOTENAME(c.table_schema) + '.' + QUOTENAME(c.table_name)), c.column_name, 'ColumnId')
|
||||||
@@ -127,8 +131,9 @@ func (r *Reader) queryColumns(schemaName string) (map[string]map[string]*models.
|
|||||||
var schema, tableName, columnName, isNullable, dataType, description string
|
var schema, tableName, columnName, isNullable, dataType, description string
|
||||||
var ordinalPosition int
|
var ordinalPosition int
|
||||||
var columnDefault, charMaxLength, numPrecision, numScale, isIdentity *int
|
var columnDefault, charMaxLength, numPrecision, numScale, isIdentity *int
|
||||||
|
var computedDefinition *string
|
||||||
|
|
||||||
if err := rows.Scan(&schema, &tableName, &columnName, &ordinalPosition, &columnDefault, &isNullable, &dataType, &charMaxLength, &numPrecision, &numScale, &description, &isIdentity); err != nil {
|
if err := rows.Scan(&schema, &tableName, &columnName, &ordinalPosition, &columnDefault, &isNullable, &dataType, &charMaxLength, &numPrecision, &numScale, &description, &isIdentity, &computedDefinition); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -144,6 +149,14 @@ func (r *Reader) queryColumns(schemaName string) (map[string]map[string]*models.
|
|||||||
// Check if this is an identity column (auto-increment)
|
// Check if this is an identity column (auto-increment)
|
||||||
if isIdentity != nil && *isIdentity == 1 {
|
if isIdentity != nil && *isIdentity == 1 {
|
||||||
column.AutoIncrement = true
|
column.AutoIncrement = true
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = "ALWAYS"
|
||||||
|
}
|
||||||
|
|
||||||
|
// Computed columns report their expression wrapped in an extra pair of parentheses
|
||||||
|
if computedDefinition != nil && strings.TrimSpace(*computedDefinition) != "" {
|
||||||
|
column.Generated = true
|
||||||
|
column.GenerationExpression = trimOuterParens(*computedDefinition)
|
||||||
}
|
}
|
||||||
|
|
||||||
if charMaxLength != nil && *charMaxLength > 0 {
|
if charMaxLength != nil && *charMaxLength > 0 {
|
||||||
@@ -414,3 +427,25 @@ func (r *Reader) queryIndexes(schemaName string) (map[string][]*models.Index, er
|
|||||||
|
|
||||||
return indexes, rows.Err()
|
return indexes, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// trimOuterParens removes one pair of parentheses wrapping the whole expression, as
|
||||||
|
// SQL Server stores computed column definitions.
|
||||||
|
func trimOuterParens(expr string) string {
|
||||||
|
expr = strings.TrimSpace(expr)
|
||||||
|
if len(expr) < 2 || expr[0] != '(' || expr[len(expr)-1] != ')' {
|
||||||
|
return expr
|
||||||
|
}
|
||||||
|
depth := 0
|
||||||
|
for i := 0; i < len(expr); i++ {
|
||||||
|
switch expr[i] {
|
||||||
|
case '(':
|
||||||
|
depth++
|
||||||
|
case ')':
|
||||||
|
depth--
|
||||||
|
if depth == 0 && i != len(expr)-1 {
|
||||||
|
return expr
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(expr[1 : len(expr)-1])
|
||||||
|
}
|
||||||
|
|||||||
@@ -85,3 +85,18 @@ func TestConvertMSSQLToCanonical(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTrimOuterParens(t *testing.T) {
|
||||||
|
tests := map[string]string{
|
||||||
|
"(([a])+([b]))": "([a])+([b])",
|
||||||
|
"([a]+[b])": "[a]+[b]",
|
||||||
|
"([a])+([b])": "([a])+([b])",
|
||||||
|
"[a]+[b]": "[a]+[b]",
|
||||||
|
" (upper([a])) ": "upper([a])",
|
||||||
|
}
|
||||||
|
for in, want := range tests {
|
||||||
|
if got := trimOuterParens(in); got != want {
|
||||||
|
t.Errorf("trimOuterParens(%q) = %q, want %q", in, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -422,31 +422,35 @@ func (r *Reader) queryPrimaryKeys(schemaName string) (map[string]*models.Constra
|
|||||||
// queryForeignKeys retrieves all foreign key constraints for a schema
|
// queryForeignKeys retrieves all foreign key constraints for a schema
|
||||||
// Returns map[schema.table][]*Constraint
|
// Returns map[schema.table][]*Constraint
|
||||||
func (r *Reader) queryForeignKeys(schemaName string) (map[string][]*models.Constraint, error) {
|
func (r *Reader) queryForeignKeys(schemaName string) (map[string][]*models.Constraint, error) {
|
||||||
|
// Columns are paired by position from pg_constraint so composite keys are not
|
||||||
|
// cross-joined (information_schema.constraint_column_usage has no ordering).
|
||||||
|
actionCase := func(col string) string {
|
||||||
|
return `CASE ` + col + ` WHEN 'a' THEN 'NO ACTION' WHEN 'r' THEN 'RESTRICT' WHEN 'c' THEN 'CASCADE' WHEN 'n' THEN 'SET NULL' WHEN 'd' THEN 'SET DEFAULT' END`
|
||||||
|
}
|
||||||
query := `
|
query := `
|
||||||
SELECT
|
SELECT
|
||||||
tc.table_schema,
|
ns.nspname AS table_schema,
|
||||||
tc.table_name,
|
cl.relname AS table_name,
|
||||||
tc.constraint_name,
|
con.conname AS constraint_name,
|
||||||
kcu.table_schema as foreign_table_schema,
|
ns.nspname AS foreign_table_schema,
|
||||||
kcu.table_name as foreign_table_name,
|
cl.relname AS foreign_table_name,
|
||||||
kcu.column_name as foreign_column,
|
att.attname AS foreign_column,
|
||||||
ccu.table_schema as referenced_table_schema,
|
fns.nspname AS referenced_table_schema,
|
||||||
ccu.table_name as referenced_table_name,
|
fcl.relname AS referenced_table_name,
|
||||||
ccu.column_name as referenced_column,
|
fatt.attname AS referenced_column,
|
||||||
rc.update_rule,
|
` + actionCase("con.confupdtype") + ` AS update_rule,
|
||||||
rc.delete_rule
|
` + actionCase("con.confdeltype") + ` AS delete_rule
|
||||||
FROM information_schema.table_constraints tc
|
FROM pg_catalog.pg_constraint con
|
||||||
JOIN information_schema.key_column_usage kcu
|
JOIN pg_catalog.pg_class cl ON cl.oid = con.conrelid
|
||||||
ON tc.constraint_name = kcu.constraint_name
|
JOIN pg_catalog.pg_namespace ns ON ns.oid = cl.relnamespace
|
||||||
AND tc.table_schema = kcu.table_schema
|
JOIN pg_catalog.pg_class fcl ON fcl.oid = con.confrelid
|
||||||
JOIN information_schema.constraint_column_usage ccu
|
JOIN pg_catalog.pg_namespace fns ON fns.oid = fcl.relnamespace
|
||||||
ON ccu.constraint_name = tc.constraint_name
|
CROSS JOIN LATERAL unnest(con.conkey, con.confkey) WITH ORDINALITY AS k(attnum, fattnum, ord)
|
||||||
JOIN information_schema.referential_constraints rc
|
JOIN pg_catalog.pg_attribute att ON att.attrelid = con.conrelid AND att.attnum = k.attnum
|
||||||
ON rc.constraint_name = tc.constraint_name
|
JOIN pg_catalog.pg_attribute fatt ON fatt.attrelid = con.confrelid AND fatt.attnum = k.fattnum
|
||||||
AND rc.constraint_schema = tc.table_schema
|
WHERE con.contype = 'f'
|
||||||
WHERE tc.constraint_type = 'FOREIGN KEY'
|
AND ns.nspname = $1
|
||||||
AND tc.table_schema = $1
|
ORDER BY ns.nspname, cl.relname, con.conname, k.ord
|
||||||
ORDER BY tc.table_schema, tc.table_name, tc.constraint_name, kcu.ordinal_position
|
|
||||||
`
|
`
|
||||||
|
|
||||||
rows, err := r.conn.Query(r.ctx, query, schemaName)
|
rows, err := r.conn.Query(r.ctx, query, schemaName)
|
||||||
|
|||||||
@@ -1,10 +1,14 @@
|
|||||||
package pgsql
|
package pgsql
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
"os"
|
"os"
|
||||||
"reflect"
|
"reflect"
|
||||||
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
|
||||||
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
)
|
)
|
||||||
@@ -499,3 +503,60 @@ func TestMapDataType_ExtensionTypesPreserveModifiers(t *testing.T) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestReader_CompositeForeignKeyColumnsArePairedOnce(t *testing.T) {
|
||||||
|
connStr := getTestConnectionString(t)
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
conn, err := pgx.Connect(ctx, connStr)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("connect: %v", err)
|
||||||
|
}
|
||||||
|
defer conn.Close(ctx)
|
||||||
|
|
||||||
|
const schema = "relspec_fk_test"
|
||||||
|
setup := []string{
|
||||||
|
"DROP SCHEMA IF EXISTS " + schema + " CASCADE",
|
||||||
|
"CREATE SCHEMA " + schema,
|
||||||
|
"CREATE TABLE " + schema + ".parent (a int, b int, PRIMARY KEY (a, b))",
|
||||||
|
"CREATE TABLE " + schema + ".child (x int, y int, CONSTRAINT fk_child_parent FOREIGN KEY (x, y) REFERENCES " + schema + ".parent (a, b) ON DELETE CASCADE)",
|
||||||
|
}
|
||||||
|
for _, stmt := range setup {
|
||||||
|
if _, err := conn.Exec(ctx, stmt); err != nil {
|
||||||
|
t.Fatalf("setup %q: %v", stmt, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
defer conn.Exec(ctx, "DROP SCHEMA IF EXISTS "+schema+" CASCADE")
|
||||||
|
|
||||||
|
reader := NewReader(&readers.ReaderOptions{ConnectionString: connStr})
|
||||||
|
db, err := reader.ReadDatabase()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("ReadDatabase: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, s := range db.Schemas {
|
||||||
|
if s.Name != schema {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
for _, tbl := range s.Tables {
|
||||||
|
if tbl.Name != "child" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
fk := tbl.Constraints["fk_child_parent"]
|
||||||
|
if fk == nil {
|
||||||
|
t.Fatal("foreign key fk_child_parent not read")
|
||||||
|
}
|
||||||
|
if got := strings.Join(fk.Columns, ","); got != "x,y" {
|
||||||
|
t.Errorf("columns = %q, want x,y", got)
|
||||||
|
}
|
||||||
|
if got := strings.Join(fk.ReferencedColumns, ","); got != "a,b" {
|
||||||
|
t.Errorf("referenced columns = %q, want a,b", got)
|
||||||
|
}
|
||||||
|
if fk.OnDelete != "CASCADE" || fk.OnUpdate != "NO ACTION" {
|
||||||
|
t.Errorf("rules = %s/%s, want CASCADE/NO ACTION", fk.OnDelete, fk.OnUpdate)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
t.Fatal("test schema/table not found in read result")
|
||||||
|
}
|
||||||
|
|||||||
@@ -40,6 +40,7 @@ options := &readers.ReaderOptions{
|
|||||||
- Uses pure Go driver (modernc.org/sqlite) - no CGo required
|
- Uses pure Go driver (modernc.org/sqlite) - no CGo required
|
||||||
- Supports both file path and connection string
|
- Supports both file path and connection string
|
||||||
- Auto-increment detection for INTEGER PRIMARY KEY columns
|
- Auto-increment detection for INTEGER PRIMARY KEY columns
|
||||||
|
- Generated columns (virtual and stored) are read via `PRAGMA table_xinfo`; the expression is parsed from the `CREATE TABLE` SQL
|
||||||
- Foreign keys require `PRAGMA foreign_keys = ON` to be set
|
- Foreign keys require `PRAGMA foreign_keys = ON` to be set
|
||||||
|
|
||||||
## Example Schema
|
## Example Schema
|
||||||
|
|||||||
@@ -0,0 +1,116 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"regexp"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
var generatedAsRegex = regexp.MustCompile(`(?is)\bAS\s*\(`)
|
||||||
|
|
||||||
|
// parseGeneratedExpression extracts the expression of a generated column from a CREATE
|
||||||
|
// TABLE statement, e.g. `full TEXT GENERATED ALWAYS AS (a || b) STORED` yields `a || b`.
|
||||||
|
// It returns "" when the column or its expression cannot be found.
|
||||||
|
func parseGeneratedExpression(createSQL, columnName string) string {
|
||||||
|
open := strings.Index(createSQL, "(")
|
||||||
|
if open < 0 {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, def := range splitTopLevel(createSQL[open+1:]) {
|
||||||
|
if !strings.EqualFold(firstIdentifier(def), columnName) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
loc := generatedAsRegex.FindStringIndex(def)
|
||||||
|
if loc == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return balancedParens(def[loc[1]-1:])
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// splitTopLevel splits a table body on commas that are outside parentheses and quotes,
|
||||||
|
// stopping at the parenthesis that closes the body.
|
||||||
|
func splitTopLevel(body string) []string {
|
||||||
|
var parts []string
|
||||||
|
depth := 0
|
||||||
|
var quote byte
|
||||||
|
start := 0
|
||||||
|
for i := 0; i < len(body); i++ {
|
||||||
|
ch := body[i]
|
||||||
|
if quote != 0 {
|
||||||
|
if ch == quote {
|
||||||
|
quote = 0
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch ch {
|
||||||
|
case '\'', '"', '`':
|
||||||
|
quote = ch
|
||||||
|
case '[':
|
||||||
|
quote = ']'
|
||||||
|
case '(':
|
||||||
|
depth++
|
||||||
|
case ')':
|
||||||
|
if depth == 0 {
|
||||||
|
return append(parts, body[start:i])
|
||||||
|
}
|
||||||
|
depth--
|
||||||
|
case ',':
|
||||||
|
if depth == 0 {
|
||||||
|
parts = append(parts, body[start:i])
|
||||||
|
start = i + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return append(parts, body[start:])
|
||||||
|
}
|
||||||
|
|
||||||
|
// firstIdentifier returns the first (possibly quoted) identifier of a column definition.
|
||||||
|
func firstIdentifier(def string) string {
|
||||||
|
def = strings.TrimSpace(def)
|
||||||
|
if def == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
switch def[0] {
|
||||||
|
case '"', '\'', '`':
|
||||||
|
if end := strings.IndexByte(def[1:], def[0]); end >= 0 {
|
||||||
|
return def[1 : 1+end]
|
||||||
|
}
|
||||||
|
case '[':
|
||||||
|
if end := strings.IndexByte(def, ']'); end >= 0 {
|
||||||
|
return def[1:end]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if end := strings.IndexAny(def, " \t\r\n"); end >= 0 {
|
||||||
|
return def[:end]
|
||||||
|
}
|
||||||
|
return def
|
||||||
|
}
|
||||||
|
|
||||||
|
// balancedParens returns the text inside the parenthesis group that starts at s[0].
|
||||||
|
func balancedParens(s string) string {
|
||||||
|
depth := 0
|
||||||
|
var quote byte
|
||||||
|
for i := 0; i < len(s); i++ {
|
||||||
|
ch := s[i]
|
||||||
|
if quote != 0 {
|
||||||
|
if ch == quote {
|
||||||
|
quote = 0
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch ch {
|
||||||
|
case '\'', '"':
|
||||||
|
quote = ch
|
||||||
|
case '(':
|
||||||
|
depth++
|
||||||
|
case ')':
|
||||||
|
depth--
|
||||||
|
if depth == 0 {
|
||||||
|
return strings.TrimSpace(s[1:i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
package sqlite
|
||||||
|
|
||||||
|
import (
|
||||||
|
"database/sql"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestParseGeneratedExpression(t *testing.T) {
|
||||||
|
createSQL := `CREATE TABLE people (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
"first" TEXT,
|
||||||
|
last TEXT,
|
||||||
|
full_name TEXT GENERATED ALWAYS AS (coalesce("first", '') || ' ' || last) STORED,
|
||||||
|
initials TEXT AS (substr("first", 1, 1) || substr(last, 1, 1)),
|
||||||
|
plain TEXT NOT NULL
|
||||||
|
)`
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
column string
|
||||||
|
want string
|
||||||
|
}{
|
||||||
|
{"full_name", `coalesce("first", '') || ' ' || last`},
|
||||||
|
{"initials", `substr("first", 1, 1) || substr(last, 1, 1)`},
|
||||||
|
{"plain", ""},
|
||||||
|
{"missing", ""},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.column, func(t *testing.T) {
|
||||||
|
assert.Equal(t, tt.want, parseGeneratedExpression(createSQL, tt.column))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestReader_GeneratedColumns(t *testing.T) {
|
||||||
|
dbPath := filepath.Join(t.TempDir(), "gen.db")
|
||||||
|
db, err := sql.Open("sqlite", dbPath)
|
||||||
|
require.NoError(t, err)
|
||||||
|
_, err = db.Exec(`CREATE TABLE people (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
first TEXT,
|
||||||
|
last TEXT,
|
||||||
|
full_name TEXT GENERATED ALWAYS AS (first || ' ' || last) STORED,
|
||||||
|
initials TEXT AS (substr(first, 1, 1) || substr(last, 1, 1))
|
||||||
|
)`)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, db.Close())
|
||||||
|
|
||||||
|
got, err := NewReader(&readers.ReaderOptions{FilePath: dbPath}).ReadDatabase()
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
cols := got.Schemas[0].Tables[0].Columns
|
||||||
|
require.Contains(t, cols, "full_name", "generated columns must be read")
|
||||||
|
assert.True(t, cols["full_name"].Generated)
|
||||||
|
assert.Equal(t, "first || ' ' || last", cols["full_name"].GenerationExpression)
|
||||||
|
assert.True(t, cols["initials"].Generated)
|
||||||
|
assert.Equal(t, "substr(first, 1, 1) || substr(last, 1, 1)", cols["initials"].GenerationExpression)
|
||||||
|
assert.False(t, cols["first"].Generated)
|
||||||
|
}
|
||||||
@@ -75,7 +75,8 @@ func (r *Reader) queryViews() ([]*models.View, error) {
|
|||||||
|
|
||||||
// queryColumns retrieves all columns for a given table or view
|
// queryColumns retrieves all columns for a given table or view
|
||||||
func (r *Reader) queryColumns(tableName string) (map[string]*models.Column, error) {
|
func (r *Reader) queryColumns(tableName string) (map[string]*models.Column, error) {
|
||||||
query := fmt.Sprintf("PRAGMA table_info(%s)", tableName)
|
// table_xinfo, unlike table_info, also lists generated columns (hidden = 2 virtual, 3 stored)
|
||||||
|
query := fmt.Sprintf("PRAGMA table_xinfo(%s)", tableName)
|
||||||
|
|
||||||
rows, err := r.db.QueryContext(r.ctx, query)
|
rows, err := r.db.QueryContext(r.ctx, query)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -84,24 +85,38 @@ func (r *Reader) queryColumns(tableName string) (map[string]*models.Column, erro
|
|||||||
defer rows.Close()
|
defer rows.Close()
|
||||||
|
|
||||||
columns := make(map[string]*models.Column)
|
columns := make(map[string]*models.Column)
|
||||||
|
var tableSQL string
|
||||||
|
tableSQLLoaded := false
|
||||||
|
|
||||||
for rows.Next() {
|
for rows.Next() {
|
||||||
var cid int
|
var cid int
|
||||||
var name, dataType string
|
var name, dataType string
|
||||||
var notNull, pk int
|
var notNull, pk, hidden int
|
||||||
var defaultValue *string
|
var defaultValue *string
|
||||||
|
|
||||||
if err := rows.Scan(&cid, &name, &dataType, ¬Null, &defaultValue, &pk); err != nil {
|
if err := rows.Scan(&cid, &name, &dataType, ¬Null, &defaultValue, &pk, &hidden); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Hidden virtual-table columns (hidden = 1) are not part of the schema
|
||||||
|
if hidden == 1 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
column := models.InitColumn(name, tableName, "main")
|
column := models.InitColumn(name, tableName, "main")
|
||||||
column.Type = r.mapDataType(strings.ToUpper(dataType))
|
column.Type = r.mapDataType(strings.ToUpper(dataType))
|
||||||
column.NotNull = (notNull == 1)
|
column.NotNull = (notNull == 1)
|
||||||
column.IsPrimaryKey = (pk > 0)
|
column.IsPrimaryKey = (pk > 0)
|
||||||
column.Sequence = uint(cid + 1)
|
column.Sequence = uint(cid + 1)
|
||||||
|
|
||||||
if defaultValue != nil {
|
if hidden == 2 || hidden == 3 {
|
||||||
|
column.Generated = true
|
||||||
|
if !tableSQLLoaded {
|
||||||
|
tableSQL = r.tableSQL(tableName)
|
||||||
|
tableSQLLoaded = true
|
||||||
|
}
|
||||||
|
column.GenerationExpression = parseGeneratedExpression(tableSQL, name)
|
||||||
|
} else if defaultValue != nil {
|
||||||
column.Default = *defaultValue
|
column.Default = *defaultValue
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -116,6 +131,16 @@ func (r *Reader) queryColumns(tableName string) (map[string]*models.Column, erro
|
|||||||
return columns, rows.Err()
|
return columns, rows.Err()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// tableSQL returns the CREATE TABLE statement of a table, or "" when it cannot be read.
|
||||||
|
func (r *Reader) tableSQL(tableName string) string {
|
||||||
|
var sql string
|
||||||
|
err := r.db.QueryRowContext(r.ctx, `SELECT sql FROM sqlite_master WHERE type = 'table' AND name = ?`, tableName).Scan(&sql)
|
||||||
|
if err != nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
return sql
|
||||||
|
}
|
||||||
|
|
||||||
// isAutoIncrement checks if a column is autoincrement
|
// isAutoIncrement checks if a column is autoincrement
|
||||||
func (r *Reader) isAutoIncrement(tableName, columnName string) bool {
|
func (r *Reader) isAutoIncrement(tableName, columnName string) bool {
|
||||||
// Check sqlite_sequence table or parse CREATE TABLE statement
|
// Check sqlite_sequence table or parse CREATE TABLE statement
|
||||||
|
|||||||
@@ -114,6 +114,8 @@ export class Post {
|
|||||||
- `@JoinColumn()` - Foreign key column
|
- `@JoinColumn()` - Foreign key column
|
||||||
- `@Index()` - Index definition
|
- `@Index()` - Index definition
|
||||||
- `@Unique()` - Unique constraint
|
- `@Unique()` - Unique constraint
|
||||||
|
- `asExpression` / `generatedType` - Generated column (`Generated` + `GenerationExpression`)
|
||||||
|
- `@PrimaryGeneratedColumn('identity')`, `@Generated('identity')`, `generatedIdentity` - Identity column
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
|||||||
@@ -128,7 +128,6 @@ func (r *Reader) extractEntities(content string) []entityInfo {
|
|||||||
scanner := bufio.NewScanner(strings.NewReader(content))
|
scanner := bufio.NewScanner(strings.NewReader(content))
|
||||||
|
|
||||||
entityRegex := regexp.MustCompile(`^export\s+class\s+(\w+)`)
|
entityRegex := regexp.MustCompile(`^export\s+class\s+(\w+)`)
|
||||||
decoratorRegex := regexp.MustCompile(`^\s*@(\w+)(\([^)]*\))?`)
|
|
||||||
fieldRegex := regexp.MustCompile(`^\s*(\w+):\s*([^;]+);`)
|
fieldRegex := regexp.MustCompile(`^\s*(\w+):\s*([^;]+);`)
|
||||||
|
|
||||||
var currentEntity *entityInfo
|
var currentEntity *entityInfo
|
||||||
@@ -145,8 +144,7 @@ func (r *Reader) extractEntities(content string) []entityInfo {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check for decorator
|
// Check for decorator
|
||||||
if matches := decoratorRegex.FindStringSubmatch(trimmed); matches != nil {
|
if decorator, ok := matchDecorator(trimmed); ok {
|
||||||
decorator := matches[0]
|
|
||||||
pendingDecorators = append(pendingDecorators, decorator)
|
pendingDecorators = append(pendingDecorators, decorator)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -488,7 +486,11 @@ func (r *Reader) parseColumnDecorator(decorator string, column *models.Column, t
|
|||||||
column.IsPrimaryKey = true
|
column.IsPrimaryKey = true
|
||||||
column.NotNull = true
|
column.NotNull = true
|
||||||
|
|
||||||
if strings.Contains(decorator, "'uuid'") {
|
if strings.Contains(decorator, "'identity'") {
|
||||||
|
column.AutoIncrement = true
|
||||||
|
column.Identity = true
|
||||||
|
column.IdentityGeneration = parseGeneratedIdentity(decorator)
|
||||||
|
} else if strings.Contains(decorator, "'uuid'") {
|
||||||
column.Type = "uuid"
|
column.Type = "uuid"
|
||||||
column.Default = "gen_random_uuid()"
|
column.Default = "gen_random_uuid()"
|
||||||
} else if strings.Contains(decorator, "'increment'") || strings.Contains(decorator, "()") {
|
} else if strings.Contains(decorator, "'increment'") || strings.Contains(decorator, "()") {
|
||||||
@@ -497,6 +499,17 @@ func (r *Reader) parseColumnDecorator(decorator string, column *models.Column, t
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// @Generated('identity') on a non-key column; generatedIdentity is read from @Column
|
||||||
|
if strings.HasPrefix(decorator, "@Generated") {
|
||||||
|
if strings.Contains(decorator, "'identity'") {
|
||||||
|
column.Identity = true
|
||||||
|
if column.IdentityGeneration == "" {
|
||||||
|
column.IdentityGeneration = "BY DEFAULT"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
// @Column
|
// @Column
|
||||||
if strings.HasPrefix(decorator, "@Column") {
|
if strings.HasPrefix(decorator, "@Column") {
|
||||||
r.parseColumnOptions(decorator, column, table)
|
r.parseColumnOptions(decorator, column, table)
|
||||||
@@ -586,6 +599,14 @@ func (r *Reader) parseColumnOptions(decorator string, column *models.Column, tab
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if matches := asExpressionRegex.FindStringSubmatch(content); matches != nil {
|
||||||
|
column.Generated = true
|
||||||
|
column.GenerationExpression = unescapeSingleQuoted(matches[1])
|
||||||
|
}
|
||||||
|
if strings.Contains(content, "generatedIdentity") {
|
||||||
|
column.IdentityGeneration = parseGeneratedIdentity(content)
|
||||||
|
}
|
||||||
|
|
||||||
if strings.Contains(content, "nullable: true") || strings.Contains(content, "nullable:true") {
|
if strings.Contains(content, "nullable: true") || strings.Contains(content, "nullable:true") {
|
||||||
column.NotNull = false
|
column.NotNull = false
|
||||||
}
|
}
|
||||||
@@ -834,3 +855,72 @@ func (r *Reader) getPrimaryKeyColumn(table *models.Table) *models.Column {
|
|||||||
|
|
||||||
return pk
|
return pk
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
asExpressionRegex = regexp.MustCompile(`asExpression:\s*'((?:\\.|[^\\'])*)'`)
|
||||||
|
generatedIdentityRegexp = regexp.MustCompile(`generatedIdentity:\s*['"](ALWAYS|BY DEFAULT)['"]`)
|
||||||
|
)
|
||||||
|
|
||||||
|
// parseGeneratedIdentity returns the identity generation mode named in a decorator
|
||||||
|
// ("ALWAYS" or "BY DEFAULT"), defaulting to "BY DEFAULT" as TypeORM does.
|
||||||
|
func parseGeneratedIdentity(decorator string) string {
|
||||||
|
if matches := generatedIdentityRegexp.FindStringSubmatch(decorator); matches != nil {
|
||||||
|
return matches[1]
|
||||||
|
}
|
||||||
|
return "BY DEFAULT"
|
||||||
|
}
|
||||||
|
|
||||||
|
// unescapeSingleQuoted reverses escaping applied inside a quoted TypeScript string.
|
||||||
|
func unescapeSingleQuoted(s string) string {
|
||||||
|
var sb strings.Builder
|
||||||
|
for i := 0; i < len(s); i++ {
|
||||||
|
if s[i] == '\\' && i+1 < len(s) {
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
sb.WriteByte(s[i])
|
||||||
|
}
|
||||||
|
return sb.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
var decoratorNameRegex = regexp.MustCompile(`^@\w+`)
|
||||||
|
|
||||||
|
// matchDecorator returns the decorator at the start of line, including its argument list.
|
||||||
|
// Parentheses inside quoted strings (e.g. a generated column expression) do not end it.
|
||||||
|
func matchDecorator(line string) (string, bool) {
|
||||||
|
name := decoratorNameRegex.FindString(line)
|
||||||
|
if name == "" {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
rest := line[len(name):]
|
||||||
|
if !strings.HasPrefix(rest, "(") {
|
||||||
|
return name, true
|
||||||
|
}
|
||||||
|
|
||||||
|
depth := 0
|
||||||
|
var quote byte
|
||||||
|
for i := 0; i < len(rest); i++ {
|
||||||
|
ch := rest[i]
|
||||||
|
if quote != 0 {
|
||||||
|
switch ch {
|
||||||
|
case '\\':
|
||||||
|
i++
|
||||||
|
case quote:
|
||||||
|
quote = 0
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
switch ch {
|
||||||
|
case '\'', '"', '`':
|
||||||
|
quote = ch
|
||||||
|
case '(':
|
||||||
|
depth++
|
||||||
|
case ')':
|
||||||
|
depth--
|
||||||
|
if depth == 0 {
|
||||||
|
return name + rest[:i+1], true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Unterminated argument list: keep the whole line, as a best effort
|
||||||
|
return line, true
|
||||||
|
}
|
||||||
|
|||||||
@@ -129,6 +129,9 @@ type User struct {
|
|||||||
- `default` - Default value
|
- `default` - Default value
|
||||||
- `rel` - Relationship definition
|
- `rel` - Relationship definition
|
||||||
- `type` - Explicit SQL type
|
- `type` - Explicit SQL type
|
||||||
|
- `scanonly` - Excluded from INSERT/UPDATE: `GENERATED ... STORED` columns, and `GENERATED ALWAYS AS IDENTITY` columns that are not the primary key
|
||||||
|
- `generated` - Marks a `GENERATED ... STORED` column
|
||||||
|
- `identity` - Marks a `GENERATED ALWAYS AS IDENTITY` column (a primary key gets only this marker, since Bun drops `scanonly` fields from the PK list)
|
||||||
|
|
||||||
## Type Mapping
|
## Type Mapping
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package bun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildBunTag_GeneratedColumn(t *testing.T) {
|
||||||
|
mapper := NewTypeMapper("", "")
|
||||||
|
|
||||||
|
generated := models.InitColumn("full_name", "users", "public")
|
||||||
|
generated.Type = "text"
|
||||||
|
generated.Generated = true
|
||||||
|
generated.GenerationExpression = "first || ' ' || last"
|
||||||
|
|
||||||
|
plain := models.InitColumn("first", "users", "public")
|
||||||
|
plain.Type = "text"
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
column *models.Column
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"generated column is scanonly and marked", generated, true},
|
||||||
|
{"ordinary column is untouched", plain, false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tag := mapper.BuildBunTag(tt.column, nil)
|
||||||
|
parts := strings.Split(tag, ",")
|
||||||
|
has := func(s string) bool {
|
||||||
|
for _, p := range parts {
|
||||||
|
if p == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if has("scanonly") != tt.want || has("generated") != tt.want {
|
||||||
|
t.Errorf("tag %q: scanonly/generated present = %v/%v, want %v", tag, has("scanonly"), has("generated"), tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package bun
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildBunTag_IdentityColumn(t *testing.T) {
|
||||||
|
mapper := NewTypeMapper("", "")
|
||||||
|
|
||||||
|
build := func(pk, identity bool, generation string) *models.Column {
|
||||||
|
col := models.InitColumn("id", "users", "public")
|
||||||
|
col.Type = "bigint"
|
||||||
|
col.IsPrimaryKey = pk
|
||||||
|
col.Identity = identity
|
||||||
|
col.IdentityGeneration = generation
|
||||||
|
return col
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
column *models.Column
|
||||||
|
wantFlag bool
|
||||||
|
wantMarker bool
|
||||||
|
}{
|
||||||
|
{"always identity non-pk is write-blocked", build(false, true, "ALWAYS"), true, true},
|
||||||
|
{"always identity pk is only marked", build(true, true, "ALWAYS"), false, true},
|
||||||
|
{"by default identity is writable", build(false, true, "BY DEFAULT"), false, false},
|
||||||
|
{"non-identity is untouched", build(false, false, ""), false, false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tag := mapper.BuildBunTag(tt.column, nil)
|
||||||
|
has := func(s string) bool {
|
||||||
|
for _, p := range strings.Split(tag, ",") {
|
||||||
|
if p == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if has("scanonly") != tt.wantFlag || has("identity") != tt.wantMarker {
|
||||||
|
t.Errorf("tag %q: scanonly/identity = %v/%v, want %v/%v", tag, has("scanonly"), has("identity"), tt.wantFlag, tt.wantMarker)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -366,6 +366,22 @@ func (tm *TypeMapper) BuildBunTag(column *models.Column, table *models.Table) st
|
|||||||
parts = append(parts, "autoincrement")
|
parts = append(parts, "autoincrement")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GENERATED ALWAYS ... STORED columns are computed by the database and cannot be
|
||||||
|
// written: scanonly keeps them out of INSERT/UPDATE, generated marks why.
|
||||||
|
if column.Generated {
|
||||||
|
parts = append(parts, "scanonly", "generated")
|
||||||
|
}
|
||||||
|
|
||||||
|
// GENERATED ALWAYS AS IDENTITY rejects explicit values. Bun drops scanonly fields
|
||||||
|
// from the table's PK list, so a primary key only gets the marker; its zero value
|
||||||
|
// is already sent as DEFAULT via autoincrement.
|
||||||
|
if column.Identity && strings.EqualFold(column.IdentityGeneration, "ALWAYS") {
|
||||||
|
if !column.IsPrimaryKey {
|
||||||
|
parts = append(parts, "scanonly")
|
||||||
|
}
|
||||||
|
parts = append(parts, "identity")
|
||||||
|
}
|
||||||
|
|
||||||
// Default value
|
// Default value
|
||||||
if column.Default != nil {
|
if column.Default != nil {
|
||||||
// Sanitize default value to remove backticks, then quote based on column type
|
// Sanitize default value to remove backticks, then quote based on column type
|
||||||
|
|||||||
@@ -111,6 +111,8 @@ Table table_name {
|
|||||||
- `unique` - Unique constraint
|
- `unique` - Unique constraint
|
||||||
- `default: value` - Default value
|
- `default: value` - Default value
|
||||||
- `note: 'text'` - Column note
|
- `note: 'text'` - Column note
|
||||||
|
- `note: 'GENERATED ALWAYS AS (expr) STORED'` - Generated column (`Generated`, `GenerationExpression`)
|
||||||
|
- `note: 'GENERATED ALWAYS|BY DEFAULT AS IDENTITY'` - Identity column (`Identity`, `IdentityGeneration`)
|
||||||
|
|
||||||
### Relationships
|
### Relationships
|
||||||
```dbml
|
```dbml
|
||||||
|
|||||||
@@ -0,0 +1,77 @@
|
|||||||
|
package dbml
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
dbmlreader "git.warky.dev/wdevs/relspecgo/pkg/readers/dbml"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGeneratedAndIdentityColumnsRoundTrip(t *testing.T) {
|
||||||
|
table := models.InitTable("people", "public")
|
||||||
|
|
||||||
|
id := models.InitColumn("id", "people", "public")
|
||||||
|
id.Type = "bigint"
|
||||||
|
id.IsPrimaryKey = true
|
||||||
|
id.AutoIncrement = true
|
||||||
|
id.Identity = true
|
||||||
|
id.IdentityGeneration = "ALWAYS"
|
||||||
|
table.Columns["id"] = id
|
||||||
|
|
||||||
|
seq := models.InitColumn("seq", "people", "public")
|
||||||
|
seq.Type = "integer"
|
||||||
|
seq.Identity = true
|
||||||
|
seq.IdentityGeneration = "BY DEFAULT"
|
||||||
|
table.Columns["seq"] = seq
|
||||||
|
|
||||||
|
full := models.InitColumn("full_name", "people", "public")
|
||||||
|
full.Type = "text"
|
||||||
|
full.Generated = true
|
||||||
|
full.GenerationExpression = "first || ' ' || last"
|
||||||
|
table.Columns["full_name"] = full
|
||||||
|
|
||||||
|
plain := models.InitColumn("first", "people", "public")
|
||||||
|
plain.Type = "text"
|
||||||
|
plain.Comment = "given name"
|
||||||
|
table.Columns["first"] = plain
|
||||||
|
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
|
||||||
|
out := filepath.Join(t.TempDir(), "people.dbml")
|
||||||
|
require.NoError(t, NewWriter(&writers.WriterOptions{OutputPath: out}).WriteDatabase(db))
|
||||||
|
|
||||||
|
content, err := os.ReadFile(out)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(content), "GENERATED ALWAYS AS (first || \\' \\' || last) STORED")
|
||||||
|
assert.Contains(t, string(content), "GENERATED ALWAYS AS IDENTITY")
|
||||||
|
assert.Contains(t, string(content), "GENERATED BY DEFAULT AS IDENTITY")
|
||||||
|
|
||||||
|
got, err := dbmlreader.NewReader(&readers.ReaderOptions{FilePath: out}).ReadDatabase()
|
||||||
|
require.NoError(t, err)
|
||||||
|
cols := got.Schemas[0].Tables[0].Columns
|
||||||
|
|
||||||
|
assert.True(t, cols["id"].Identity)
|
||||||
|
assert.Equal(t, "ALWAYS", cols["id"].IdentityGeneration)
|
||||||
|
assert.Empty(t, cols["id"].Comment, "marker note must not become a comment")
|
||||||
|
|
||||||
|
assert.True(t, cols["seq"].Identity)
|
||||||
|
assert.Equal(t, "BY DEFAULT", cols["seq"].IdentityGeneration)
|
||||||
|
|
||||||
|
assert.True(t, cols["full_name"].Generated)
|
||||||
|
assert.Equal(t, "first || ' ' || last", cols["full_name"].GenerationExpression)
|
||||||
|
assert.Empty(t, cols["full_name"].Comment)
|
||||||
|
|
||||||
|
assert.False(t, cols["first"].Generated)
|
||||||
|
assert.False(t, cols["first"].Identity)
|
||||||
|
assert.Equal(t, "given name", cols["first"].Comment)
|
||||||
|
}
|
||||||
@@ -114,6 +114,24 @@ func (w *Writer) schemaToDBML(schema *models.Schema) string {
|
|||||||
return sb.String()
|
return sb.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// columnMarkerNote returns the note marking a column the database computes itself
|
||||||
|
// (GENERATED ... STORED, or GENERATED ... AS IDENTITY), or "" for an ordinary column.
|
||||||
|
// The DBML reader turns the note back into the model's Generated/Identity fields.
|
||||||
|
func columnMarkerNote(column *models.Column) string {
|
||||||
|
switch {
|
||||||
|
case column.Generated:
|
||||||
|
return fmt.Sprintf("GENERATED ALWAYS AS (%s) STORED", column.GenerationExpression)
|
||||||
|
case column.Identity && column.IdentityGeneration != "":
|
||||||
|
return fmt.Sprintf("GENERATED %s AS IDENTITY", strings.ToUpper(column.IdentityGeneration))
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// escapeNote escapes a value for use inside a single-quoted DBML note.
|
||||||
|
func escapeNote(s string) string {
|
||||||
|
return strings.ReplaceAll(strings.ReplaceAll(s, `\`, `\\`), `'`, `\'`)
|
||||||
|
}
|
||||||
|
|
||||||
// tableToDBML converts a Table to DBML format string
|
// tableToDBML converts a Table to DBML format string
|
||||||
func (w *Writer) tableToDBML(t *models.Table) string {
|
func (w *Writer) tableToDBML(t *models.Table) string {
|
||||||
var sb strings.Builder
|
var sb strings.Builder
|
||||||
@@ -146,6 +164,10 @@ func (w *Writer) tableToDBML(t *models.Table) string {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if marker := columnMarkerNote(column); marker != "" {
|
||||||
|
attrs = append(attrs, fmt.Sprintf("note: '%s'", escapeNote(marker)))
|
||||||
|
}
|
||||||
|
|
||||||
if len(attrs) > 0 {
|
if len(attrs) > 0 {
|
||||||
fmt.Fprintf(&sb, " [%s]", strings.Join(attrs, ", "))
|
fmt.Fprintf(&sb, " [%s]", strings.Join(attrs, ", "))
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -113,6 +113,7 @@ export const postsRelations = relations(posts, ({ one }) => ({
|
|||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
- Generated columns: `.generatedAlwaysAs(sql`expr`)`; identity columns: `.generatedAlwaysAsIdentity()` / `.generatedByDefaultAsIdentity()`
|
||||||
- Table names and column names are preserved as-is
|
- Table names and column names are preserved as-is
|
||||||
- Relationships are generated as separate relation definitions
|
- Relationships are generated as separate relation definitions
|
||||||
- Constraint actions (CASCADE, etc.) are included in references
|
- Constraint actions (CASCADE, etc.) are included in references
|
||||||
|
|||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package drizzle
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
drizzlereader "git.warky.dev/wdevs/relspecgo/pkg/readers/drizzle"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGeneratedAndIdentityColumnsRoundTrip(t *testing.T) {
|
||||||
|
table := models.InitTable("people", "public")
|
||||||
|
|
||||||
|
id := models.InitColumn("id", "people", "public")
|
||||||
|
id.Type = "bigint"
|
||||||
|
id.IsPrimaryKey = true
|
||||||
|
id.AutoIncrement = true
|
||||||
|
id.Identity = true
|
||||||
|
id.IdentityGeneration = "ALWAYS"
|
||||||
|
table.Columns["id"] = id
|
||||||
|
|
||||||
|
seq := models.InitColumn("seq", "people", "public")
|
||||||
|
seq.Type = "integer"
|
||||||
|
seq.AutoIncrement = true
|
||||||
|
seq.Identity = true
|
||||||
|
seq.IdentityGeneration = "BY DEFAULT"
|
||||||
|
table.Columns["seq"] = seq
|
||||||
|
|
||||||
|
first := models.InitColumn("first", "people", "public")
|
||||||
|
first.Type = "text"
|
||||||
|
table.Columns["first"] = first
|
||||||
|
|
||||||
|
full := models.InitColumn("full_name", "people", "public")
|
||||||
|
full.Type = "text"
|
||||||
|
full.Generated = true
|
||||||
|
full.GenerationExpression = "first || ' ' || upper(first)"
|
||||||
|
table.Columns["full_name"] = full
|
||||||
|
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
|
||||||
|
out := filepath.Join(t.TempDir(), "schema.ts")
|
||||||
|
require.NoError(t, NewWriter(&writers.WriterOptions{OutputPath: out}).WriteDatabase(db))
|
||||||
|
|
||||||
|
content, err := os.ReadFile(out)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(content), "generatedAlwaysAs(sql`first || ' ' || upper(first)`)")
|
||||||
|
assert.Contains(t, string(content), "generatedAlwaysAsIdentity()")
|
||||||
|
assert.Contains(t, string(content), "generatedByDefaultAsIdentity()")
|
||||||
|
|
||||||
|
got, err := drizzlereader.NewReader(&readers.ReaderOptions{FilePath: out}).ReadDatabase()
|
||||||
|
require.NoError(t, err)
|
||||||
|
cols := got.Schemas[0].Tables[0].Columns
|
||||||
|
|
||||||
|
assert.True(t, cols["id"].Identity)
|
||||||
|
assert.Equal(t, "ALWAYS", cols["id"].IdentityGeneration)
|
||||||
|
assert.True(t, cols["seq"].Identity)
|
||||||
|
assert.Equal(t, "BY DEFAULT", cols["seq"].IdentityGeneration)
|
||||||
|
assert.True(t, cols["full_name"].Generated)
|
||||||
|
assert.Equal(t, "first || ' ' || upper(first)", cols["full_name"].GenerationExpression)
|
||||||
|
assert.False(t, cols["first"].Generated)
|
||||||
|
assert.False(t, cols["first"].Identity)
|
||||||
|
}
|
||||||
@@ -140,7 +140,13 @@ func (tm *TypeMapper) buildColumnModifiers(col *models.Column, table *models.Tab
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Default value
|
// Default value
|
||||||
if col.AutoIncrement {
|
if col.Generated && col.GenerationExpression != "" {
|
||||||
|
// GENERATED ALWAYS AS (expr) STORED
|
||||||
|
expr := strings.ReplaceAll(col.GenerationExpression, "`", "\\`")
|
||||||
|
modifiers = append(modifiers, fmt.Sprintf("generatedAlwaysAs(sql`%s`)", expr))
|
||||||
|
} else if col.Identity && strings.EqualFold(col.IdentityGeneration, "BY DEFAULT") {
|
||||||
|
modifiers = append(modifiers, "generatedByDefaultAsIdentity()")
|
||||||
|
} else if col.AutoIncrement || col.Identity {
|
||||||
// For auto-increment, use generatedAlwaysAsIdentity()
|
// For auto-increment, use generatedAlwaysAsIdentity()
|
||||||
modifiers = append(modifiers, "generatedAlwaysAsIdentity()")
|
modifiers = append(modifiers, "generatedAlwaysAsIdentity()")
|
||||||
} else if col.Default != nil {
|
} else if col.Default != nil {
|
||||||
|
|||||||
@@ -203,6 +203,14 @@ The writer automatically generates relationship fields:
|
|||||||
- Relationship field names use 3-letter prefixes
|
- Relationship field names use 3-letter prefixes
|
||||||
- Includes proper `gorm` tags with `foreignKey` and `references`
|
- Includes proper `gorm` tags with `foreignKey` and `references`
|
||||||
|
|
||||||
|
## Read-only Columns
|
||||||
|
|
||||||
|
| Column | Tags |
|
||||||
|
|---|---|
|
||||||
|
| `GENERATED ... STORED` | `<-:false;generated` |
|
||||||
|
| `GENERATED ALWAYS AS IDENTITY`, not PK | `<-:false;identity` |
|
||||||
|
| `GENERATED ALWAYS AS IDENTITY`, PK | `identity` only |
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Model names are prefixed with "Model" (e.g., `ModelUser`)
|
- Model names are prefixed with "Model" (e.g., `ModelUser`)
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
package gorm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildGormTag_GeneratedColumn(t *testing.T) {
|
||||||
|
mapper := NewTypeMapper("")
|
||||||
|
|
||||||
|
generated := models.InitColumn("full_name", "users", "public")
|
||||||
|
generated.Type = "text"
|
||||||
|
generated.Generated = true
|
||||||
|
|
||||||
|
plain := models.InitColumn("first", "users", "public")
|
||||||
|
plain.Type = "text"
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
column *models.Column
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"generated column is write-disabled and marked", generated, true},
|
||||||
|
{"ordinary column is untouched", plain, false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tag := mapper.BuildGormTag(tt.column, nil)
|
||||||
|
parts := strings.Split(tag, ";")
|
||||||
|
has := func(s string) bool {
|
||||||
|
for _, p := range parts {
|
||||||
|
if p == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if has("<-:false") != tt.want || has("generated") != tt.want {
|
||||||
|
t.Errorf("tag %q: <-:false/generated present = %v/%v, want %v", tag, has("<-:false"), has("generated"), tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package gorm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestBuildGormTag_IdentityColumn(t *testing.T) {
|
||||||
|
mapper := NewTypeMapper("")
|
||||||
|
|
||||||
|
build := func(pk, identity bool, generation string) *models.Column {
|
||||||
|
col := models.InitColumn("id", "users", "public")
|
||||||
|
col.Type = "bigint"
|
||||||
|
col.IsPrimaryKey = pk
|
||||||
|
col.Identity = identity
|
||||||
|
col.IdentityGeneration = generation
|
||||||
|
return col
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
column *models.Column
|
||||||
|
wantFlag bool
|
||||||
|
wantMarker bool
|
||||||
|
}{
|
||||||
|
{"always identity non-pk is write-blocked", build(false, true, "ALWAYS"), true, true},
|
||||||
|
{"always identity pk is only marked", build(true, true, "ALWAYS"), false, true},
|
||||||
|
{"by default identity is writable", build(false, true, "BY DEFAULT"), false, false},
|
||||||
|
{"non-identity is untouched", build(false, false, ""), false, false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
tag := mapper.BuildGormTag(tt.column, nil)
|
||||||
|
has := func(s string) bool {
|
||||||
|
for _, p := range strings.Split(tag, ";") {
|
||||||
|
if p == s {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if has("<-:false") != tt.wantFlag || has("identity") != tt.wantMarker {
|
||||||
|
t.Errorf("tag %q: <-:false/identity = %v/%v, want %v/%v", tag, has("<-:false"), has("identity"), tt.wantFlag, tt.wantMarker)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -401,6 +401,21 @@ func (tm *TypeMapper) BuildGormTag(column *models.Column, table *models.Table) s
|
|||||||
parts = append(parts, "autoIncrement")
|
parts = append(parts, "autoIncrement")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// GENERATED ALWAYS ... STORED columns are computed by the database and cannot be
|
||||||
|
// written: disable write permission so GORM leaves them out of INSERT/UPDATE, and mark why.
|
||||||
|
if column.Generated {
|
||||||
|
parts = append(parts, "<-:false", "generated")
|
||||||
|
}
|
||||||
|
|
||||||
|
// GENERATED ALWAYS AS IDENTITY rejects explicit values. A primary key only gets the
|
||||||
|
// marker so it keeps its normal create/return behavior.
|
||||||
|
if column.Identity && strings.EqualFold(column.IdentityGeneration, "ALWAYS") {
|
||||||
|
if !column.IsPrimaryKey {
|
||||||
|
parts = append(parts, "<-:false")
|
||||||
|
}
|
||||||
|
parts = append(parts, "identity")
|
||||||
|
}
|
||||||
|
|
||||||
// Not null (skip if primary key, as it's implied)
|
// Not null (skip if primary key, as it's implied)
|
||||||
if column.NotNull && !column.IsPrimaryKey {
|
if column.NotNull && !column.IsPrimaryKey {
|
||||||
parts = append(parts, "not null")
|
parts = append(parts, "not null")
|
||||||
|
|||||||
@@ -127,4 +127,5 @@ go test ./pkg/writers/mssql/...
|
|||||||
- Views are not currently supported in the writer
|
- Views are not currently supported in the writer
|
||||||
- Sequences are not supported (MSSQL uses IDENTITY instead)
|
- Sequences are not supported (MSSQL uses IDENTITY instead)
|
||||||
- Partitioning and advanced features are not supported
|
- Partitioning and advanced features are not supported
|
||||||
- Generated DDL assumes no triggers or computed columns
|
- Generated DDL assumes no triggers
|
||||||
|
- Generated columns are written as computed columns `[col] AS (expr) PERSISTED` (no type, no DEFAULT); identity columns as `IDENTITY(1,1)`
|
||||||
|
|||||||
@@ -187,6 +187,16 @@ func (w *Writer) writeCreateTable(schema *models.Schema, table *models.Table) er
|
|||||||
func (w *Writer) generateColumnDefinition(col *models.Column) string {
|
func (w *Writer) generateColumnDefinition(col *models.Column) string {
|
||||||
parts := []string{fmt.Sprintf("[%s]", col.Name)}
|
parts := []string{fmt.Sprintf("[%s]", col.Name)}
|
||||||
|
|
||||||
|
// Computed column: "name AS (expr) PERSISTED" has no data type and cannot carry
|
||||||
|
// IDENTITY or a DEFAULT. PERSISTED mirrors the stored semantics of Column.Generated.
|
||||||
|
if col.Generated && col.GenerationExpression != "" {
|
||||||
|
parts = append(parts, fmt.Sprintf("AS (%s) PERSISTED", col.GenerationExpression))
|
||||||
|
if col.NotNull {
|
||||||
|
parts = append(parts, "NOT NULL")
|
||||||
|
}
|
||||||
|
return strings.Join(parts, " ")
|
||||||
|
}
|
||||||
|
|
||||||
// Type with length/precision
|
// Type with length/precision
|
||||||
baseType := mssql.ConvertCanonicalToMSSQL(col.Type)
|
baseType := mssql.ConvertCanonicalToMSSQL(col.Type)
|
||||||
typeStr := baseType
|
typeStr := baseType
|
||||||
@@ -215,7 +225,7 @@ func (w *Writer) generateColumnDefinition(col *models.Column) string {
|
|||||||
parts = append(parts, typeStr)
|
parts = append(parts, typeStr)
|
||||||
|
|
||||||
// IDENTITY for auto-increment
|
// IDENTITY for auto-increment
|
||||||
if col.AutoIncrement {
|
if col.AutoIncrement || col.Identity {
|
||||||
parts = append(parts, "IDENTITY(1,1)")
|
parts = append(parts, "IDENTITY(1,1)")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -204,3 +204,19 @@ func TestWriteComments(t *testing.T) {
|
|||||||
assert.Contains(t, output, "User accounts table")
|
assert.Contains(t, output, "User accounts table")
|
||||||
assert.Contains(t, output, "Primary key")
|
assert.Contains(t, output, "Primary key")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGenerateColumnDefinition_ComputedAndIdentity(t *testing.T) {
|
||||||
|
writer := NewWriter(&writers.WriterOptions{})
|
||||||
|
|
||||||
|
computed := &models.Column{
|
||||||
|
Name: "full_name",
|
||||||
|
Type: "string",
|
||||||
|
Generated: true,
|
||||||
|
GenerationExpression: "[first] + ' ' + [last]",
|
||||||
|
Default: "ignored",
|
||||||
|
}
|
||||||
|
assert.Equal(t, "[full_name] AS ([first] + ' ' + [last]) PERSISTED", writer.generateColumnDefinition(computed))
|
||||||
|
|
||||||
|
identity := &models.Column{Name: "id", Type: "int", NotNull: true, Identity: true, IdentityGeneration: "ALWAYS"}
|
||||||
|
assert.Equal(t, "[id] INT IDENTITY(1,1) NOT NULL", writer.generateColumnDefinition(identity))
|
||||||
|
}
|
||||||
|
|||||||
@@ -164,6 +164,12 @@ When `include_audit` is enabled, adds:
|
|||||||
## PostgreSQL-Specific Features
|
## PostgreSQL-Specific Features
|
||||||
|
|
||||||
- Serial types (SERIAL, BIGSERIAL)
|
- Serial types (SERIAL, BIGSERIAL)
|
||||||
|
- Generated columns: `GENERATED ALWAYS AS (expr) STORED` (`Column.Generated` + `GenerationExpression`)
|
||||||
|
- Identity columns: `GENERATED ALWAYS|BY DEFAULT AS IDENTITY` (`Column.Identity` + `IdentityGeneration`)
|
||||||
|
- Generated/identity columns never carry a `DEFAULT`; emitted in `CREATE TABLE` and `ADD COLUMN` (full DDL and migration)
|
||||||
|
- Existing generated/identity columns are not diffed (expression changes are not applied)
|
||||||
|
- PK sequence = the `nextval()` default's sequence; `setval` moves it past `MAX(pk)`, forward only
|
||||||
|
- `serial`/`bigserial` columns without a model default keep their `nextval()` default in diffs
|
||||||
- Advanced types (UUID, JSONB, ARRAY)
|
- Advanced types (UUID, JSONB, ARRAY)
|
||||||
- Schema-qualified names
|
- Schema-qualified names
|
||||||
- Constraint actions (CASCADE, RESTRICT, SET NULL)
|
- Constraint actions (CASCADE, RESTRICT, SET NULL)
|
||||||
|
|||||||
@@ -0,0 +1,409 @@
|
|||||||
|
package pgsql
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
// diffTestDB builds a database with one table per spec: name -> column name -> type.
|
||||||
|
func diffTestDB(schemaName string, tables map[string]map[string]string) *models.Database {
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
schema := models.InitSchema(schemaName)
|
||||||
|
for tName, cols := range tables {
|
||||||
|
table := models.InitTable(tName, schemaName)
|
||||||
|
seq := 1
|
||||||
|
for cName, cType := range cols {
|
||||||
|
col := models.InitColumn(cName, tName, schemaName)
|
||||||
|
col.Type = cType
|
||||||
|
col.Sequence = uint(seq)
|
||||||
|
seq++
|
||||||
|
table.Columns[cName] = col
|
||||||
|
}
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
}
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
func diffJoin(stmts []string) string { return strings.Join(stmts, "\n") }
|
||||||
|
|
||||||
|
func TestDiffStatements(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
model func() *models.Database
|
||||||
|
current func() *models.Database
|
||||||
|
wantContain []string
|
||||||
|
wantAbsent []string
|
||||||
|
wantEmpty bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "identical schemas produce no statements",
|
||||||
|
model: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "email": "text"}})
|
||||||
|
},
|
||||||
|
current: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "email": "text"}})
|
||||||
|
},
|
||||||
|
wantEmpty: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing table is created",
|
||||||
|
model: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}, "posts": {"id": "integer"}})
|
||||||
|
},
|
||||||
|
current: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
},
|
||||||
|
wantContain: []string{"CREATE TABLE IF NOT EXISTS public.posts"},
|
||||||
|
wantAbsent: []string{"public.users"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing column is added and existing columns are skipped",
|
||||||
|
model: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "email": "text"}})
|
||||||
|
},
|
||||||
|
current: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
},
|
||||||
|
wantContain: []string{"ADD COLUMN IF NOT EXISTS email text"},
|
||||||
|
wantAbsent: []string{"COLUMN id"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "changed column type is altered",
|
||||||
|
model: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "bigint"}})
|
||||||
|
},
|
||||||
|
current: func() *models.Database {
|
||||||
|
return diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
},
|
||||||
|
wantContain: []string{"ALTER COLUMN id TYPE bigint"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "missing non-public schema is created before its tables",
|
||||||
|
model: func() *models.Database {
|
||||||
|
return diffTestDB("app", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
},
|
||||||
|
current: func() *models.Database { return models.InitDatabase("testdb") },
|
||||||
|
wantContain: []string{
|
||||||
|
"CREATE SCHEMA IF NOT EXISTS app",
|
||||||
|
"CREATE TABLE IF NOT EXISTS app.users",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(tt.model(), tt.current())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
|
||||||
|
if tt.wantEmpty && len(stmts) != 0 {
|
||||||
|
t.Fatalf("expected no statements, got:\n%s", out)
|
||||||
|
}
|
||||||
|
for _, want := range tt.wantContain {
|
||||||
|
if !strings.Contains(out, want) {
|
||||||
|
t.Errorf("missing %q in:\n%s", want, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, absent := range tt.wantAbsent {
|
||||||
|
if strings.Contains(out, absent) {
|
||||||
|
t.Errorf("unexpected %q in:\n%s", absent, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_SchemaCreatedBeforeTables(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
model := diffTestDB("app", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
stmts, err := w.diffStatements(model, models.InitDatabase("testdb"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
schemaIdx, tableIdx := -1, -1
|
||||||
|
for i, s := range stmts {
|
||||||
|
if strings.Contains(s, "CREATE SCHEMA") {
|
||||||
|
schemaIdx = i
|
||||||
|
}
|
||||||
|
if strings.Contains(s, "CREATE TABLE") {
|
||||||
|
tableIdx = i
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if schemaIdx < 0 || tableIdx < 0 || schemaIdx > tableIdx {
|
||||||
|
t.Fatalf("expected CREATE SCHEMA before CREATE TABLE, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_NewTableCreatesPrimaryKeySequence(t *testing.T) {
|
||||||
|
model := models.InitDatabase("testdb")
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
table := models.InitTable("users", "public")
|
||||||
|
id := models.InitColumn("id", "users", "public")
|
||||||
|
id.Type = "integer"
|
||||||
|
id.IsPrimaryKey = true
|
||||||
|
id.Default = "nextval('public.users_id_seq'::regclass)"
|
||||||
|
table.Columns["id"] = id
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
model.Schemas = append(model.Schemas, schema)
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(model, models.InitDatabase("testdb"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
if !strings.Contains(out, "CREATE SEQUENCE IF NOT EXISTS public.users_id_seq") {
|
||||||
|
t.Fatalf("expected sequence creation, got:\n%s", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Existing table: sequence must not be re-emitted.
|
||||||
|
current := models.InitDatabase("testdb")
|
||||||
|
cs := models.InitSchema("public")
|
||||||
|
cs.Tables = append(cs.Tables, table)
|
||||||
|
current.Schemas = append(current.Schemas, cs)
|
||||||
|
stmts, err = w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if strings.Contains(diffJoin(stmts), "CREATE SEQUENCE") {
|
||||||
|
t.Fatalf("sequence emitted for existing table:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_NewIndexAndChangedIndexRecreated(t *testing.T) {
|
||||||
|
build := func(cols ...string) *models.Database {
|
||||||
|
db := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "email": "text", "name": "text"}})
|
||||||
|
table := db.Schemas[0].Tables[0]
|
||||||
|
table.Indexes["idx_users_lookup"] = &models.Index{Name: "idx_users_lookup", Columns: cols}
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
|
||||||
|
// Index missing in current.
|
||||||
|
noIdx := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "email": "text", "name": "text"}})
|
||||||
|
stmts, err := w.diffStatements(build("email"), noIdx)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(diffJoin(stmts), "CREATE INDEX IF NOT EXISTS idx_users_lookup") {
|
||||||
|
t.Fatalf("expected index creation, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Index unchanged.
|
||||||
|
stmts, err = w.diffStatements(build("email"), build("email"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if len(stmts) != 0 {
|
||||||
|
t.Fatalf("expected no statements for identical index, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Index definition changed: dropped and recreated.
|
||||||
|
stmts, err = w.diffStatements(build("name"), build("email"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
dropIdx := strings.Index(out, "DROP INDEX")
|
||||||
|
createIdx := strings.Index(out, "CREATE INDEX")
|
||||||
|
if dropIdx < 0 || createIdx < 0 || dropIdx > createIdx {
|
||||||
|
t.Fatalf("expected DROP INDEX before CREATE INDEX, got:\n%s", out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_FlattenSchemaRejected(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{FlattenSchema: true})
|
||||||
|
if _, err := w.generateLiveDiffStatements(models.InitDatabase("x"), "postgres://unused"); err == nil {
|
||||||
|
t.Fatal("expected error so the caller falls back to full DDL")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_LiveDatabaseRepresentationsAreNotDifferences(t *testing.T) {
|
||||||
|
build := func(live bool) *models.Database {
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
|
||||||
|
parent := models.InitTable("parent", "public")
|
||||||
|
parentID := models.InitColumn("id_parent", "parent", "public")
|
||||||
|
parentCurrentType := "bigserial"
|
||||||
|
if live {
|
||||||
|
parentCurrentType = "bigint"
|
||||||
|
}
|
||||||
|
parentID.Type = parentCurrentType
|
||||||
|
parentID.IsPrimaryKey = true
|
||||||
|
parentID.NotNull = true
|
||||||
|
parent.Columns["id_parent"] = parentID
|
||||||
|
if live {
|
||||||
|
// A live database reports the PK as a named constraint and the unique
|
||||||
|
// constraint's backing index as an index too.
|
||||||
|
parent.Constraints["pk_public_parent"] = &models.Constraint{
|
||||||
|
Name: "pk_public_parent", Type: models.PrimaryKeyConstraint, Columns: []string{"id_parent"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
guid := models.InitColumn("guid", "parent", "public")
|
||||||
|
guid.Type = "uuid"
|
||||||
|
parent.Columns["guid"] = guid
|
||||||
|
parent.Constraints["ukey_parent_guid"] = &models.Constraint{
|
||||||
|
Name: "ukey_parent_guid", Type: models.UniqueConstraint, Columns: []string{"guid"},
|
||||||
|
}
|
||||||
|
if live {
|
||||||
|
parent.Indexes["ukey_parent_guid"] = &models.Index{Name: "ukey_parent_guid", Unique: true, Columns: []string{"guid"}, Type: "btree"}
|
||||||
|
}
|
||||||
|
|
||||||
|
// numeric(10,0) vs numeric(10); quoted default vs unquoted default with cast.
|
||||||
|
amount := models.InitColumn("amount", "parent", "public")
|
||||||
|
amount.Type = "numeric(10,0)"
|
||||||
|
tags := models.InitColumn("tags", "parent", "public")
|
||||||
|
tags.Type = "jsonb"
|
||||||
|
tags.Default = "`'[]'`"
|
||||||
|
if live {
|
||||||
|
amount.Type = "numeric"
|
||||||
|
amount.Precision = 10
|
||||||
|
tags.Default = "[]"
|
||||||
|
}
|
||||||
|
parent.Columns["amount"] = amount
|
||||||
|
parent.Columns["tags"] = tags
|
||||||
|
|
||||||
|
parent.Indexes["idx_parent_amount"] = &models.Index{Name: "idx_parent_amount", Columns: []string{"amount"}}
|
||||||
|
if live {
|
||||||
|
parent.Indexes["idx_parent_amount"].Type = "btree"
|
||||||
|
}
|
||||||
|
|
||||||
|
child := models.InitTable("child", "public")
|
||||||
|
cid := models.InitColumn("id_child", "child", "public")
|
||||||
|
cid.Type = "integer"
|
||||||
|
child.Columns["id_child"] = cid
|
||||||
|
rid := models.InitColumn("rid_parent", "child", "public")
|
||||||
|
rid.Type = "bigint"
|
||||||
|
child.Columns["rid_parent"] = rid
|
||||||
|
action := "restrict"
|
||||||
|
if live {
|
||||||
|
action = "RESTRICT"
|
||||||
|
}
|
||||||
|
child.Constraints["fk_child_rid_parent"] = &models.Constraint{
|
||||||
|
Name: "fk_child_rid_parent", Type: models.ForeignKeyConstraint, Columns: []string{"rid_parent"},
|
||||||
|
ReferencedTable: "parent", ReferencedSchema: "public", ReferencedColumns: []string{"id_parent"},
|
||||||
|
OnDelete: action, OnUpdate: action,
|
||||||
|
}
|
||||||
|
|
||||||
|
parent.Description = "Parent\ntable"
|
||||||
|
if live {
|
||||||
|
parent.Description = "Parent\ntable\n"
|
||||||
|
}
|
||||||
|
|
||||||
|
schema.Tables = append(schema.Tables, parent, child)
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(build(false), build(true))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if len(stmts) != 0 {
|
||||||
|
t.Fatalf("expected live representations to match the model, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_ChangedPrimaryKeyIsRecreated(t *testing.T) {
|
||||||
|
model := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "tenant": "integer"}})
|
||||||
|
model.Schemas[0].Tables[0].Columns["tenant"].IsPrimaryKey = true
|
||||||
|
|
||||||
|
current := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer", "tenant": "integer"}})
|
||||||
|
current.Schemas[0].Tables[0].Columns["id"].IsPrimaryKey = true
|
||||||
|
current.Schemas[0].Tables[0].Constraints["pk_public_users"] = &models.Constraint{
|
||||||
|
Name: "pk_public_users", Type: models.PrimaryKeyConstraint, Columns: []string{"id"},
|
||||||
|
}
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(diffJoin(stmts), "DROP CONSTRAINT IF EXISTS pk_public_users") {
|
||||||
|
t.Fatalf("expected old primary key to be dropped, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_ChangedCommentEmitted(t *testing.T) {
|
||||||
|
model := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
model.Schemas[0].Tables[0].Description = "new"
|
||||||
|
current := diffTestDB("public", map[string]map[string]string{"users": {"id": "integer"}})
|
||||||
|
current.Schemas[0].Tables[0].Description = "old"
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(diffJoin(stmts), "COMMENT ON TABLE public.users IS 'new'") {
|
||||||
|
t.Fatalf("expected changed comment, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_TruncatedConstraintNameMatches(t *testing.T) {
|
||||||
|
long := "fk_individual_actor_relationship_rid_typelookup_relationship_type"
|
||||||
|
if len(long) <= maxIdentifierBytes {
|
||||||
|
t.Fatal("test name must exceed the identifier limit")
|
||||||
|
}
|
||||||
|
build := func(name string) *models.Database {
|
||||||
|
db := diffTestDB("public", map[string]map[string]string{
|
||||||
|
"parent": {"id": "integer"},
|
||||||
|
"child": {"rid": "integer"},
|
||||||
|
})
|
||||||
|
for _, tbl := range db.Schemas[0].Tables {
|
||||||
|
if tbl.Name == "child" {
|
||||||
|
tbl.Constraints[name] = &models.Constraint{
|
||||||
|
Name: name, Type: models.ForeignKeyConstraint, Columns: []string{"rid"},
|
||||||
|
ReferencedTable: "parent", ReferencedSchema: "public", ReferencedColumns: []string{"id"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(build(long), build(pgIdentifier(long)))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if len(stmts) != 0 {
|
||||||
|
t.Fatalf("expected truncated live name to match, got:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestColumnDefaultsEqual_LiveRepresentations(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
model, cur interface{}
|
||||||
|
want bool
|
||||||
|
}{
|
||||||
|
{"cast wrapped in parentheses", "gen_random_uuid()::text", "(gen_random_uuid())::text", true},
|
||||||
|
{"jsonb re-spaced array", `'["openid","profile","email"]'`, `'["openid", "profile", "email"]'::jsonb`, true},
|
||||||
|
{"backticked function", "`now()`", "now()", true},
|
||||||
|
{"quoted literal with cast", "'[]'", "'[]'::jsonb", true},
|
||||||
|
{"jsonb array already unquoted by the reader", `'["openid","profile"]'`, `["openid", "profile"]`, true},
|
||||||
|
{"text with spaces and braces", "`'{actor} #{actor_id} - {chartofaccount}'`", "{actor} #{actor_id} - {chartofaccount}", true},
|
||||||
|
{"cast on plain function stays equal", "gen_random_uuid()::text", "gen_random_uuid()::text", true},
|
||||||
|
{"different jsonb content", `'["a"]'`, `'["b"]'::jsonb`, false},
|
||||||
|
{"different function", "gen_random_uuid()::text", "(now())::text", false},
|
||||||
|
{"different literal", "'active'", "'inactive'::text", false},
|
||||||
|
{"nil vs value", nil, "now()", false},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
if got := columnDefaultsEqual(tt.model, tt.cur); got != tt.want {
|
||||||
|
t.Errorf("columnDefaultsEqual(%v, %v) = %v, want %v", tt.model, tt.cur, got, tt.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package pgsql
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func generationTestTable(withColumns bool) *models.Table {
|
||||||
|
table := models.InitTable("people", "public")
|
||||||
|
|
||||||
|
first := models.InitColumn("first", "people", "public")
|
||||||
|
first.Type = "text"
|
||||||
|
first.Sequence = 1
|
||||||
|
table.Columns["first"] = first
|
||||||
|
|
||||||
|
if !withColumns {
|
||||||
|
return table
|
||||||
|
}
|
||||||
|
|
||||||
|
full := models.InitColumn("full_name", "people", "public")
|
||||||
|
full.Type = "text"
|
||||||
|
full.Sequence = 2
|
||||||
|
full.Generated = true
|
||||||
|
full.GenerationExpression = "first || ' ' || last"
|
||||||
|
full.Default = "ignored"
|
||||||
|
table.Columns["full_name"] = full
|
||||||
|
|
||||||
|
ident := models.InitColumn("seq", "people", "public")
|
||||||
|
ident.Type = "bigint"
|
||||||
|
ident.Sequence = 3
|
||||||
|
ident.NotNull = true
|
||||||
|
ident.Identity = true
|
||||||
|
ident.IdentityGeneration = "ALWAYS"
|
||||||
|
table.Columns["seq"] = ident
|
||||||
|
|
||||||
|
return table
|
||||||
|
}
|
||||||
|
|
||||||
|
func generationTestDB(table *models.Table) *models.Database {
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGeneratedColumns_MigrationCreateAndAddColumn(t *testing.T) {
|
||||||
|
want := []string{
|
||||||
|
"GENERATED ALWAYS AS (first || ' ' || last) STORED",
|
||||||
|
"GENERATED ALWAYS AS IDENTITY",
|
||||||
|
}
|
||||||
|
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
current *models.Database
|
||||||
|
}{
|
||||||
|
{"new table", models.InitDatabase("testdb")},
|
||||||
|
{"new columns on existing table", generationTestDB(generationTestTable(false))},
|
||||||
|
}
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(generationTestDB(generationTestTable(true)), tt.current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
for _, s := range want {
|
||||||
|
if !strings.Contains(out, s) {
|
||||||
|
t.Errorf("missing %q:\n%s", s, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(out, "DEFAULT ignored") || strings.Contains(out, "DEFAULT 'ignored'") {
|
||||||
|
t.Errorf("generated column must not carry a DEFAULT:\n%s", out)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestGeneratedColumns_FullDDL(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.GenerateDatabaseStatements(generationTestDB(generationTestTable(true)))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GenerateDatabaseStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
for _, s := range []string{
|
||||||
|
"full_name text GENERATED ALWAYS AS (first || ' ' || last) STORED",
|
||||||
|
"seq bigint GENERATED ALWAYS AS IDENTITY NOT NULL",
|
||||||
|
} {
|
||||||
|
if !strings.Contains(out, s) {
|
||||||
|
t.Errorf("missing %q:\n%s", s, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if strings.Contains(out, "DEFAULT 'ignored'") {
|
||||||
|
t.Errorf("generated column must not carry a DEFAULT:\n%s", out)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
package pgsql
|
package pgsql
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
@@ -46,10 +48,11 @@ func NewMigrationWriter(options *writers.WriterOptions) (*MigrationWriter, error
|
|||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// WriteMigration generates migration scripts using templates
|
// GenerateScripts computes the differential migration scripts between current and model,
|
||||||
func (w *MigrationWriter) WriteMigration(model, current *models.Database) error {
|
// sorted by priority and sequence.
|
||||||
|
func (w *MigrationWriter) GenerateScripts(model, current *models.Database) ([]MigrationScript, error) {
|
||||||
if model == nil {
|
if model == nil {
|
||||||
return fmt.Errorf("model database is required")
|
return nil, fmt.Errorf("model database is required")
|
||||||
}
|
}
|
||||||
if w.options == nil {
|
if w.options == nil {
|
||||||
w.options = &writers.WriterOptions{}
|
w.options = &writers.WriterOptions{}
|
||||||
@@ -58,26 +61,6 @@ func (w *MigrationWriter) WriteMigration(model, current *models.Database) error
|
|||||||
current = models.InitDatabase(model.Name)
|
current = models.InitDatabase(model.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
var writer io.Writer
|
|
||||||
var file *os.File
|
|
||||||
var err error
|
|
||||||
|
|
||||||
// Use existing writer if already set (for testing)
|
|
||||||
if w.writer != nil {
|
|
||||||
writer = w.writer
|
|
||||||
} else if w.options.OutputPath != "" {
|
|
||||||
file, err = os.Create(w.options.OutputPath)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("failed to create output file: %w", err)
|
|
||||||
}
|
|
||||||
defer file.Close()
|
|
||||||
writer = file
|
|
||||||
} else {
|
|
||||||
writer = os.Stdout
|
|
||||||
}
|
|
||||||
|
|
||||||
w.writer = writer
|
|
||||||
|
|
||||||
// Check if audit is configured in metadata
|
// Check if audit is configured in metadata
|
||||||
var auditConfig *AuditConfig
|
var auditConfig *AuditConfig
|
||||||
if w.options.Metadata != nil {
|
if w.options.Metadata != nil {
|
||||||
@@ -93,7 +76,7 @@ func (w *MigrationWriter) WriteMigration(model, current *models.Database) error
|
|||||||
if auditConfig != nil && len(auditConfig.EnabledTables) > 0 {
|
if auditConfig != nil && len(auditConfig.EnabledTables) > 0 {
|
||||||
auditTableScript, err := w.generateAuditTablesScript(auditConfig)
|
auditTableScript, err := w.generateAuditTablesScript(auditConfig)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to generate audit tables: %w", err)
|
return nil, fmt.Errorf("failed to generate audit tables: %w", err)
|
||||||
}
|
}
|
||||||
scripts = append(scripts, auditTableScript...)
|
scripts = append(scripts, auditTableScript...)
|
||||||
}
|
}
|
||||||
@@ -119,7 +102,7 @@ func (w *MigrationWriter) WriteMigration(model, current *models.Database) error
|
|||||||
// Generate schema-level scripts
|
// Generate schema-level scripts
|
||||||
schemaScripts, err := w.generateSchemaScripts(modelSchema, currentSchema)
|
schemaScripts, err := w.generateSchemaScripts(modelSchema, currentSchema)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to generate schema scripts: %w", err)
|
return nil, fmt.Errorf("failed to generate schema scripts: %w", err)
|
||||||
}
|
}
|
||||||
scripts = append(scripts, schemaScripts...)
|
scripts = append(scripts, schemaScripts...)
|
||||||
|
|
||||||
@@ -127,7 +110,7 @@ func (w *MigrationWriter) WriteMigration(model, current *models.Database) error
|
|||||||
if auditConfig != nil {
|
if auditConfig != nil {
|
||||||
auditScripts, err := w.generateAuditScripts(modelSchema, auditConfig)
|
auditScripts, err := w.generateAuditScripts(modelSchema, auditConfig)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to generate audit scripts: %w", err)
|
return nil, fmt.Errorf("failed to generate audit scripts: %w", err)
|
||||||
}
|
}
|
||||||
scripts = append(scripts, auditScripts...)
|
scripts = append(scripts, auditScripts...)
|
||||||
}
|
}
|
||||||
@@ -141,6 +124,45 @@ func (w *MigrationWriter) WriteMigration(model, current *models.Database) error
|
|||||||
return scripts[i].Sequence < scripts[j].Sequence
|
return scripts[i].Sequence < scripts[j].Sequence
|
||||||
})
|
})
|
||||||
|
|
||||||
|
return scripts, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteMigration generates migration scripts using templates
|
||||||
|
func (w *MigrationWriter) WriteMigration(model, current *models.Database) error {
|
||||||
|
if model == nil {
|
||||||
|
return fmt.Errorf("model database is required")
|
||||||
|
}
|
||||||
|
if w.options == nil {
|
||||||
|
w.options = &writers.WriterOptions{}
|
||||||
|
}
|
||||||
|
if current == nil {
|
||||||
|
current = models.InitDatabase(model.Name)
|
||||||
|
}
|
||||||
|
|
||||||
|
scripts, err := w.GenerateScripts(model, current)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var writer io.Writer
|
||||||
|
var file *os.File
|
||||||
|
|
||||||
|
// Use existing writer if already set (for testing)
|
||||||
|
if w.writer != nil {
|
||||||
|
writer = w.writer
|
||||||
|
} else if w.options.OutputPath != "" {
|
||||||
|
file, err = os.Create(w.options.OutputPath)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to create output file: %w", err)
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
writer = file
|
||||||
|
} else {
|
||||||
|
writer = os.Stdout
|
||||||
|
}
|
||||||
|
|
||||||
|
w.writer = writer
|
||||||
|
|
||||||
// Write header
|
// Write header
|
||||||
fmt.Fprintf(w.writer, "-- PostgreSQL Migration Script\n")
|
fmt.Fprintf(w.writer, "-- PostgreSQL Migration Script\n")
|
||||||
fmt.Fprintf(w.writer, "-- Generated by RelSpec\n")
|
fmt.Fprintf(w.writer, "-- Generated by RelSpec\n")
|
||||||
@@ -241,10 +263,14 @@ func (w *MigrationWriter) generateDropScripts(model, current *models.Schema) ([]
|
|||||||
// Check each constraint in current database
|
// Check each constraint in current database
|
||||||
for _, currentConstraint := range sortConstraints(currentTable.Constraints) {
|
for _, currentConstraint := range sortConstraints(currentTable.Constraints) {
|
||||||
constraintName := currentConstraint.Name
|
constraintName := currentConstraint.Name
|
||||||
modelConstraint, existsInModel := modelTable.Constraints[constraintName]
|
modelConstraint, existsInModel := lookupConstraint(modelTable.Constraints, constraintName)
|
||||||
|
|
||||||
shouldDrop := false
|
shouldDrop := false
|
||||||
if !existsInModel {
|
if currentConstraint.Type == models.PrimaryKeyConstraint {
|
||||||
|
// Model primary keys usually live on the columns (not as a named constraint), so
|
||||||
|
// compare by key columns instead of constraint name.
|
||||||
|
shouldDrop = !primaryKeyColumnsMatch(modelTable, currentConstraint)
|
||||||
|
} else if !existsInModel {
|
||||||
shouldDrop = true
|
shouldDrop = true
|
||||||
} else if !constraintsEqual(modelConstraint, currentConstraint) {
|
} else if !constraintsEqual(modelConstraint, currentConstraint) {
|
||||||
shouldDrop = true
|
shouldDrop = true
|
||||||
@@ -316,6 +342,12 @@ func (w *MigrationWriter) generateDropScripts(model, current *models.Schema) ([]
|
|||||||
indexName := currentIndex.Name
|
indexName := currentIndex.Name
|
||||||
modelIndex, existsInModel := modelTable.Indexes[indexName]
|
modelIndex, existsInModel := modelTable.Indexes[indexName]
|
||||||
|
|
||||||
|
// A live database reports the index backing a unique/primary constraint as an
|
||||||
|
// index too; it belongs to the constraint and is handled there.
|
||||||
|
if _, backsConstraint := currentTable.Constraints[indexName]; backsConstraint {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
shouldDrop := false
|
shouldDrop := false
|
||||||
if !existsInModel {
|
if !existsInModel {
|
||||||
shouldDrop = true
|
shouldDrop = true
|
||||||
@@ -410,6 +442,7 @@ func (w *MigrationWriter) generateAlterTableScripts(schema *models.Schema, model
|
|||||||
if !exists {
|
if !exists {
|
||||||
// Column doesn't exist, add it
|
// Column doesn't exist, add it
|
||||||
_, defaultVal := formatColumnDefaultSQL(modelCol)
|
_, defaultVal := formatColumnDefaultSQL(modelCol)
|
||||||
|
generated, identity := columnGenerationClauses(modelCol)
|
||||||
|
|
||||||
sql, err := w.executor.ExecuteAddColumn(AddColumnData{
|
sql, err := w.executor.ExecuteAddColumn(AddColumnData{
|
||||||
SchemaName: schema.Name,
|
SchemaName: schema.Name,
|
||||||
@@ -418,6 +451,8 @@ func (w *MigrationWriter) generateAlterTableScripts(schema *models.Schema, model
|
|||||||
ColumnType: effectiveColumnSQLType(modelCol),
|
ColumnType: effectiveColumnSQLType(modelCol),
|
||||||
Default: defaultVal,
|
Default: defaultVal,
|
||||||
NotNull: modelCol.NotNull,
|
NotNull: modelCol.NotNull,
|
||||||
|
Generated: generated,
|
||||||
|
Identity: identity,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -470,7 +505,7 @@ func (w *MigrationWriter) generateAlterTableScripts(schema *models.Schema, model
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Check default value changes
|
// Check default value changes
|
||||||
if !columnDefaultsEqual(modelCol.Default, currentCol.Default) {
|
if !isSerialWithoutDefault(modelCol) && !columnDefaultsEqual(modelCol.Default, currentCol.Default) {
|
||||||
setDefault, defaultVal := formatColumnDefaultSQL(modelCol)
|
setDefault, defaultVal := formatColumnDefaultSQL(modelCol)
|
||||||
|
|
||||||
sql, err := w.executor.ExecuteAlterColumnDefaultWithCheck(AlterColumnDefaultWithCheckData{
|
sql, err := w.executor.ExecuteAlterColumnDefaultWithCheck(AlterColumnDefaultWithCheckData{
|
||||||
@@ -747,7 +782,7 @@ func (w *MigrationWriter) generateForeignKeyScripts(model, current *models.Schem
|
|||||||
if !shouldCreate {
|
if !shouldCreate {
|
||||||
if currentTable == nil {
|
if currentTable == nil {
|
||||||
shouldCreate = true
|
shouldCreate = true
|
||||||
} else if currentConstraint, exists := currentTable.Constraints[constraintName]; !exists {
|
} else if currentConstraint, exists := lookupConstraint(currentTable.Constraints, constraintName); !exists {
|
||||||
shouldCreate = true
|
shouldCreate = true
|
||||||
} else if !constraintsEqual(constraint, currentConstraint) {
|
} else if !constraintsEqual(constraint, currentConstraint) {
|
||||||
shouldCreate = true
|
shouldCreate = true
|
||||||
@@ -799,12 +834,20 @@ func (w *MigrationWriter) generateForeignKeyScripts(model, current *models.Schem
|
|||||||
// generateCommentScripts generates COMMENT ON scripts using templates
|
// generateCommentScripts generates COMMENT ON scripts using templates
|
||||||
func (w *MigrationWriter) generateCommentScripts(model, current *models.Schema) ([]MigrationScript, error) {
|
func (w *MigrationWriter) generateCommentScripts(model, current *models.Schema) ([]MigrationScript, error) {
|
||||||
scripts := make([]MigrationScript, 0)
|
scripts := make([]MigrationScript, 0)
|
||||||
_ = current // TODO: Compare with current schema to only add new/changed comments
|
|
||||||
|
currentTables := make(map[string]*models.Table)
|
||||||
|
if current != nil {
|
||||||
|
for _, table := range current.Tables {
|
||||||
|
currentTables[strings.ToLower(table.Name)] = table
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Process each model table
|
// Process each model table
|
||||||
for _, modelTable := range model.Tables {
|
for _, modelTable := range model.Tables {
|
||||||
// Table comment
|
currentTable := currentTables[strings.ToLower(modelTable.Name)]
|
||||||
if modelTable.Description != "" {
|
|
||||||
|
// Table comment (skipped when the live table already carries the same comment)
|
||||||
|
if modelTable.Description != "" && (currentTable == nil || strings.TrimSpace(currentTable.Description) != strings.TrimSpace(modelTable.Description)) {
|
||||||
sql, err := w.executor.ExecuteCommentTable(CommentTableData{
|
sql, err := w.executor.ExecuteCommentTable(CommentTableData{
|
||||||
SchemaName: model.Name,
|
SchemaName: model.Name,
|
||||||
TableName: modelTable.Name,
|
TableName: modelTable.Name,
|
||||||
@@ -827,7 +870,7 @@ func (w *MigrationWriter) generateCommentScripts(model, current *models.Schema)
|
|||||||
|
|
||||||
// Column comments
|
// Column comments
|
||||||
for _, col := range sortColumns(modelTable.Columns) {
|
for _, col := range sortColumns(modelTable.Columns) {
|
||||||
if col.Description != "" {
|
if col.Description != "" && !currentColumnHasDescription(currentTable, col) {
|
||||||
sql, err := w.executor.ExecuteCommentColumn(CommentColumnData{
|
sql, err := w.executor.ExecuteCommentColumn(CommentColumnData{
|
||||||
SchemaName: model.Name,
|
SchemaName: model.Name,
|
||||||
TableName: modelTable.Name,
|
TableName: modelTable.Name,
|
||||||
@@ -994,18 +1037,80 @@ func normalizeDefaultForCompare(value interface{}) string {
|
|||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
if s, ok := value.(string); ok {
|
if s, ok := value.(string); ok {
|
||||||
return strings.TrimSpace(stripBackticks(s))
|
return normalizeDefaultLiteral(strings.TrimSpace(stripBackticks(s)))
|
||||||
}
|
}
|
||||||
return fmt.Sprintf("%v", value)
|
return fmt.Sprintf("%v", value)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// normalizeDefaultLiteral removes a trailing ::type cast and the quotes around a plain string
|
||||||
|
// literal, so a DBML default ('[]') and the one a live database reports ('[]'::jsonb) compare equal.
|
||||||
|
func normalizeDefaultLiteral(s string) string {
|
||||||
|
if strings.HasPrefix(s, "'") {
|
||||||
|
if end := strings.LastIndex(s, "'"); end > 0 {
|
||||||
|
rest := strings.TrimSpace(s[end+1:])
|
||||||
|
if rest == "" || strings.HasPrefix(rest, "::") {
|
||||||
|
return normalizeJSONLiteral(strings.ReplaceAll(s[1:end], "''", "'"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
if strings.HasPrefix(s, "(") && strings.Contains(s, ")::") {
|
||||||
|
return normalizeCastExpression(s)
|
||||||
|
}
|
||||||
|
return normalizeJSONLiteral(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
// normalizeJSONLiteral compacts JSON text, since jsonb reports defaults re-spaced
|
||||||
|
// ('["a", "b"]') while the model usually holds them minified.
|
||||||
|
func normalizeJSONLiteral(s string) string {
|
||||||
|
if !strings.HasPrefix(s, "[") && !strings.HasPrefix(s, "{") {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := json.Compact(&buf, []byte(s)); err != nil {
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// normalizeCastExpression strips whitespace and the redundant parentheses PostgreSQL adds
|
||||||
|
// around an expression it casts: (gen_random_uuid())::text -> gen_random_uuid()::text.
|
||||||
|
func normalizeCastExpression(s string) string {
|
||||||
|
s = strings.Join(strings.Fields(s), "")
|
||||||
|
for strings.HasPrefix(s, "(") {
|
||||||
|
end := strings.LastIndex(s, ")::")
|
||||||
|
if end < 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
inner := s[1:end]
|
||||||
|
depth := 0
|
||||||
|
balanced := true
|
||||||
|
for _, r := range inner {
|
||||||
|
if r == '(' {
|
||||||
|
depth++
|
||||||
|
} else if r == ')' {
|
||||||
|
depth--
|
||||||
|
if depth < 0 {
|
||||||
|
balanced = false
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !balanced || depth != 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
s = inner + s[end+1:]
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
func columnTypesEqual(col1, col2 *models.Column) bool {
|
func columnTypesEqual(col1, col2 *models.Column) bool {
|
||||||
if col1 == nil || col2 == nil {
|
if col1 == nil || col2 == nil {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
return strings.EqualFold(
|
return strings.EqualFold(
|
||||||
pgsql.NormalizeEquivalentSQLType(effectiveColumnSQLType(col1)),
|
normalizeZeroScale(pgsql.NormalizeEquivalentSQLType(effectiveAlterColumnSQLType(col1))),
|
||||||
pgsql.NormalizeEquivalentSQLType(effectiveColumnSQLType(col2)),
|
normalizeZeroScale(pgsql.NormalizeEquivalentSQLType(effectiveAlterColumnSQLType(col2))),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1041,7 +1146,7 @@ func constraintsEqual(c1, c2 *models.Constraint) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if c1.OnDelete != c2.OnDelete || c1.OnUpdate != c2.OnUpdate {
|
if !fkActionsEqual(c1.OnDelete, c2.OnDelete) || !fkActionsEqual(c1.OnUpdate, c2.OnUpdate) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1057,7 +1162,7 @@ func indexesEqual(idx1, idx2 *models.Index) bool {
|
|||||||
if idx1.Unique != idx2.Unique {
|
if idx1.Unique != idx2.Unique {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
if !strings.EqualFold(idx1.Type, idx2.Type) {
|
if !strings.EqualFold(normalizeIndexMethod(idx1.Type), normalizeIndexMethod(idx2.Type)) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
if len(idx1.Columns) != len(idx2.Columns) {
|
if len(idx1.Columns) != len(idx2.Columns) {
|
||||||
@@ -1077,6 +1182,104 @@ func indexesEqual(idx1, idx2 *models.Index) bool {
|
|||||||
return indexHintsEqual(indexStorageParameters(idx1.Comment), indexStorageParameters(idx2.Comment))
|
return indexHintsEqual(indexStorageParameters(idx1.Comment), indexStorageParameters(idx2.Comment))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// normalizeZeroScale turns numeric(p,0) into numeric(p); PostgreSQL treats them as the same type.
|
||||||
|
func normalizeZeroScale(sqlType string) string {
|
||||||
|
if i := strings.Index(sqlType, "("); i >= 0 && strings.HasSuffix(sqlType, ",0)") && !strings.Contains(sqlType[i:], "[") {
|
||||||
|
return strings.TrimSuffix(sqlType, ",0)") + ")"
|
||||||
|
}
|
||||||
|
return sqlType
|
||||||
|
}
|
||||||
|
|
||||||
|
// maxIdentifierBytes is PostgreSQL's identifier length limit; longer names are truncated on creation.
|
||||||
|
const maxIdentifierBytes = 63
|
||||||
|
|
||||||
|
// pgIdentifier returns name as PostgreSQL stores it (truncated to 63 bytes).
|
||||||
|
func pgIdentifier(name string) string {
|
||||||
|
if len(name) > maxIdentifierBytes {
|
||||||
|
return name[:maxIdentifierBytes]
|
||||||
|
}
|
||||||
|
return name
|
||||||
|
}
|
||||||
|
|
||||||
|
// lookupConstraint finds a constraint by name, also matching names that differ only because
|
||||||
|
// PostgreSQL truncated an over-long identifier.
|
||||||
|
func lookupConstraint(constraints map[string]*models.Constraint, name string) (*models.Constraint, bool) {
|
||||||
|
if c, ok := constraints[name]; ok {
|
||||||
|
return c, true
|
||||||
|
}
|
||||||
|
want := pgIdentifier(name)
|
||||||
|
for n, c := range constraints {
|
||||||
|
if pgIdentifier(n) == want {
|
||||||
|
return c, true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// currentColumnHasDescription reports whether the live table's column already carries
|
||||||
|
// the model column's comment.
|
||||||
|
func currentColumnHasDescription(currentTable *models.Table, col *models.Column) bool {
|
||||||
|
if currentTable == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, cc := range currentTable.Columns {
|
||||||
|
if strings.EqualFold(cc.Name, col.Name) {
|
||||||
|
return strings.TrimSpace(cc.Description) == strings.TrimSpace(col.Description)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// primaryKeyColumnsMatch reports whether the model table's primary key (an explicit PK
|
||||||
|
// constraint or columns flagged IsPrimaryKey) has the same columns, in order, as current.
|
||||||
|
func primaryKeyColumnsMatch(modelTable *models.Table, current *models.Constraint) bool {
|
||||||
|
var modelCols []string
|
||||||
|
for _, c := range sortConstraints(modelTable.Constraints) {
|
||||||
|
if c.Type == models.PrimaryKeyConstraint {
|
||||||
|
modelCols = c.Columns
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if modelCols == nil {
|
||||||
|
for _, col := range getSortedColumns(modelTable.Columns) {
|
||||||
|
if col.IsPrimaryKey {
|
||||||
|
modelCols = append(modelCols, col.Name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(modelCols) != len(current.Columns) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for i, col := range modelCols {
|
||||||
|
if !strings.EqualFold(col, current.Columns[i]) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// normalizeIndexMethod maps an unspecified index method to PostgreSQL's default (btree),
|
||||||
|
// which is what a live database reports for it.
|
||||||
|
func normalizeIndexMethod(method string) string {
|
||||||
|
if strings.TrimSpace(method) == "" {
|
||||||
|
return "btree"
|
||||||
|
}
|
||||||
|
return method
|
||||||
|
}
|
||||||
|
|
||||||
|
// fkActionsEqual compares referential actions case-insensitively, treating an unspecified
|
||||||
|
// action as PostgreSQL's default (NO ACTION).
|
||||||
|
func fkActionsEqual(a, b string) bool {
|
||||||
|
norm := func(s string) string {
|
||||||
|
s = strings.ToUpper(strings.TrimSpace(s))
|
||||||
|
if s == "" {
|
||||||
|
return "NO ACTION"
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
return norm(a) == norm(b)
|
||||||
|
}
|
||||||
|
|
||||||
// indexHintsEqual compares two optional index hints, treating an unspecified hint as a match.
|
// indexHintsEqual compares two optional index hints, treating an unspecified hint as a match.
|
||||||
func indexHintsEqual(hint1, hint2 string) bool {
|
func indexHintsEqual(hint1, hint2 string) bool {
|
||||||
if hint1 == "" || hint2 == "" {
|
if hint1 == "" || hint2 == "" {
|
||||||
|
|||||||
@@ -0,0 +1,163 @@
|
|||||||
|
package pgsql
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func serialTestTable(colType string, def interface{}) *models.Table {
|
||||||
|
table := models.InitTable("login_event", "identity")
|
||||||
|
id := models.InitColumn("id_login_event", "login_event", "identity")
|
||||||
|
id.Type = colType
|
||||||
|
id.IsPrimaryKey = true
|
||||||
|
id.Default = def
|
||||||
|
table.Columns["id_login_event"] = id
|
||||||
|
return table
|
||||||
|
}
|
||||||
|
|
||||||
|
func serialTestDB(table *models.Table) *models.Database {
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
schema := models.InitSchema("identity")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
return db
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSequences_FollowPrimaryKeyDefault(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
table *models.Table
|
||||||
|
wantContain []string
|
||||||
|
wantAbsent []string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "nextval default uses its own sequence",
|
||||||
|
table: serialTestTable("bigint", "nextval('identity.login_event_id_login_event_seq'::regclass)"),
|
||||||
|
wantContain: []string{
|
||||||
|
"login_event_id_login_event_seq",
|
||||||
|
"setval(",
|
||||||
|
},
|
||||||
|
wantAbsent: []string{"identity_login_event_id_login_event"},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "no default creates no sequence",
|
||||||
|
table: serialTestTable("bigint", nil),
|
||||||
|
wantAbsent: []string{"CREATE SEQUENCE", "setval("},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bigserial without default creates no extra sequence",
|
||||||
|
table: serialTestTable("bigserial", nil),
|
||||||
|
wantAbsent: []string{"CREATE SEQUENCE", "setval(", "identity_login_event_id_login_event"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tt := range tests {
|
||||||
|
t.Run(tt.name, func(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
w.writer = &buf
|
||||||
|
if err := w.WriteDatabase(serialTestDB(tt.table)); err != nil {
|
||||||
|
t.Fatalf("WriteDatabase failed: %v", err)
|
||||||
|
}
|
||||||
|
full := buf.String()
|
||||||
|
|
||||||
|
stmts, err := w.GenerateDatabaseStatements(serialTestDB(tt.table))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("GenerateDatabaseStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
for label, out := range map[string]string{"WriteDatabase": full, "GenerateDatabaseStatements": diffJoin(stmts)} {
|
||||||
|
for _, s := range tt.wantContain {
|
||||||
|
if !strings.Contains(out, s) {
|
||||||
|
t.Errorf("%s: missing %q\n%s", label, s, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, s := range tt.wantAbsent {
|
||||||
|
if strings.Contains(out, s) {
|
||||||
|
t.Errorf("%s: unexpected %q\n%s", label, s, out)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSetSequenceValue_OnlyMovesForwardPastData(t *testing.T) {
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
table := serialTestTable("bigint", "nextval('identity.login_event_id_login_event_seq'::regclass)")
|
||||||
|
stmt, err := w.primaryKeySetvalStatement(serialTestDB(table).Schemas[0], table)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
for _, want := range []string{"MAX(", "is_called", "m_cnt > m_next", ", m_cnt, false)"} {
|
||||||
|
if !strings.Contains(stmt, want) {
|
||||||
|
t.Errorf("setval statement missing %q:\n%s", want, stmt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDiffStatements_ExistingTableNewSequenceIsSetPastData(t *testing.T) {
|
||||||
|
def := "nextval('identity.login_event_id_login_event_seq'::regclass)"
|
||||||
|
model := serialTestDB(serialTestTable("bigint", def))
|
||||||
|
current := serialTestDB(serialTestTable("bigint", nil))
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
out := diffJoin(stmts)
|
||||||
|
seqIdx := strings.Index(out, "CREATE SEQUENCE IF NOT EXISTS identity.login_event_id_login_event_seq")
|
||||||
|
setvalIdx := strings.Index(out, "setval(")
|
||||||
|
if seqIdx < 0 || setvalIdx < 0 || seqIdx > setvalIdx {
|
||||||
|
t.Fatalf("expected sequence creation before setval, got:\n%s", out)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sequence already present in the database: nothing to create or move.
|
||||||
|
current.Schemas[0].Sequences = append(current.Schemas[0].Sequences,
|
||||||
|
models.InitSequence("login_event_id_login_event_seq", "identity"))
|
||||||
|
stmts, err = w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if strings.Contains(diffJoin(stmts), "setval(") || strings.Contains(diffJoin(stmts), "CREATE SEQUENCE") {
|
||||||
|
t.Fatalf("existing sequence must be left alone:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSerialWithoutDefault_DoesNotDropExistingDefault(t *testing.T) {
|
||||||
|
def := "nextval('identity.login_event_id_login_event_seq'::regclass)"
|
||||||
|
model := serialTestDB(serialTestTable("bigserial", nil))
|
||||||
|
current := serialTestDB(serialTestTable("bigserial", def))
|
||||||
|
|
||||||
|
w := NewWriter(&writers.WriterOptions{})
|
||||||
|
stmts, err := w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("diffStatements failed: %v", err)
|
||||||
|
}
|
||||||
|
if strings.Contains(strings.ToUpper(diffJoin(stmts)), "DROP DEFAULT") {
|
||||||
|
t.Fatalf("serial default must not be dropped:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
|
||||||
|
alter, err := w.GenerateAlterColumnDefaultStatements(model.Schemas[0])
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if strings.Contains(strings.ToUpper(diffJoin(alter)), "DROP DEFAULT") {
|
||||||
|
t.Fatalf("full-DDL path must not drop serial default:\n%s", diffJoin(alter))
|
||||||
|
}
|
||||||
|
|
||||||
|
// A plain bigint with no model default still has its default dropped.
|
||||||
|
model = serialTestDB(serialTestTable("bigint", nil))
|
||||||
|
current = serialTestDB(serialTestTable("bigint", def))
|
||||||
|
stmts, err = w.diffStatements(model, current)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(strings.ToUpper(diffJoin(stmts)), "DROP DEFAULT") {
|
||||||
|
t.Fatalf("non-serial default removal should still be emitted:\n%s", diffJoin(stmts))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -77,6 +77,10 @@ type ColumnData struct {
|
|||||||
Type string
|
Type string
|
||||||
Default string
|
Default string
|
||||||
NotNull bool
|
NotNull bool
|
||||||
|
// Generated is the expression of a GENERATED ALWAYS AS (...) STORED column.
|
||||||
|
Generated string
|
||||||
|
// Identity is "ALWAYS" or "BY DEFAULT" for a GENERATED ... AS IDENTITY column.
|
||||||
|
Identity string
|
||||||
}
|
}
|
||||||
|
|
||||||
// AddColumnData contains data for add column template
|
// AddColumnData contains data for add column template
|
||||||
@@ -87,6 +91,10 @@ type AddColumnData struct {
|
|||||||
ColumnType string
|
ColumnType string
|
||||||
Default string
|
Default string
|
||||||
NotNull bool
|
NotNull bool
|
||||||
|
// Generated is the expression of a GENERATED ALWAYS AS (...) STORED column.
|
||||||
|
Generated string
|
||||||
|
// Identity is "ALWAYS" or "BY DEFAULT" for a GENERATED ... AS IDENTITY column.
|
||||||
|
Identity string
|
||||||
}
|
}
|
||||||
|
|
||||||
// AlterColumnTypeWithCheckData contains data for the guarded alter column
|
// AlterColumnTypeWithCheckData contains data for the guarded alter column
|
||||||
@@ -520,6 +528,19 @@ func (te *TemplateExecutor) ExecuteCreatePrimaryKeyWithAutoGenCheck(data CreateP
|
|||||||
|
|
||||||
// Helper functions to build template data from models
|
// Helper functions to build template data from models
|
||||||
|
|
||||||
|
// columnGenerationClauses returns the generation expression of a GENERATED ... STORED
|
||||||
|
// column and the generation mode of an identity column ("" for each that does not apply).
|
||||||
|
// Such columns cannot carry a DEFAULT.
|
||||||
|
func columnGenerationClauses(col *models.Column) (generated, identity string) {
|
||||||
|
if col.Generated && col.GenerationExpression != "" {
|
||||||
|
return col.GenerationExpression, ""
|
||||||
|
}
|
||||||
|
if col.Identity && col.IdentityGeneration != "" {
|
||||||
|
return "", strings.ToUpper(col.IdentityGeneration)
|
||||||
|
}
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
|
||||||
// BuildCreateTableData builds CreateTableData from a models.Table
|
// BuildCreateTableData builds CreateTableData from a models.Table
|
||||||
func BuildCreateTableData(schemaName string, table *models.Table) CreateTableData {
|
func BuildCreateTableData(schemaName string, table *models.Table) CreateTableData {
|
||||||
columns := make([]ColumnData, 0, len(table.Columns))
|
columns := make([]ColumnData, 0, len(table.Columns))
|
||||||
@@ -532,7 +553,8 @@ func BuildCreateTableData(schemaName string, table *models.Table) CreateTableDat
|
|||||||
Type: col.Type,
|
Type: col.Type,
|
||||||
NotNull: col.NotNull,
|
NotNull: col.NotNull,
|
||||||
}
|
}
|
||||||
if col.Default != nil {
|
colData.Generated, colData.Identity = columnGenerationClauses(col)
|
||||||
|
if col.Default != nil && colData.Generated == "" && colData.Identity == "" {
|
||||||
if value, ok := col.Default.(string); ok {
|
if value, ok := col.Default.(string); ok {
|
||||||
colData.Default = writers.QuoteDefaultValue(stripBackticks(value), col.Type)
|
colData.Default = writers.QuoteDefaultValue(stripBackticks(value), col.Type)
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
ALTER TABLE {{qual_table .SchemaName .TableName}}
|
ALTER TABLE {{qual_table .SchemaName .TableName}}
|
||||||
ADD COLUMN IF NOT EXISTS {{quote_ident .ColumnName}} {{.ColumnType}}
|
ADD COLUMN IF NOT EXISTS {{quote_ident .ColumnName}} {{.ColumnType}}
|
||||||
{{- if .Default}} DEFAULT {{.Default}}{{end}}
|
{{- if .Generated}} GENERATED ALWAYS AS ({{.Generated}}) STORED{{end}}
|
||||||
|
{{- if .Identity}} GENERATED {{.Identity}} AS IDENTITY{{end}}
|
||||||
|
{{- if and .Default (not .Generated) (not .Identity)}} DEFAULT {{.Default}}{{end}}
|
||||||
{{- if .NotNull}} NOT NULL{{end}};
|
{{- if .NotNull}} NOT NULL{{end}};
|
||||||
@@ -2,7 +2,9 @@ CREATE TABLE IF NOT EXISTS {{qual_table .SchemaName .TableName}} (
|
|||||||
{{- range $i, $col := .Columns}}
|
{{- range $i, $col := .Columns}}
|
||||||
{{- if $i}},{{end}}
|
{{- if $i}},{{end}}
|
||||||
{{quote_ident $col.Name}} {{$col.Type}}
|
{{quote_ident $col.Name}} {{$col.Type}}
|
||||||
{{- if $col.Default}} DEFAULT {{$col.Default}}{{end}}
|
{{- if $col.Generated}} GENERATED ALWAYS AS ({{$col.Generated}}) STORED{{end}}
|
||||||
|
{{- if $col.Identity}} GENERATED {{$col.Identity}} AS IDENTITY{{end}}
|
||||||
|
{{- if and $col.Default (not $col.Generated) (not $col.Identity)}} DEFAULT {{$col.Default}}{{end}}
|
||||||
{{- if $col.NotNull}} NOT NULL{{end}}
|
{{- if $col.NotNull}} NOT NULL{{end}}
|
||||||
{{- end}}
|
{{- end}}
|
||||||
);
|
);
|
||||||
@@ -3,7 +3,9 @@
|
|||||||
{{/* Column definition fragment */}}
|
{{/* Column definition fragment */}}
|
||||||
{{- define "column_definition" -}}
|
{{- define "column_definition" -}}
|
||||||
{{.Name}} {{.Type}}
|
{{.Name}} {{.Type}}
|
||||||
{{- if .Default}} DEFAULT {{.Default}}{{end}}
|
{{- if .Generated}} GENERATED ALWAYS AS ({{.Generated}}) STORED{{end}}
|
||||||
|
{{- if .Identity}} GENERATED {{.Identity}} AS IDENTITY{{end}}
|
||||||
|
{{- if and .Default (not .Generated) (not .Identity)}} DEFAULT {{.Default}}{{end}}
|
||||||
{{- if .NotNull}} NOT NULL{{end}}
|
{{- if .NotNull}} NOT NULL{{end}}
|
||||||
{{- end -}}
|
{{- end -}}
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
DO $$
|
DO $$
|
||||||
DECLARE
|
DECLARE
|
||||||
m_cnt bigint;
|
m_cnt bigint;
|
||||||
|
m_next bigint;
|
||||||
BEGIN
|
BEGIN
|
||||||
IF EXISTS (
|
IF EXISTS (
|
||||||
SELECT 1 FROM pg_class c
|
SELECT 1 FROM pg_class c
|
||||||
@@ -12,8 +13,15 @@ BEGIN
|
|||||||
SELECT COALESCE(MAX({{quote_ident .ColumnName}}), 0) + 1
|
SELECT COALESCE(MAX({{quote_ident .ColumnName}}), 0) + 1
|
||||||
FROM {{qual_table .SchemaName .TableName}}
|
FROM {{qual_table .SchemaName .TableName}}
|
||||||
INTO m_cnt;
|
INTO m_cnt;
|
||||||
|
|
||||||
PERFORM setval('{{qual_table_raw .SchemaName .SequenceName}}'::regclass, m_cnt);
|
SELECT CASE WHEN is_called THEN last_value + 1 ELSE last_value END
|
||||||
|
FROM {{qual_table .SchemaName .SequenceName}}
|
||||||
|
INTO m_next;
|
||||||
|
|
||||||
|
-- Only move the sequence forward; never rewind one that is already past the data.
|
||||||
|
IF m_cnt > m_next THEN
|
||||||
|
PERFORM setval('{{qual_table_raw .SchemaName .SequenceName}}'::regclass, m_cnt, false);
|
||||||
|
END IF;
|
||||||
END IF;
|
END IF;
|
||||||
END;
|
END;
|
||||||
$$;
|
$$;
|
||||||
+227
-36
@@ -14,6 +14,8 @@ import (
|
|||||||
|
|
||||||
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
"git.warky.dev/wdevs/relspecgo/pkg/pgsql"
|
"git.warky.dev/wdevs/relspecgo/pkg/pgsql"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
rpgsql "git.warky.dev/wdevs/relspecgo/pkg/readers/pgsql"
|
||||||
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -139,6 +141,50 @@ func (w *Writer) GenerateDatabaseStatements(db *models.Database) ([]string, erro
|
|||||||
return statements, nil
|
return statements, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// primaryKeySequenceName returns the name of the sequence behind a table's integer
|
||||||
|
// primary key nextval() default, or "" when the key has no such default.
|
||||||
|
func primaryKeySequenceName(table *models.Table) string {
|
||||||
|
pk := table.GetPrimaryKey()
|
||||||
|
if pk == nil || !isIntegerType(pk.Type) || pk.Default == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultStr, ok := pk.Default.(string)
|
||||||
|
if !ok || !strings.Contains(strings.ToLower(defaultStr), "nextval") {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return extractSequenceName(defaultStr)
|
||||||
|
}
|
||||||
|
|
||||||
|
// primaryKeySequenceStatement returns the CREATE SEQUENCE statement backing a table's
|
||||||
|
// integer primary key nextval() default, or "" when the table has no such sequence.
|
||||||
|
func (w *Writer) primaryKeySequenceStatement(schema *models.Schema, table *models.Table) string {
|
||||||
|
seqName := primaryKeySequenceName(table)
|
||||||
|
if seqName == "" {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
return fmt.Sprintf("CREATE SEQUENCE IF NOT EXISTS %s\n INCREMENT 1\n MINVALUE 1\n MAXVALUE 9223372036854775807\n START 1\n CACHE 1",
|
||||||
|
w.qualTable(schema.SQLName(), seqName))
|
||||||
|
}
|
||||||
|
|
||||||
|
// primaryKeySetvalStatement returns the statement that moves a table's primary key
|
||||||
|
// sequence past the existing rows, or "" when the table has no such sequence.
|
||||||
|
func (w *Writer) primaryKeySetvalStatement(schema *models.Schema, table *models.Table) (string, error) {
|
||||||
|
seqName := primaryKeySequenceName(table)
|
||||||
|
if seqName == "" {
|
||||||
|
return "", nil
|
||||||
|
}
|
||||||
|
pk := table.GetPrimaryKey()
|
||||||
|
return w.executor.ExecuteSetSequenceValue(SetSequenceValueData{
|
||||||
|
SchemaName: schema.Name,
|
||||||
|
TableName: table.Name,
|
||||||
|
SequenceName: seqName,
|
||||||
|
ColumnName: pk.Name,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
// GenerateSchemaStatements generates SQL statements as a list for a single schema
|
// GenerateSchemaStatements generates SQL statements as a list for a single schema
|
||||||
func (w *Writer) GenerateSchemaStatements(schema *models.Schema) ([]string, error) {
|
func (w *Writer) GenerateSchemaStatements(schema *models.Schema) ([]string, error) {
|
||||||
statements := []string{}
|
statements := []string{}
|
||||||
@@ -159,24 +205,9 @@ func (w *Writer) GenerateSchemaStatements(schema *models.Schema) ([]string, erro
|
|||||||
|
|
||||||
// Phase 2: Create sequences
|
// Phase 2: Create sequences
|
||||||
for _, table := range schema.Tables {
|
for _, table := range schema.Tables {
|
||||||
pk := table.GetPrimaryKey()
|
if stmt := w.primaryKeySequenceStatement(schema, table); stmt != "" {
|
||||||
if pk == nil || !isIntegerType(pk.Type) || pk.Default == "" {
|
statements = append(statements, stmt)
|
||||||
continue
|
|
||||||
}
|
}
|
||||||
|
|
||||||
defaultStr, ok := pk.Default.(string)
|
|
||||||
if !ok || !strings.Contains(strings.ToLower(defaultStr), "nextval") {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
seqName := extractSequenceName(defaultStr)
|
|
||||||
if seqName == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
stmt := fmt.Sprintf("CREATE SEQUENCE IF NOT EXISTS %s\n INCREMENT 1\n MINVALUE 1\n MAXVALUE 9223372036854775807\n START 1\n CACHE 1",
|
|
||||||
w.qualTable(schema.SQLName(), seqName))
|
|
||||||
statements = append(statements, stmt)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Phase 3: Create tables
|
// Phase 3: Create tables
|
||||||
@@ -391,6 +422,17 @@ func (w *Writer) GenerateSchemaStatements(schema *models.Schema) ([]string, erro
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Phase 6.5: Move primary key sequences past existing rows
|
||||||
|
for _, table := range schema.Tables {
|
||||||
|
stmt, err := w.primaryKeySetvalStatement(schema, table)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to generate set sequence value for %s.%s: %w", schema.Name, table.Name, err)
|
||||||
|
}
|
||||||
|
if stmt != "" {
|
||||||
|
statements = append(statements, stmt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Phase 7: Comments
|
// Phase 7: Comments
|
||||||
for _, table := range schema.Tables {
|
for _, table := range schema.Tables {
|
||||||
if table.Comment != "" {
|
if table.Comment != "" {
|
||||||
@@ -505,6 +547,11 @@ func (w *Writer) GenerateAlterColumnDefaultStatements(schema *models.Schema) ([]
|
|||||||
// backing sequence), so there is nothing for this generator to manage.
|
// backing sequence), so there is nothing for this generator to manage.
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
if isSerialWithoutDefault(col) {
|
||||||
|
// serial/bigserial columns get their nextval() default from the
|
||||||
|
// type itself; a model with no explicit default must not drop it.
|
||||||
|
continue
|
||||||
|
}
|
||||||
setDefault, defaultVal := formatColumnDefaultSQL(col)
|
setDefault, defaultVal := formatColumnDefaultSQL(col)
|
||||||
stmt, err := w.executor.ExecuteAlterColumnDefaultWithCheck(AlterColumnDefaultWithCheckData{
|
stmt, err := w.executor.ExecuteAlterColumnDefaultWithCheck(AlterColumnDefaultWithCheckData{
|
||||||
SchemaName: schema.Name,
|
SchemaName: schema.Name,
|
||||||
@@ -523,6 +570,19 @@ func (w *Writer) GenerateAlterColumnDefaultStatements(schema *models.Schema) ([]
|
|||||||
return statements, nil
|
return statements, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isSerialWithoutDefault reports whether col is a serial-family column with no
|
||||||
|
// explicit default, i.e. one whose nextval() default is implied by its type.
|
||||||
|
func isSerialWithoutDefault(col *models.Column) bool {
|
||||||
|
if col == nil || col.Default != nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
switch strings.ToLower(strings.TrimSpace(col.Type)) {
|
||||||
|
case "serial", "bigserial", "smallserial", "serial4", "serial8", "serial2":
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// formatColumnDefaultSQL renders a column's model-level default into the
|
// formatColumnDefaultSQL renders a column's model-level default into the
|
||||||
// SQL literal/expression used by ALTER COLUMN ... SET DEFAULT, shared by
|
// SQL literal/expression used by ALTER COLUMN ... SET DEFAULT, shared by
|
||||||
// the full-schema writer and the diff-based migration writer.
|
// the full-schema writer and the diff-based migration writer.
|
||||||
@@ -872,18 +932,12 @@ func (w *Writer) writeSequences(schema *models.Schema) error {
|
|||||||
fmt.Fprintf(w.writer, "-- Sequences for schema: %s\n", schema.Name)
|
fmt.Fprintf(w.writer, "-- Sequences for schema: %s\n", schema.Name)
|
||||||
|
|
||||||
for _, table := range schema.Tables {
|
for _, table := range schema.Tables {
|
||||||
pk := table.GetPrimaryKey()
|
// Only create the sequence the primary key's nextval() default uses
|
||||||
if pk == nil {
|
seqName := primaryKeySequenceName(table)
|
||||||
|
if seqName == "" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
// Only create sequences for integer-type PKs with identity
|
|
||||||
if !isIntegerType(pk.Type) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
seqName := fmt.Sprintf("identity_%s_%s", table.SQLName(), pk.SQLName())
|
|
||||||
|
|
||||||
data := CreateSequenceData{
|
data := CreateSequenceData{
|
||||||
SchemaName: schema.Name,
|
SchemaName: schema.Name,
|
||||||
SequenceName: seqName,
|
SequenceName: seqName,
|
||||||
@@ -1423,12 +1477,11 @@ func (w *Writer) writeSetSequenceValues(schema *models.Schema) error {
|
|||||||
fmt.Fprintf(w.writer, "-- Set sequence values for schema: %s\n", schema.Name)
|
fmt.Fprintf(w.writer, "-- Set sequence values for schema: %s\n", schema.Name)
|
||||||
|
|
||||||
for _, table := range schema.Tables {
|
for _, table := range schema.Tables {
|
||||||
pk := table.GetPrimaryKey()
|
seqName := primaryKeySequenceName(table)
|
||||||
if pk == nil || !isIntegerType(pk.Type) {
|
if seqName == "" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
pk := table.GetPrimaryKey()
|
||||||
seqName := fmt.Sprintf("identity_%s_%s", table.SQLName(), pk.SQLName())
|
|
||||||
|
|
||||||
// Use template executor to generate set sequence value statement
|
// Use template executor to generate set sequence value statement
|
||||||
data := SetSequenceValueData{
|
data := SetSequenceValueData{
|
||||||
@@ -1993,7 +2046,9 @@ func extractSequenceName(defaultExpr string) string {
|
|||||||
return fullName
|
return fullName
|
||||||
}
|
}
|
||||||
|
|
||||||
// executeDatabaseSQL executes SQL statements directly on a PostgreSQL database
|
// executeDatabaseSQL applies db to a PostgreSQL database. By default it reads the live schema
|
||||||
|
// and executes only the differences; Metadata["full_ddl"]=true (or a failed/unsupported live
|
||||||
|
// read) executes the full idempotent DDL instead.
|
||||||
func (w *Writer) executeDatabaseSQL(db *models.Database, connString string) error {
|
func (w *Writer) executeDatabaseSQL(db *models.Database, connString string) error {
|
||||||
// Initialize execution report
|
// Initialize execution report
|
||||||
w.executionReport = &ExecutionReport{
|
w.executionReport = &ExecutionReport{
|
||||||
@@ -2002,13 +2057,145 @@ func (w *Writer) executeDatabaseSQL(db *models.Database, connString string) erro
|
|||||||
Errors: make([]ExecutionError, 0),
|
Errors: make([]ExecutionError, 0),
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generating a large schema can take time before any statement is executed.
|
var statements []string
|
||||||
fmt.Fprintln(os.Stderr, " → Generating PostgreSQL statements...")
|
if fullDDL, _ := w.options.Metadata["full_ddl"].(bool); !fullDDL {
|
||||||
statements, err := w.GenerateDatabaseStatements(db)
|
diffStatements, err := w.generateLiveDiffStatements(db, connString)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("failed to generate SQL statements: %w", err)
|
fmt.Fprintf(os.Stderr, "⚠ Warning: live diff unavailable (%v); falling back to full DDL\n", err)
|
||||||
|
} else {
|
||||||
|
statements = diffStatements
|
||||||
|
if len(statements) == 0 {
|
||||||
|
w.executionReport.EndTime = getCurrentTimestamp()
|
||||||
|
fmt.Fprintln(os.Stderr, "✓ Database is already up to date; nothing to execute")
|
||||||
|
return w.finishReport()
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if statements == nil {
|
||||||
|
// Generating a large schema can take time before any statement is executed.
|
||||||
|
fmt.Fprintln(os.Stderr, " → Generating PostgreSQL statements...")
|
||||||
|
var err error
|
||||||
|
statements, err = w.GenerateDatabaseStatements(db)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to generate SQL statements: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.executeStatements(statements, connString)
|
||||||
|
}
|
||||||
|
|
||||||
|
// generateLiveDiffStatements reads the live database and returns only the statements needed
|
||||||
|
// to bring it in line with db. An error means the diff could not be computed.
|
||||||
|
func (w *Writer) generateLiveDiffStatements(db *models.Database, connString string) ([]string, error) {
|
||||||
|
if w.options.FlattenSchema {
|
||||||
|
return nil, fmt.Errorf("flatten_schema output cannot be compared with the live schemas")
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintln(os.Stderr, " → Reading live database to compute differences...")
|
||||||
|
current, err := rpgsql.NewReader(&readers.ReaderOptions{ConnectionString: connString}).ReadDatabase()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to read live database: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return w.diffStatements(db, current)
|
||||||
|
}
|
||||||
|
|
||||||
|
// diffStatements returns the ordered statements that migrate current to model.
|
||||||
|
func (w *Writer) diffStatements(model, current *models.Database) ([]string, error) {
|
||||||
|
currentSchemas := make(map[string]*models.Schema)
|
||||||
|
for _, cs := range current.Schemas {
|
||||||
|
if cs != nil {
|
||||||
|
currentSchemas[strings.ToLower(cs.Name)] = cs
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
statements := []string{}
|
||||||
|
// Primary key sequences that must be moved past existing rows once the
|
||||||
|
// migration scripts (which set the column defaults) have run.
|
||||||
|
var setvalStatements []string
|
||||||
|
for _, schema := range model.Schemas {
|
||||||
|
if schema == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if err := w.checkDirectives(schema); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
cs := currentSchemas[strings.ToLower(schema.Name)]
|
||||||
|
if cs == nil && schema.Name != "public" {
|
||||||
|
statements = append(statements,
|
||||||
|
fmt.Sprintf("-- Schema: %s", schema.Name),
|
||||||
|
fmt.Sprintf("CREATE SCHEMA IF NOT EXISTS %s", schema.SQLName()))
|
||||||
|
}
|
||||||
|
|
||||||
|
existing := make(map[string]*models.Table)
|
||||||
|
knownSequences := make(map[string]bool)
|
||||||
|
if cs != nil {
|
||||||
|
for _, t := range cs.Tables {
|
||||||
|
existing[strings.ToLower(t.Name)] = t
|
||||||
|
}
|
||||||
|
for _, seq := range cs.Sequences {
|
||||||
|
knownSequences[strings.ToLower(seq.Name)] = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, table := range schema.Tables {
|
||||||
|
currentTable, ok := existing[strings.ToLower(table.Name)]
|
||||||
|
if !ok {
|
||||||
|
// New table: no rows yet, so the sequence only needs creating.
|
||||||
|
if stmt := w.primaryKeySequenceStatement(schema, table); stmt != "" {
|
||||||
|
statements = append(statements, stmt)
|
||||||
|
}
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
// Existing table whose primary key is being pointed at a sequence the
|
||||||
|
// database does not have yet: create it and move it past the data,
|
||||||
|
// otherwise it restarts at 1 and collides with existing rows.
|
||||||
|
seqName := primaryKeySequenceName(table)
|
||||||
|
if seqName == "" || knownSequences[strings.ToLower(seqName)] {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if cpk := currentTable.GetPrimaryKey(); cpk != nil && columnDefaultsEqual(table.GetPrimaryKey().Default, cpk.Default) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
statements = append(statements, w.primaryKeySequenceStatement(schema, table))
|
||||||
|
setval, err := w.primaryKeySetvalStatement(schema, table)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to generate set sequence value for %s.%s: %w", schema.Name, table.Name, err)
|
||||||
|
}
|
||||||
|
setvalStatements = append(setvalStatements, setval)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mw, err := NewMigrationWriter(w.options)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
scripts, err := mw.GenerateScripts(model, current)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to generate migration scripts: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
lastSchema := ""
|
||||||
|
for _, script := range scripts {
|
||||||
|
body := strings.TrimSpace(script.Body)
|
||||||
|
if body == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if script.Schema != "" && script.Schema != lastSchema {
|
||||||
|
statements = append(statements, fmt.Sprintf("-- Schema: %s", script.Schema))
|
||||||
|
lastSchema = script.Schema
|
||||||
|
}
|
||||||
|
statements = append(statements, body)
|
||||||
|
}
|
||||||
|
statements = append(statements, setvalStatements...)
|
||||||
|
|
||||||
|
return statements, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// executeStatements runs statements one by one against the database and writes the report.
|
||||||
|
func (w *Writer) executeStatements(statements []string, connString string) error {
|
||||||
w.executionReport.TotalStatements = len(statements)
|
w.executionReport.TotalStatements = len(statements)
|
||||||
|
|
||||||
// Connect to database
|
// Connect to database
|
||||||
@@ -2108,7 +2295,11 @@ func (w *Writer) executeDatabaseSQL(db *models.Database, connString string) erro
|
|||||||
}
|
}
|
||||||
|
|
||||||
w.executionReport.EndTime = getCurrentTimestamp()
|
w.executionReport.EndTime = getCurrentTimestamp()
|
||||||
|
return w.finishReport()
|
||||||
|
}
|
||||||
|
|
||||||
|
// finishReport writes the optional report file and prints the execution summary.
|
||||||
|
func (w *Writer) finishReport() error {
|
||||||
// Write report if path is specified
|
// Write report if path is specified
|
||||||
if reportPath, ok := w.options.Metadata["report_path"].(string); ok && reportPath != "" {
|
if reportPath, ok := w.options.Metadata["report_path"].(string); ok && reportPath != "" {
|
||||||
if err := w.writeReport(reportPath); err != nil {
|
if err := w.writeReport(reportPath); err != nil {
|
||||||
|
|||||||
@@ -229,6 +229,7 @@ func main() {
|
|||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
- Generated columns are written as `col TYPE GENERATED ALWAYS AS (expr) STORED` (no DEFAULT)
|
||||||
- Schema flattening is **always enabled** for SQLite output (cannot be disabled); the default schema (`public`/`main`) produces bare table names, other schemas are prefixed
|
- Schema flattening is **always enabled** for SQLite output (cannot be disabled); the default schema (`public`/`main`) produces bare table names, other schemas are prefixed
|
||||||
- Constraint and index names are prefixed with the flattened table name to avoid collisions
|
- Constraint and index names are prefixed with the flattened table name to avoid collisions
|
||||||
- Generated SQL is compatible with SQLite 3.x
|
- Generated SQL is compatible with SQLite 3.x
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
CREATE TABLE {{quote_ident (qualified_table_name .Schema .Name)}} (
|
CREATE TABLE {{quote_ident (qualified_table_name .Schema .Name)}} (
|
||||||
{{- $hasAutoIncrement := false}}
|
{{- $hasAutoIncrement := false}}
|
||||||
{{- range $i, $col := .Columns}}{{if $i}},{{end}}
|
{{- range $i, $col := .Columns}}{{if $i}},{{end}}
|
||||||
{{quote_ident $col.Name}} {{map_type $col.Type}}{{column_collate $col}}{{if is_autoincrement $col}}{{$hasAutoIncrement = true}} PRIMARY KEY AUTOINCREMENT{{else}}{{if $col.NotNull}} NOT NULL{{end}}{{if ne (format_default $col) ""}} DEFAULT {{format_default $col}}{{end}}{{end}}
|
{{quote_ident $col.Name}} {{map_type $col.Type}}{{column_collate $col}}{{if and $col.Generated $col.GenerationExpression}} GENERATED ALWAYS AS ({{$col.GenerationExpression}}) STORED{{if $col.NotNull}} NOT NULL{{end}}{{else if is_autoincrement $col}}{{$hasAutoIncrement = true}} PRIMARY KEY AUTOINCREMENT{{else}}{{if $col.NotNull}} NOT NULL{{end}}{{if ne (format_default $col) ""}} DEFAULT {{format_default $col}}{{end}}{{end}}
|
||||||
{{- end}}
|
{{- end}}
|
||||||
{{- if and .PrimaryKey (not $hasAutoIncrement)}}{{if gt (len .Columns) 0}},{{end}}
|
{{- if and .PrimaryKey (not $hasAutoIncrement)}}{{if gt (len .Columns) 0}},{{end}}
|
||||||
PRIMARY KEY ({{range $i, $colName := .PrimaryKey.Columns}}{{if $i}}, {{end}}{{quote_ident $colName}}{{end}})
|
PRIMARY KEY ({{range $i, $colName := .PrimaryKey.Columns}}{{if $i}}, {{end}}{{quote_ident $colName}}{{end}})
|
||||||
|
|||||||
@@ -421,3 +421,39 @@ func TestQuoteIdentifier(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestWriteDatabase_GeneratedColumn(t *testing.T) {
|
||||||
|
table := models.InitTable("people", "public")
|
||||||
|
first := models.InitColumn("first", "people", "public")
|
||||||
|
first.Type = "text"
|
||||||
|
first.Sequence = 1
|
||||||
|
table.Columns["first"] = first
|
||||||
|
full := models.InitColumn("full_name", "people", "public")
|
||||||
|
full.Type = "text"
|
||||||
|
full.Sequence = 2
|
||||||
|
full.NotNull = true
|
||||||
|
full.Generated = true
|
||||||
|
full.GenerationExpression = "first || ' ' || first"
|
||||||
|
full.Default = "ignored"
|
||||||
|
table.Columns["full_name"] = full
|
||||||
|
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
writer := NewWriter(&writers.WriterOptions{})
|
||||||
|
writer.writer = &buf
|
||||||
|
if err := writer.WriteDatabase(db); err != nil {
|
||||||
|
t.Fatalf("WriteDatabase failed: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := `"full_name" TEXT GENERATED ALWAYS AS (first || ' ' || first) STORED NOT NULL`
|
||||||
|
if !strings.Contains(buf.String(), want) {
|
||||||
|
t.Errorf("missing %q in:\n%s", want, buf.String())
|
||||||
|
}
|
||||||
|
if strings.Contains(buf.String(), "DEFAULT") && strings.Contains(buf.String(), "ignored") {
|
||||||
|
t.Errorf("generated column must not carry a DEFAULT:\n%s", buf.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -146,6 +146,12 @@ export class Post {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Generated and identity columns:
|
||||||
|
|
||||||
|
- `asExpression: '...'`, `generatedType: 'STORED'` - generated column (no default)
|
||||||
|
- `@PrimaryGeneratedColumn('identity', { generatedIdentity: 'ALWAYS' })` - identity primary key
|
||||||
|
- `@Generated('identity')` + `generatedIdentity: '...'` - identity column that is not the primary key
|
||||||
|
|
||||||
## Type Mapping
|
## Type Mapping
|
||||||
|
|
||||||
| SQL Type | TypeScript Type | TypeORM Type |
|
| SQL Type | TypeScript Type | TypeORM Type |
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package typeorm
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/models"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/readers"
|
||||||
|
typeormreader "git.warky.dev/wdevs/relspecgo/pkg/readers/typeorm"
|
||||||
|
"git.warky.dev/wdevs/relspecgo/pkg/writers"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestGeneratedAndIdentityColumnsRoundTrip(t *testing.T) {
|
||||||
|
table := models.InitTable("people", "public")
|
||||||
|
|
||||||
|
id := models.InitColumn("id", "people", "public")
|
||||||
|
id.Type = "bigint"
|
||||||
|
id.IsPrimaryKey = true
|
||||||
|
id.NotNull = true
|
||||||
|
id.AutoIncrement = true
|
||||||
|
id.Identity = true
|
||||||
|
id.IdentityGeneration = "ALWAYS"
|
||||||
|
table.Columns["id"] = id
|
||||||
|
|
||||||
|
seq := models.InitColumn("seq", "people", "public")
|
||||||
|
seq.Type = "integer"
|
||||||
|
seq.NotNull = true
|
||||||
|
seq.Identity = true
|
||||||
|
seq.IdentityGeneration = "BY DEFAULT"
|
||||||
|
table.Columns["seq"] = seq
|
||||||
|
|
||||||
|
first := models.InitColumn("first", "people", "public")
|
||||||
|
first.Type = "text"
|
||||||
|
first.NotNull = true
|
||||||
|
table.Columns["first"] = first
|
||||||
|
|
||||||
|
full := models.InitColumn("full_name", "people", "public")
|
||||||
|
full.Type = "text"
|
||||||
|
full.NotNull = true
|
||||||
|
full.Generated = true
|
||||||
|
full.GenerationExpression = "first || ' ' || upper(first)"
|
||||||
|
table.Columns["full_name"] = full
|
||||||
|
|
||||||
|
schema := models.InitSchema("public")
|
||||||
|
schema.Tables = append(schema.Tables, table)
|
||||||
|
db := models.InitDatabase("testdb")
|
||||||
|
db.Schemas = append(db.Schemas, schema)
|
||||||
|
|
||||||
|
out := filepath.Join(t.TempDir(), "entities.ts")
|
||||||
|
require.NoError(t, NewWriter(&writers.WriterOptions{OutputPath: out}).WriteDatabase(db))
|
||||||
|
|
||||||
|
content, err := os.ReadFile(out)
|
||||||
|
require.NoError(t, err)
|
||||||
|
assert.Contains(t, string(content), `asExpression: 'first || \' \' || upper(first)'`)
|
||||||
|
assert.Contains(t, string(content), "generatedType: 'STORED'")
|
||||||
|
assert.Contains(t, string(content), "@PrimaryGeneratedColumn('identity', { generatedIdentity: 'ALWAYS' })")
|
||||||
|
assert.Contains(t, string(content), "@Generated('identity')")
|
||||||
|
assert.Contains(t, string(content), "Generated } from 'typeorm'")
|
||||||
|
|
||||||
|
got, err := typeormreader.NewReader(&readers.ReaderOptions{FilePath: out}).ReadDatabase()
|
||||||
|
require.NoError(t, err)
|
||||||
|
cols := got.Schemas[0].Tables[0].Columns
|
||||||
|
|
||||||
|
assert.True(t, cols["id"].Identity)
|
||||||
|
assert.Equal(t, "ALWAYS", cols["id"].IdentityGeneration)
|
||||||
|
assert.True(t, cols["seq"].Identity)
|
||||||
|
assert.Equal(t, "BY DEFAULT", cols["seq"].IdentityGeneration)
|
||||||
|
assert.True(t, cols["full_name"].Generated)
|
||||||
|
assert.Equal(t, "first || ' ' || upper(first)", cols["full_name"].GenerationExpression)
|
||||||
|
assert.False(t, cols["first"].Generated)
|
||||||
|
assert.False(t, cols["first"].Identity)
|
||||||
|
}
|
||||||
@@ -97,6 +97,7 @@ func (w *Writer) generateImports(db *models.Database) string {
|
|||||||
needsCreateDate := false
|
needsCreateDate := false
|
||||||
needsUpdateDate := false
|
needsUpdateDate := false
|
||||||
needsViewEntity := false
|
needsViewEntity := false
|
||||||
|
needsGenerated := false
|
||||||
|
|
||||||
for _, schema := range db.Schemas {
|
for _, schema := range db.Schemas {
|
||||||
// Check for views
|
// Check for views
|
||||||
@@ -107,6 +108,9 @@ func (w *Writer) generateImports(db *models.Database) string {
|
|||||||
for _, table := range schema.Tables {
|
for _, table := range schema.Tables {
|
||||||
// Check for timestamp columns
|
// Check for timestamp columns
|
||||||
for _, col := range table.Columns {
|
for _, col := range table.Columns {
|
||||||
|
if isNonKeyIdentity(col) {
|
||||||
|
needsGenerated = true
|
||||||
|
}
|
||||||
if col.Default == "now()" {
|
if col.Default == "now()" {
|
||||||
needsCreateDate = true
|
needsCreateDate = true
|
||||||
}
|
}
|
||||||
@@ -161,6 +165,9 @@ func (w *Writer) generateImports(db *models.Database) string {
|
|||||||
if needsViewEntity {
|
if needsViewEntity {
|
||||||
imports = append(imports, "ViewEntity")
|
imports = append(imports, "ViewEntity")
|
||||||
}
|
}
|
||||||
|
if needsGenerated {
|
||||||
|
imports = append(imports, "Generated")
|
||||||
|
}
|
||||||
|
|
||||||
return fmt.Sprintf("import { %s } from 'typeorm';\n", strings.Join(imports, ", "))
|
return fmt.Sprintf("import { %s } from 'typeorm';\n", strings.Join(imports, ", "))
|
||||||
}
|
}
|
||||||
@@ -299,14 +306,16 @@ func (w *Writer) columnToField(col *models.Column, table *models.Table) string {
|
|||||||
|
|
||||||
// Generate decorator
|
// Generate decorator
|
||||||
if col.IsPrimaryKey {
|
if col.IsPrimaryKey {
|
||||||
if col.AutoIncrement {
|
if col.Identity && col.IdentityGeneration != "" {
|
||||||
|
fmt.Fprintf(&sb, " @PrimaryGeneratedColumn('identity', { generatedIdentity: '%s' })\n", strings.ToUpper(col.IdentityGeneration))
|
||||||
|
} else if col.AutoIncrement {
|
||||||
sb.WriteString(" @PrimaryGeneratedColumn('increment')\n")
|
sb.WriteString(" @PrimaryGeneratedColumn('increment')\n")
|
||||||
} else if col.Type == "uuid" || strings.Contains(fmt.Sprint(col.Default), "uuid") {
|
} else if col.Type == "uuid" || strings.Contains(fmt.Sprint(col.Default), "uuid") {
|
||||||
sb.WriteString(" @PrimaryGeneratedColumn('uuid')\n")
|
sb.WriteString(" @PrimaryGeneratedColumn('uuid')\n")
|
||||||
} else {
|
} else {
|
||||||
sb.WriteString(" @PrimaryGeneratedColumn()\n")
|
sb.WriteString(" @PrimaryGeneratedColumn()\n")
|
||||||
}
|
}
|
||||||
} else if col.Default == "now()" {
|
} else if col.Default == "now()" && !col.Generated {
|
||||||
sb.WriteString(" @CreateDateColumn()\n")
|
sb.WriteString(" @CreateDateColumn()\n")
|
||||||
} else if strings.Contains(col.Comment, "auto-update") {
|
} else if strings.Contains(col.Comment, "auto-update") {
|
||||||
sb.WriteString(" @UpdateDateColumn()\n")
|
sb.WriteString(" @UpdateDateColumn()\n")
|
||||||
@@ -318,6 +327,9 @@ func (w *Writer) columnToField(col *models.Column, table *models.Table) string {
|
|||||||
} else {
|
} else {
|
||||||
sb.WriteString(" @Column()\n")
|
sb.WriteString(" @Column()\n")
|
||||||
}
|
}
|
||||||
|
if isNonKeyIdentity(col) {
|
||||||
|
sb.WriteString(" @Generated('identity')\n")
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Generate field declaration
|
// Generate field declaration
|
||||||
@@ -351,8 +363,18 @@ func (w *Writer) buildColumnOptions(col *models.Column, table *models.Table) str
|
|||||||
options = append(options, "unique: true")
|
options = append(options, "unique: true")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Generated column (GENERATED ALWAYS AS (expr) STORED)
|
||||||
|
if col.Generated && col.GenerationExpression != "" {
|
||||||
|
options = append(options, fmt.Sprintf("asExpression: '%s'", escapeSingleQuoted(col.GenerationExpression)), "generatedType: 'STORED'")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Identity column that is not the primary key
|
||||||
|
if isNonKeyIdentity(col) {
|
||||||
|
options = append(options, fmt.Sprintf("generatedIdentity: '%s'", strings.ToUpper(col.IdentityGeneration)))
|
||||||
|
}
|
||||||
|
|
||||||
// Default
|
// Default
|
||||||
if col.Default != nil && col.Default != "now()" {
|
if !col.Generated && !col.Identity && col.Default != nil && col.Default != "now()" {
|
||||||
defaultStr := fmt.Sprint(col.Default)
|
defaultStr := fmt.Sprint(col.Default)
|
||||||
if defaultStr != "" {
|
if defaultStr != "" {
|
||||||
options = append(options, fmt.Sprintf("default: '%s'", defaultStr))
|
options = append(options, fmt.Sprintf("default: '%s'", defaultStr))
|
||||||
@@ -362,6 +384,16 @@ func (w *Writer) buildColumnOptions(col *models.Column, table *models.Table) str
|
|||||||
return strings.Join(options, ", ")
|
return strings.Join(options, ", ")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isNonKeyIdentity reports whether col is a GENERATED ... AS IDENTITY column outside the primary key.
|
||||||
|
func isNonKeyIdentity(col *models.Column) bool {
|
||||||
|
return col.Identity && col.IdentityGeneration != "" && !col.IsPrimaryKey
|
||||||
|
}
|
||||||
|
|
||||||
|
// escapeSingleQuoted escapes a value for use inside a single-quoted TypeScript string.
|
||||||
|
func escapeSingleQuoted(s string) string {
|
||||||
|
return strings.ReplaceAll(strings.ReplaceAll(s, `\`, `\\`), `'`, `\'`)
|
||||||
|
}
|
||||||
|
|
||||||
// needsExplicitType checks if a SQL type needs explicit type declaration
|
// needsExplicitType checks if a SQL type needs explicit type declaration
|
||||||
func (w *Writer) needsExplicitType(sqlType string) bool {
|
func (w *Writer) needsExplicitType(sqlType string) bool {
|
||||||
// Types that don't map cleanly to TypeScript types need explicit declaration
|
// Types that don't map cleanly to TypeScript types need explicit declaration
|
||||||
|
|||||||
Reference in New Issue
Block a user