Skip to content

Commit 162f0b2

Browse files
committed
Add "pg-microsharding copy" action
1 parent 83c1e38 commit 162f0b2

File tree

16 files changed

+433
-282
lines changed

16 files changed

+433
-282
lines changed

docs/functions/actionCopy.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[**@clickup/pg-microsharding**](../README.md)
2+
3+
***
4+
5+
[@clickup/pg-microsharding](../globals.md) / actionCopy
6+
7+
# Function: actionCopy()
8+
9+
> **actionCopy**(`args`): `Promise`\<`boolean`\>
10+
11+
Defined in: src/actions/actionCopy.ts:19
12+
13+
Copies a PG from one database to another with no downtime.
14+
15+
## Parameters
16+
17+
| Parameter | Type |
18+
| ------ | ------ |
19+
| `args` | `Args` |
20+
21+
## Returns
22+
23+
`Promise`\<`boolean`\>

docs/functions/actionMove.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **actionMove**(`args`): `Promise`\<`boolean`\>
1010
11-
Defined in: [src/actions/actionMove.ts:21](https://github.com/clickup/pg-microsharding/blob/master/src/actions/actionMove.ts#L21)
11+
Defined in: [src/actions/actionMove.ts:22](https://github.com/clickup/pg-microsharding/blob/master/src/actions/actionMove.ts#L22)
1212

1313
Moves a shard from one database to another with no downtime.
1414

docs/functions/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **cli**(): `void`
1010
11-
Defined in: [src/cli.ts:230](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L230)
11+
Defined in: [src/cli.ts:240](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L240)
1212

1313
A wrapper around main() to call it from a bin script.
1414

docs/functions/main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **main**(`argsIn`): `Promise`\<`boolean`\>
1010
11-
Defined in: [src/cli.ts:158](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L158)
11+
Defined in: [src/cli.ts:168](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L168)
1212

1313
Tool main function.
1414

docs/functions/move.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@
1010
1111
Defined in: [src/api/move.ts:32](https://github.com/clickup/pg-microsharding/blob/master/src/api/move.ts#L32)
1212

13-
Moves a shard from one master DB to another.
13+
Moves or copies a schema from one master DB to another.
1414

1515
## Parameters
1616

1717
| Parameter | Type |
1818
| ------ | ------ |
19-
| `__namedParameters` | \{ `shard`: `number`; `fromDsn`: `string`; `toDsn`: `string`; `activateOnDestination`: `boolean`; `deactivateSQL`: `string`; `maxReplicationLagSec`: `number`; `wait`: `boolean`; \} |
20-
| `__namedParameters.shard` | `number` |
19+
| `__namedParameters` | \{ `schema`: `string`; `fromDsn`: `string`; `toDsn`: `string`; `commitAction`: `null` \| `"deactivate-activate"` \| `"rename-to-new"`; `deactivateSQL`: `string`; `maxReplicationLagSec`: `number`; `wait`: `boolean`; \} |
20+
| `__namedParameters.schema` | `string` |
2121
| `__namedParameters.fromDsn` | `string` |
2222
| `__namedParameters.toDsn` | `string` |
23-
| `__namedParameters.activateOnDestination` | `boolean` |
23+
| `__namedParameters.commitAction` | `null` \| `"deactivate-activate"` \| `"rename-to-new"` |
2424
| `__namedParameters.deactivateSQL`? | `string` |
2525
| `__namedParameters.maxReplicationLagSec`? | `number` |
2626
| `__namedParameters.wait`? | `boolean` |

docs/globals.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212

1313
- [actionAllocate](functions/actionAllocate.md)
1414
- [actionCleanup](functions/actionCleanup.md)
15+
- [actionCopy](functions/actionCopy.md)
1516
- [actionFactor](functions/actionFactor.md)
1617
- [actionInstall](functions/actionInstall.md)
1718
- [actionList](functions/actionList.md)

0 commit comments

Comments
 (0)