# KpgOptions

`interface` in `plugins` · v0.6.1

<https://docs.seedcord.org/packages/plugins/0.6.1/interfaces/kpg-options>

Configuration options for Postgres connection and service discovery.

```ts
interface KpgOptions
```

## Properties

### connectionString

```ts
readonly connectionString: string
```

Optional connection string used when a pool config is provided

### dir

```ts
readonly dir: string
```

Directory containing service classes. Make sure file(s)/folder(s) are built to `.js` in dist and aren't merged into a single file.

### forceInsecureSSL

```ts
readonly forceInsecureSSL: boolean
```

Force using insecure SSL

### kysely

```ts
readonly kysely: Except<KyselyConfig, 'dialect'>
```

Kysely config (excludes dialect because it's Postgres for this plugin)

### migrations

```ts
readonly migrations: KpgMigrationsOptions
```

Migration settings

### onConnectSQL

```ts
readonly onConnectSQL: string[]
```

Optional SQL statements executed for each new connection

### pool

```ts
readonly pool: Pool | PoolConfig
```

Optional existing Pool instance or configuration overrides

### timeout

```ts
timeout: number;
```

Plugin timeout in milliseconds