@clickup/pg-microsharding/docs/functions/install.md

Microshards support for PostgreSQL

[**@clickup/pg-microsharding**](../README.md)

***

[@clickup/pg-microsharding](../globals.md) / install

# Function: install()

> **install**(`__namedParameters`): `Promise`\<`void`\>

Defined in: [src/api/install.ts:10](https://github.com/clickup/pg-microsharding/blob/master/src/api/install.ts#L10)

Installs/updates microsharding schema and functions.

## Parameters

| Parameter | Type |
| ------ | ------ |
| `__namedParameters` | \{ `dsn`: `string`; `schemaNameFmt`: `string`; \} |
| `__namedParameters.dsn` | `string` |
| `__namedParameters.schemaNameFmt`? | `string` |

## Returns

`Promise`\<`void`\>