Skip to content

Home > extract-pg-schema

extract-pg-schema package

Functions

Function

Description

extractSchema(schemaName, connectionConfig, resolveViews, tables)

extractSchemas(connectionConfig, options)

Perform the extraction

Interfaces

Interface

Description

CompositeTypeAttribute

Attribute of a composite type.

CompositeTypeDetails

Composite type in a schema.

DomainDetails

Domain type in a schema.

EnumDetails

Enum type in a schema.

ExtractSchemaOptions

This is the options object that can be passed to extractSchemas.

ForeignTableColumn

Column in a foreign table.

ForeignTableDetails

Foreign table in a schema.

InformationSchemaColumn

The view columns contains information about all table columns (or view columns) in the database. System columns (ctid, etc.) are not included. Only those columns are shown that the current user has access to (by way of being the owner or having some privilege).

InformationSchemaDomain

The view domains contains all domains defined in the current database. Only those domains are shown that the current user has access to (by way of being the owner or having some privilege).

InformationSchemaTable

The view tables contains all tables and views defined in the current database. Only those tables and views are shown that the current user has access to (by way of being the owner or having some privilege).

InformationSchemaView

The view tables contains all tables and views defined in the current database. Only those tables and views are shown that the current user has access to (by way of being the owner or having some privilege).

MaterializedViewColumn

Column in a materialized view.

MaterializedViewDetails

Materialized view in a schema.

RangeDetails

Range type in a schema.

TableCheck

Check constraint on a table.

TableColumn

Column in a table.

TableDetails

Table in a schema.

TableIndex

Index on a table.

TableIndexColumn

Column in an index.

TableSecurityPolicy

Security policy on a table.

ViewColumn

Column in a view.

ViewDetails

View in a schema.

Variables

Variable

Description

updateActionMap

Type Aliases

Type Alias

Description

AttributeType

Attribute type in a composite type.

ColumnReference

Column reference.

ForeignTableColumnType

Column type in a foreign table.

Index

Index for a column.

Kind

MaterializedViewColumnType

Column type in a materialized view.

PgType

Base type for Postgres objects.

Schema

extractSchemas generates a record of all the schemas extracted, indexed by schema name. The schemas are instances of this type.

TableColumnType

Column type in a table.

UpdateAction

ViewColumnType

Column type in a view.

YesNo