Documentation
API Reference
Interfaces
PrismaLoaderOptions

graphql-tools-monorepo / loaders/prisma/src / PrismaLoaderOptions

Interface: PrismaLoaderOptions

loaders/prisma/src.PrismaLoaderOptions

additional options for loading from a prisma.yml file

Hierarchy

Table of contents

Properties

Properties

File

Optional File: Object

WHATWG compatible File implementation

See

https://developer.mozilla.org/en-US/docs/Web/API/File

Call signature

new File(fileBits, fileName, options?): File

Parameters
NameType
fileBitsBlobPart[]
fileNamestring
options?FilePropertyBag
Returns

File

Type declaration

NameType
prototypeFile

Inherited from

LoadFromUrlOptions.File

Defined in

packages/executors/http/src/index.ts:77


FormData

Optional FormData: Object

WHATWG compatible FormData implementation

See

https://developer.mozilla.org/en-US/docs/Web/API/FormData

Call signature

new FormData(form?, submitter?): FormData

Parameters
NameType
form?HTMLFormElement
submitter?null | HTMLElement
Returns

FormData

Type declaration

NameType
prototypeFormData

Inherited from

LoadFromUrlOptions.FormData

Defined in

packages/executors/http/src/index.ts:82


allowLegacySDLEmptyFields

Optional allowLegacySDLEmptyFields: boolean

Inherited from

LoadFromUrlOptions.allowLegacySDLEmptyFields

Defined in

packages/utils/src/Interfaces.ts:95


allowLegacySDLImplementsInterfaces

Optional allowLegacySDLImplementsInterfaces: boolean

Inherited from

LoadFromUrlOptions.allowLegacySDLImplementsInterfaces

Defined in

packages/utils/src/Interfaces.ts:96


assumeValid

Optional assumeValid: boolean

When building a schema from a GraphQL service’s introspection result, it might be safe to assume the schema is valid. Set to true to assume the produced schema is valid.

Default: false

Inherited from

LoadFromUrlOptions.assumeValid

Defined in

node_modules/graphql/type/schema.d.ts:146


assumeValidSDL

Optional assumeValidSDL: boolean

Set to true to assume the SDL is valid.

Default: false

Inherited from

LoadFromUrlOptions.assumeValidSDL

Defined in

node_modules/graphql/utilities/buildASTSchema.d.ts:12


batch

Optional batch: boolean

Enable Batching

Inherited from

LoadFromUrlOptions.batch

Defined in

packages/loaders/url/src/index.ts:100


commentDescriptions

Optional commentDescriptions: boolean

