Skip to content

Commit

Permalink
Change docs for creating / upgrading audit tables
Browse files Browse the repository at this point in the history
  • Loading branch information
n3o77 committed Oct 18, 2019
1 parent 9ede526 commit beeaa7c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"symfony/security-bundle": "^3.4 || ^4.0",
"pagerfanta/pagerfanta": "^2.1",
"white-october/pagerfanta-bundle": "^1.2",
"doctrine/annotations": "^1.8"
"doctrine/annotations": "^1.8",
"symfony/lock": "^3.4 || ^4.0"
},
"autoload": {
"psr-4": {
Expand All @@ -39,7 +40,6 @@
"phpstan/phpstan-doctrine": "^0.11.1",
"phpstan/phpstan-symfony": "^0.11.1",
"twig/extensions": "^1.5",
"symfony/lock": "^3.4 || ^4.0",
"friendsofphp/php-cs-fixer": "^2.15"
},
"conflict": {
Expand Down
4 changes: 2 additions & 2 deletions doc/00-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* Configuration
* [General Configuration](20-general-configuration.md)
* [Audit Configuration](21-audit-configuration.md)
* [Create audit tables](22-audit-schema.md)
* [Create or Update audit tables](22-audit-schema.md)
* [Using a custom user provider](23-custom-user-provider.md)
* [Enabling and disabling audits](24-enabling-disabling-audits.md)
* Audit viewer
Expand All @@ -19,4 +19,4 @@
* Help
* [Troubleshooting](60-troubleshooting.md)
* [Changelog](../CHANGELOG.md)
* [Contributing](../tests/README.md)
* [Contributing](../tests/README.md)
5 changes: 3 additions & 2 deletions doc/22-audit-schema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Creating audit tables
# Create or Update audit tables

The process of audit table creation differs depending on your current setup:
The process of audit table creation / updating differs depending on your current setup:
- **single** database setup: audit tables are stored in the **same** database than audited ones (most common use case)
- **dual** database setup: audit tables are stored in a **secondary** database

Expand Down Expand Up @@ -45,6 +45,7 @@ bin/console doctrine:schema:update --force


## Dual database setup

Doctrine `Schema-Tool` and `DoctrineMigrationsBundle` are not able to work with more than one
database at once. To workaround that limitation, this bundle offers a migration command that
focuses on audit schema manipulation.
Expand Down
2 changes: 0 additions & 2 deletions doc/50-audits-cleanup.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Audits cleanup

**Notice**: symfony/lock is required, to install it use `composer require symfony/lock`

DoctrineAuditBundle provides a convenient command that helps you cleaning audit tables.
Open a command console, enter your project directory and execute:

Expand Down

0 comments on commit beeaa7c

Please sign in to comment.