postgraphile/build/postgraphile/withPostGraphileContext.d.ts

A GraphQL schema created by reflection over a PostgreSQL schema 🐘 (previously known as PostGraphQL)

import { PoolClient } from 'pg';
import { ExecutionResult } from 'graphql';
import { $$pgClient } from '../postgres/inventory/pgClientFromContext';
import { mixed, WithPostGraphileContextOptions } from '../interfaces';
interface PostGraphileContext {
    [$$pgClient]: PoolClient;
    [key: string]: PoolClient | mixed;
}
export declare type WithPostGraphileContextFn<TResult = ExecutionResult> = (options: WithPostGraphileContextOptions, callback: (context: PostGraphileContext) => Promise<TResult>) => Promise<TResult>;
/**
 * Creates a PostGraphile context object which should be passed into a GraphQL
 * execution. This function will also connect a client from a Postgres pool and
 * setup a transaction in that client.
 *
 * This function is intended to wrap a call to GraphQL-js execution like so:
 *
 * ```js
 * const result = await withPostGraphileContext({
 *   pgPool,
 *   jwtToken,
 *   jwtSecret,
 *   pgDefaultRole,
 * }, async context => {
 *   return await graphql(
 *     schema,
 *     query,
 *     null,
 *     { ...context },
 *     variables,
 *     operationName,
 *   );
 * });
 * ```
 */
declare const withPostGraphileContext: WithPostGraphileContextFn;
export default withPostGraphileContext;
interface RawExplainResult {
    query: string;
    result: any;
}
declare type ExplainResult = Omit<RawExplainResult, 'result'> & {
    plan: string;
};
declare module 'pg' {
    interface ClientBase {
        _explainResults: Array<RawExplainResult> | null;
        startExplain: () => void;
        stopExplain: () => Promise<Array<ExplainResult>>;
    }
}
/**
 * Monkey-patches the `query` method of a pg Client to add debugging
 * functionality. Use with care.
 */
export declare function debugPgClient(pgClient: PoolClient, allowExplain?: boolean): PoolClient;