Skip to content

Home > extract-pg-schema > extractSchemas

extractSchemas() function

Perform the extraction

Signature:

typescript
declare function extractSchemas(connectionConfig: string | ConnectionConfig, options?: ExtractSchemaOptions): Promise<Record<string, Schema>>;

Parameters

Parameter

Type

Description

connectionConfig

string | ConnectionConfig

Connection string or configuration object for Postgres connection

options

ExtractSchemaOptions

(Optional) Optional options

**Returns:**

Promise<Record<string, Schema>>

A record of all the schemas extracted, indexed by schema name.