The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: PostGraphileHandler

types/src.YamlConfig.PostGraphileHandler

Handler for Postgres database, based on postgraphile

Table of contents#

Properties#

Properties#

appendPlugins#

Optional appendPlugins: string[]

Extra Postgraphile Plugins to append

Defined in#

packages/types/src/config.ts:760


connectionString#

Optional connectionString: string

A connection string to your Postgres database

Defined in#

packages/types/src/config.ts:748


live#

Optional live: boolean

Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)

Defined in#

packages/types/src/config.ts:780


options#

Optional options: string | { [k: string]: any; }

Extra Postgraphile options that will be added to the postgraphile constructor. It can either be an object or a string pointing to the object's path (e.g. "./my-config#options"). See the postgraphile docs for more information. (Any of: JSON, String)

Defined in#

packages/types/src/config.ts:768


pool#

Optional pool: any

Connection Pool instance or settings or you can provide the path of a code file that exports any of those

Defined in#

packages/types/src/config.ts:756


schemaName#

Optional schemaName: string[]

An array of strings which specifies the PostgreSQL schemas that PostGraphile will use to create a GraphQL schema. The default schema is the public schema.

Defined in#

packages/types/src/config.ts:752


skipPlugins#

Optional skipPlugins: string[]

Postgraphile Plugins to skip (e.g. "graphile-build#NodePlugin")

Defined in#

packages/types/src/config.ts:764


subscriptions#

Optional subscriptions: boolean

Enable GraphQL websocket transport support for subscriptions (default: true)

Defined in#

packages/types/src/config.ts:776