Set to true in order to convert all GraphQL comments (marked with # sign) to descriptions (""") GraphQL has built-in support for transforming descriptions to comments (with print), but not while parsing. Turning the flag on will support the other way as well (parse)

Inherited from

LoadFromUrlOptions.commentDescriptions

Defined in

packages/utils/src/Interfaces.ts:103


connectionParams

Optional connectionParams: Record<string, unknown> | () => Record<string, unknown>

Connection Parameters for WebSockets connection

Inherited from

LoadFromUrlOptions.connectionParams

Defined in

packages/loaders/url/src/index.ts:96


credentials

Optional credentials: RequestCredentials

Request Credentials (default: ‘same-origin’)

See

https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials

Inherited from

LoadFromUrlOptions.credentials

Defined in

packages/executors/http/src/index.ts:68


customFetch

Optional customFetch: string | FetchFn

A custom fetch implementation to use when querying the original schema. Defaults to cross-fetch

Inherited from

LoadFromUrlOptions.customFetch

Defined in

packages/loaders/url/src/index.ts:71


cwd

Optional cwd: string

Overrides

LoadFromUrlOptions.cwd

Defined in

packages/loaders/prisma/src/index.ts:16


descriptions

Optional descriptions: boolean

Whether to include descriptions in the introspection result. Default: true

Inherited from

LoadFromUrlOptions.descriptions

Defined in

node_modules/graphql/utilities/getIntrospectionQuery.d.ts:8


directiveIsRepeatable

Optional directiveIsRepeatable: boolean

Whether to include isRepeatable flag on directives. Default: false

Inherited from

LoadFromUrlOptions.directiveIsRepeatable

Defined in

node_modules/graphql/utilities/getIntrospectionQuery.d.ts:18


endpoint

Optional endpoint: string

Regular HTTP endpoint; defaults to the pointer

Inherited from

LoadFromUrlOptions.endpoint

Defined in

packages/loaders/url/src/index.ts:84


envVars

Optional envVars: Object

Index signature

▪ [key: string]: string

Defined in

packages/loaders/prisma/src/index.ts:14


experimentalFragmentVariables

Optional experimentalFragmentVariables: boolean

Inherited from

LoadFromUrlOptions.experimentalFragmentVariables

Defined in

packages/utils/src/Interfaces.ts:97


fetch

Optional fetch: FetchFn

Inherited from

LoadFromUrlOptions.fetch

Defined in

packages/executors/http/src/index.ts:47


graceful

Optional graceful: boolean

Defined in

packages/loaders/prisma/src/index.ts:15


handleAsSDL

Optional handleAsSDL: boolean

Handle URL as schema SDL

Inherited from

LoadFromUrlOptions.handleAsSDL

Defined in

packages/loaders/url/src/index.ts:80


headers

Optional headers: HeadersConfig | (executorRequest?: ExecutionRequest<any, any, any, Record<string, any>, any>) => HeadersConfig

Additional headers to include when querying the original schema

Inherited from

LoadFromUrlOptions.headers

Defined in

packages/executors/http/src/index.ts:55


ignore

Optional ignore: string | string[]

Inherited from

LoadFromUrlOptions.ignore

Defined in

packages/utils/src/loaders.ts:14


includeSources

Optional includeSources: boolean

Inherited from

LoadFromUrlOptions.includeSources

Defined in

packages/utils/src/loaders.ts:15


inputValueDeprecation

Optional inputValueDeprecation: boolean

Whether target GraphQL server support deprecation of input values. Default: false

Inherited from

LoadFromUrlOptions.inputValueDeprecation

Defined in

node_modules/graphql/utilities/getIntrospectionQuery.d.ts:28


method

Optional method: "GET" | "POST"

HTTP method to use when querying the original schema.

Inherited from

LoadFromUrlOptions.method

Defined in

packages/executors/http/src/index.ts:59


noLocation

Optional noLocation: boolean

Inherited from

LoadFromUrlOptions.noLocation

Defined in

packages/utils/src/Interfaces.ts:94


print

Optional print: (doc: DocumentNode) => string

Print function for DocumentNode

Type declaration

▸ (doc): string

Parameters
NameType
docDocumentNode
Returns

string

Inherited from

LoadFromUrlOptions.print

Defined in

packages/executors/http/src/index.ts:86


retry

Optional retry: number

Retry attempts

Inherited from

LoadFromUrlOptions.retry

Defined in

packages/executors/http/src/index.ts:72


schemaDescription

Optional schemaDescription: boolean

Whether to include description field on schema. Default: false

Inherited from

LoadFromUrlOptions.schemaDescription

Defined in

node_modules/graphql/utilities/getIntrospectionQuery.d.ts:23


specifiedByUrl

Optional specifiedByUrl: boolean

Whether to include specifiedByURL in the introspection result. Default: false

Inherited from

LoadFromUrlOptions.specifiedByUrl

Defined in

node_modules/graphql/utilities/getIntrospectionQuery.d.ts:13


subscriptionsEndpoint

Optional subscriptionsEndpoint: string

Subscriptions endpoint; defaults to the endpoint given as HTTP endpoint

Inherited from

LoadFromUrlOptions.subscriptionsEndpoint

Defined in

packages/loaders/url/src/index.ts:88


subscriptionsProtocol

Optional subscriptionsProtocol: SubscriptionProtocol

Use specific protocol for subscriptions

Inherited from

LoadFromUrlOptions.subscriptionsProtocol

Defined in

packages/loaders/url/src/index.ts:92


timeout

Optional timeout: number

Timeout in milliseconds

Inherited from

LoadFromUrlOptions.timeout

Defined in

packages/executors/http/src/index.ts:63


useGETForQueries

Optional useGETForQueries: boolean

Whether to use the GET HTTP method for queries when querying the original schema

Inherited from

LoadFromUrlOptions.useGETForQueries

Defined in

packages/executors/http/src/index.ts:51


webSocketImpl

Optional webSocketImpl: string | typeof WebSocket

Custom WebSocket implementation used by the loaded schema if subscriptions are enabled

Inherited from

LoadFromUrlOptions.webSocketImpl

Defined in

packages/loaders/url/src/index.ts:76