@clickup/pg-mig
Version:
PostgreSQL schema migration tool with microsharding and clustering support
25 lines (14 loc) • 541 B
Markdown
[**/pg-mig**](../README.md)
***
[/pg-mig](../globals.md) / migrate
# Function: migrate()
> **migrate**(`options`): `Promise`\<`boolean`\>
Defined in: [src/cli.ts:160](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L160)
Similar to main(), but accepts options explicitly, not from process.argv.
This function is meant to be called from other tools.
## Parameters
| Parameter | Type |
| ------ | ------ |
| `options` | [`MigrateOptions`](../interfaces/MigrateOptions.md) |
## Returns
`Promise`\<`boolean`\>