stancl/tenancy-docs
1
0
Fork 0
mirror of https://github.com/stancl/tenancy-docs.git synced 2025-12-12 18:24:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update console commands docs page

Browse source
This commit is contained in:
lukinovec 2022-09-01 14:48:49 +02:00
parent af05970907
commit a0525a8239
1 changed files with 15 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

24
source/docs/v3/console-commands.blade.md
View file

@ -9,28 +9,32 @@ section: content
The package comes with some useful artisan commands.
## **Migrate** {#migrate}
All tenant-aware commands accept two options:
- `--tenants` – IDs of the tenants for which the command should run, and if not specified, run the command for all tenants.
> Note: To include multiple tenants using CLI, you can use multiple `--tenants=<...>` options. If you're calling the command using `Artisan::call()`, `--tenants` has to be an array.
- `--with-pending` – Specify if the command should also run for the pending tenants // todo@pendingTenantsDocumentation
## **Migrate** (tenant-aware) {#migrate}
The most important command. To use tenants, you have to be able to migrate their databases.
You can use the `tenants:migrate` command to migrate tenant's databases. You can also specify which tenants' databases should be migrated using the `--tenants` option.
```
php artisan tenants:migrate --tenants=8075a580-1cb8-11e9-8822-49c5d8f8ff23
```
You may use multiple `--tenants=<...>` options.
> Note: By default, the migrations should be in database/migrations/tenant. If you wish to use a different path, you may use the `--path` option. You can also specify the default parameters for the command [in the tenancy config]({{ $page->link('configuration#migration-parameters') }})
> Note: By default, the migrations should be in database/migrations/tenant. If you wish to use a different path, you may use the `--path` argument.
## **Rollback & seed** {#rollback-and-seed}
## **Rollback & seed** (tenant-aware) {#rollback-and-seed}
- Rollback: `tenants:rollback`
- Seed: `tenants:seed`
Similarly to `migrate`, these commands accept a `--tenants` option.
> Note: You can configure the default parameters for `tenants:seed` in [the tenancy config]({{ $page->link('configuration#seeder-parameters') }})
## **Migrate fresh** {#migrate-fresh}
## **Migrate fresh** (tenant-aware) {#migrate-fresh}
This package also offers a simplified, tenant-aware version of `migrate:fresh`. It runs `db:wipe` and `tenants:migrate` on the tenant's database.
@ -40,7 +44,7 @@ You may use it like this:
php artisan tenants:migrate-fresh --tenants=8075a580-1cb8-11e9-8822-49c5d8f8ff23
```
## **Run** {#run}
## **Run** (tenant-aware) {#run}
You can use the `tenants:run` command to run your own commands for tenants.