v2.16.1: Add install action

Author: dimikot

docs/functions/actionInstall.md

@@ -0,0 +1,23 @@
+[**@clickup/pg-microsharding**](../README.md)
+
+***
+
+[@clickup/pg-microsharding](../globals.md) / actionInstall
+
+# Function: actionInstall()
+
+> **actionInstall**(`args`): `Promise`\<`boolean`\>
+
+Defined in: src/actions/actionInstall.ts:8
+
+Installs the library in the provided databases.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `args` | `Args` |
+
+## Returns
+
+`Promise`\<`boolean`\>

docs/functions/cli.md

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

docs/functions/install.md

@@ -0,0 +1,24 @@
+[**@clickup/pg-microsharding**](../README.md)
+
+***
+
+[@clickup/pg-microsharding](../globals.md) / install
+
+# Function: install()
+
+> **install**(`__namedParameters`): `Promise`\<`void`\>
+
+Defined in: src/api/install.ts:10
+
+Installs/updates microsharding schema and functions.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `__namedParameters` | \{ `dsn`: `string`; \} |
+| `__namedParameters.dsn` | `string` |
+
+## Returns
+
+`Promise`\<`void`\>

docs/functions/main.md

@@ -8,7 +8,7 @@
 
 > **main**(`argsIn`): `Promise`\<`boolean`\>
 
-Defined in: [src/cli.ts:140](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L140)
+Defined in: [src/cli.ts:145](https://github.com/clickup/pg-microsharding/blob/master/src/cli.ts#L145)
 
 Tool main function.
 

docs/globals.md

@@ -13,13 +13,15 @@
 - [actionAllocate](functions/actionAllocate.md)
 - [actionCleanup](functions/actionCleanup.md)
 - [actionFactor](functions/actionFactor.md)
+- [actionInstall](functions/actionInstall.md)
 - [actionList](functions/actionList.md)
 - [calcIslandWeights](functions/calcIslandWeights.md)
 - [actionMove](functions/actionMove.md)
 - [actionRebalance](functions/actionRebalance.md)
 - [allocate](functions/allocate.md)
 - [cleanup](functions/cleanup.md)
 - [factor](functions/factor.md)
+- [install](functions/install.md)
 - [move](functions/move.md)
 - [rebalance](functions/rebalance.md)
 - [weights](functions/weights.md)

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@clickup/pg-microsharding",
   "description": "Microshards support for PostgreSQL",
-  "version": "2.15.1",
+  "version": "2.16.1",
   "license": "MIT",
   "keywords": [
     "postgresql",

package.json

@@ -0,0 +1,19 @@
+import { install } from "../api/install";
+import { normalizeDsns } from "../internal/normalizeDsns";
+import type { Args } from "../internal/parseArgs";
+
+/**
+ * Installs the library in the provided databases.
+ */
+export async function actionInstall(args: Args): Promise<boolean> {
+  const dsns = await normalizeDsns(args["dsns"] || args["dsn"]);
+  if (dsns.length === 0) {
+    throw "Please provide --dsn or --dsns, DB DSNs to install the library to";
+  }
+
+  for (const dsn of dsns) {
+    await install({ dsn });
+  }
+
+  return true;
+}

src/actions/actionInstall.ts

@@ -0,0 +1,30 @@
+import { realpathSync } from "fs";
+import { relative } from "path";
+import { libSchema } from "../internal/names";
+import { join, sql } from "../internal/quote";
+import { runSqlProgress } from "../internal/runSqlProgress";
+
+/**
+ * Installs/updates microsharding schema and functions.
+ */
+export async function install({ dsn }: { dsn: string }): Promise<void> {
+  const scriptPath = relative(
+    ".",
+    realpathSync(`${__dirname}/../../sql/pg-microsharding-up.sql`),
+  );
+  await runSqlProgress(
+    dsn,
+    join(
+      [
+        sql`
+          CREATE SCHEMA IF NOT EXISTS ${libSchema()};
+          SET search_path TO ${libSchema()};
+        `,
+        `\\i ${scriptPath}`,
+      ],
+      "\n",
+    ),
+    `Updating the library at ${dsn}`,
+    "single-transaction",
+  );
+}

src/api/install.ts

@@ -5,6 +5,7 @@ import pickBy from "lodash/pickBy";
 import { actionAllocate } from "./actions/actionAllocate";
 import { actionCleanup } from "./actions/actionCleanup";
 import { actionFactor } from "./actions/actionFactor";
+import { actionInstall } from "./actions/actionInstall";
 import { actionList } from "./actions/actionList";
 import { actionMove } from "./actions/actionMove";
 import { actionRebalance } from "./actions/actionRebalance";
@@ -26,6 +27,9 @@ export { allocate, cleanup, factor, move, rebalance, weights, shellQuote };
 const HELP = unindent(`
   USAGE
 
+    pg-microsharding install
+      [--dsn=DSN | --dsns=DNS1,DSN2,...]
+
     pg-microsharding list | ls
       [--weight-sql='SELECT returning weight with optional unit']
       [--verbose]
@@ -127,11 +131,12 @@ const HELP = unindent(`
 const ACTIONS = {
   allocate: actionAllocate,
   cleanup: actionCleanup,
+  factor: actionFactor,
+  install: actionInstall,
   list: actionList,
   ls: actionList,
   move: actionMove,
   rebalance: actionRebalance,
-  factor: actionFactor,
 };
 
 /**