v2.15.1: Add support for solo CREATE INDEX CONCURRENTLY in a migration version file

Author: dimikot

docs/functions/actionDigest.md

@@ -0,0 +1,28 @@
+[**@clickup/pg-mig**](../README.md)
+
+***
+
+[@clickup/pg-mig](../globals.md) / actionDigest
+
+# Function: actionDigest()
+
+> **actionDigest**(`_options`, `registry`): `Promise`\<`boolean`\>
+
+Defined in: src/actions/actionDigest.ts:12
+
+Prints the "code digest", of all migration version names on disk. Digest is a
+string, and those strings can be compared lexicographically to determine
+whether the code version is compatible with the DB version: if the DB's
+digest is greater or equal to the code's digest, then they are compatible, so
+the code can be deployed.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_options` | [`MigrateOptions`](../interfaces/MigrateOptions.md) |
+| `registry` | `Registry` |
+
+## Returns
+
+`Promise`\<`boolean`\>

docs/functions/actionList.md

@@ -0,0 +1,24 @@
+[**@clickup/pg-mig**](../README.md)
+
+***
+
+[@clickup/pg-mig](../globals.md) / actionList
+
+# Function: actionList()
+
+> **actionList**(`_options`, `registry`): `Promise`\<`boolean`\>
+
+Defined in: src/actions/actionList.ts:9
+
+Prints the list of all migration versions in the registry.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_options` | [`MigrateOptions`](../interfaces/MigrateOptions.md) |
+| `registry` | `Registry` |
+
+## Returns
+
+`Promise`\<`boolean`\>

docs/functions/actionMake.md

@@ -0,0 +1,25 @@
+[**@clickup/pg-mig**](../README.md)
+
+***
+
+[@clickup/pg-mig](../globals.md) / actionMake
+
+# Function: actionMake()
+
+> **actionMake**(`options`, `registry`, `name`): `Promise`\<`boolean`\>
+
+Defined in: src/actions/actionMake.ts:13
+
+Makes new migration files.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options` | [`MigrateOptions`](../interfaces/MigrateOptions.md) |
+| `registry` | `Registry` |
+| `name` | `string` |
+
+## Returns
+
+`Promise`\<`boolean`\>

docs/functions/actionUndoOrApply.md

@@ -0,0 +1,25 @@
+[**@clickup/pg-mig**](../README.md)
+
+***
+
+[@clickup/pg-mig](../globals.md) / actionUndoOrApply
+
+# Function: actionUndoOrApply()
+
+> **actionUndoOrApply**(`options`, `hostDests`, `registry`): `Promise`\<\{ `success`: `boolean`; `hasMoreWork`: `boolean`; \}\>
+
+Defined in: src/actions/actionUndoOrApply.ts:27
+
+Applies or undoes migrations.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options` | [`MigrateOptions`](../interfaces/MigrateOptions.md) |
+| `hostDests` | `Dest`[] |
+| `registry` | `Registry` |
+
+## Returns
+
+`Promise`\<\{ `success`: `boolean`; `hasMoreWork`: `boolean`; \}\>

docs/functions/cli.md

@@ -8,7 +8,7 @@
 
 > **cli**(): `void`
 
-Defined in: [src/cli.ts:485](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L485)
+Defined in: [src/cli.ts:239](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L239)
 
 A wrapper around main() to call it from a bin script.
 

docs/functions/loadDBDigest.md

@@ -8,7 +8,7 @@
 
 > **loadDBDigest**\<`TDest`\>(`dests`, `sqlRunner`): `Promise`\<`string`\>
 
-Defined in: [src/cli.ts:239](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L239)
+Defined in: [src/cli.ts:225](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L225)
 
 Loads the digest strings from the provided databases and chooses the one
 which reflects the database schema status the best.

docs/functions/main.md

@@ -8,7 +8,7 @@
 
 > **main**(`argsIn`): `Promise`\<`boolean`\>
 
-Defined in: [src/cli.ts:87](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L87)
+Defined in: [src/cli.ts:73](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L73)
 
 CLI tool entry point. This function is run when `pg-mig` is called from the
 command line. Accepts parameters from process.argv. See `migrate()` for

docs/functions/migrate.md

@@ -8,7 +8,7 @@
 
 > **migrate**(`options`): `Promise`\<`boolean`\>
 
-Defined in: [src/cli.ts:169](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L169)
+Defined in: [src/cli.ts:155](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L155)
 
 Similar to main(), but accepts options explicitly, not from process.argv.
 This function is meant to be called from other tools.

docs/globals.md

@@ -10,6 +10,10 @@
 
 ## Functions
 
+- [actionDigest](functions/actionDigest.md)
+- [actionList](functions/actionList.md)
+- [actionMake](functions/actionMake.md)
+- [actionUndoOrApply](functions/actionUndoOrApply.md)
 - [main](functions/main.md)
 - [migrate](functions/migrate.md)
 - [loadDBDigest](functions/loadDBDigest.md)

docs/interfaces/MigrateOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: MigrateOptions
 
-Defined in: [src/cli.ts:33](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L33)
+Defined in: [src/cli.ts:19](https://github.com/clickup/pg-mig/blob/master/src/cli.ts#L19)
 
 Options for the migrate() function.