Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# atlas-provider-doctrine

Load [Doctrine](https://www.doctrine-project.org/) entities into an [Atlas](https://atlasgo.io) project.
Use [Atlas](https://atlasgo.io/) with [Doctrine](https://www.doctrine-project.org/) to manage your database schema as code. By connecting your Doctrine models to Atlas,
you can define and edit your schema directly in PHP. Atlas will then automatically plan and apply database schema migrations for you,
eliminating the need to write migrations manually.

Atlas brings automated CI/CD workflows to your database, along with built-in support for [testing](https://atlasgo.io/testing/schema), [linting](https://atlasgo.io/versioned/lint),
schema [drift detection](https://atlasgo.io/monitoring/drift-detection), and [schema monitoring](https://atlasgo.io/monitoring). It also allows you to extend Doctrine with
advanced database objects such as triggers, row-level security, and custom functions that are not supported natively.

### Use-cases
1. **Declarative migrations** - use a Terraform-like `atlas schema apply --env doctrine` to apply your Doctrine schema to the database.
2. **Automatic migration planning** - use `atlas migrate diff --env doctrine` to automatically plan a migration from the current database version to the Doctrine schema.
1. [**Declarative migrations**](https://atlasgo.io/declarative/apply) - Use the Terraform-like `atlas schema apply --env doctrine` command to apply your Doctrine schema to the database.
2. [**Automatic migration planning**](https://atlasgo.io/versioned/diff) - Use `atlas migrate diff --env doctrine` to automatically plan database schema changes and generate
a migration from the current database version to the desired version defined by your Doctrine schema.

### Requirements
* [DBAL](https://www.doctrine-project.org/projects/doctrine-dbal/en/4.0/index.html) - `composer require doctrine/dbal:^4`
Expand Down Expand Up @@ -196,4 +203,4 @@ Please report any issues or feature requests in the [ariga/atlas](https://github

### License

This project is licensed under the [Apache License 2.0](LICENSE).
This project is licensed under the [Apache License 2.0](LICENSE).
6 changes: 6 additions & 0 deletions tests/atlas.hcl
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,10 @@ env "doctrine" {
diff = "{{ sql . \" \" }}"
}
}
diff {
skip {
# See this FAQ: https://atlasgo.io/faq/skip-constraint-rename
rename_constraint = true
}
}
}