@adpt/cloud/dist/src/postgres/PostgresProvider.d.ts

AdaptJS cloud component library

/**
 * Props for the {@link postgres.PostgresProvider} component
 *
 * @public
 */
export interface PostgresProviderProps {
    /** Hostname for the Postgres database as it would appear in the PGHOST environment variable */
    host?: string;
    /** Postgres database name as it would appear in the PGDATABASE environment variable */
    database?: string;
    /** Postgres username as it would appear in the PGUSER environment variable */
    user?: string;
    /** Postgres password as it would appear in the PGPASSWORD environment variable */
    password?: string;
}
/**
 * Component that represents an external provider of a Postgres database
 *
 * @remarks
 *
 * See {@link postgres.PostgresProviderProps}.
 *
 * Use this component to connect other cloud components to a external
 * Postgres services, such as Google CloudSQL or Amazon RDS.
 *
 * @example
 *
 * ```
 * const pg = handle();
 *
 * <PostgresProvider handle={pg}
 *   hostname="mypostgres.com:5432"
 *   db="db"
 *   user="myuser"
 *   password={process.env.PGPASSWORD}
 * />
 *
 * <NodeService src="/somedir" connectTo={pg} />
 * ```
 *
 * @public
 */
export declare function PostgresProvider(props: PostgresProviderProps): null;
export default PostgresProvider;
//# sourceMappingURL=PostgresProvider.d.ts.map