@dataplan/pg
Version:
PostgreSQL step classes for Grafast
99 lines • 10.7 kB
TypeScript
import type { GrafastSubscriber } from "grafast";
import { domainOfCodec, enumCodec, getCodecByPgCatalogTypeName, getInnerCodec, isEnumCodec, listOfCodec, ObjectFromPgCodecAttributes, PgCodecAttribute, PgCodecAttributeExtensions, PgCodecAttributes, PgCodecAttributeVia, PgCodecAttributeViaExplicit, PgEnumCodecSpec, PgRecordTypeCodecSpec, rangeOfCodec, recordCodec, sqlValueWithCodec, TYPES } from "./codecs.js";
import { PgBox, PgCircle, PgHStore, PgInterval, PgLine, PgLseg, PgPath, PgPoint, PgPolygon } from "./codecUtils/index.js";
import { makePgResourceOptions, makeRegistry, makeRegistryBuilder, PgCodecRef, PgCodecRefExtensions, PgCodecRefPath, PgCodecRefPathEntry, PgCodecRefs, PgFunctionResourceOptions, PgRegistryBuilder, PgResource, PgResourceExtensions, PgResourceOptions, PgResourceParameter, PgResourceUnique, PgResourceUniqueExtensions } from "./datasource.js";
import { PgClient, PgClientQuery, PgClientResult, PgExecutor, PgExecutorContext, PgExecutorContextPlans, PgExecutorInput, PgExecutorMutationOptions, PgExecutorOptions, WithPgClient } from "./executor.js";
import { PgBooleanFilter } from "./filters/pgBooleanFilter.js";
import { PgClassFilter } from "./filters/pgClassFilter.js";
import { PgManyFilter } from "./filters/pgManyFilter.js";
import { PgOrFilter } from "./filters/pgOrFilter.js";
import type { GetPgCodecAttributes, GetPgRegistryCodecRelations, GetPgRegistryCodecs, GetPgRegistrySources, GetPgResourceAttributes, GetPgResourceCodec, GetPgResourceRegistry, GetPgResourceRelations, GetPgResourceUniques, KeysOfType, MakePgServiceOptions, PgClassSingleStep, PgCodec, PgCodecAnyScalar, PgCodecExtensions, PgCodecList, PgCodecPolymorphism, PgCodecPolymorphismRelational, PgCodecPolymorphismRelationalTypeSpec, PgCodecPolymorphismSingle, PgCodecPolymorphismSingleTypeAttributeSpec, PgCodecPolymorphismSingleTypeSpec, PgCodecPolymorphismUnion, PgCodecRelation, PgCodecRelationConfig, PgCodecRelationExtensions, PgCodecWithAttributes, PgConditionLike, PgDecode, PgEncode, PgEnumCodec, PgEnumValue, PgGroupSpec, PgOrderSpec, PgRefDefinition, PgRefDefinitionExtensions, PgRefDefinitions, PgRegistry, PgSelectQueryBuilderCallback, PgTypedStep, PgUnionAllQueryBuilderCallback, PlanByUniques, TuplePlanMap } from "./interfaces.js";
import { PgLockableParameter, PgLockCallback } from "./pgLocker.js";
import type { PgAdaptor } from "./pgServices.js";
import { getWithPgClientFromPgService, withPgClientFromPgService, withSuperuserPgClientFromPgService } from "./pgServices.js";
import { PgContextPlugin } from "./plugins/PgContextPlugin.js";
import { pgClassExpression, PgClassExpressionStep } from "./steps/pgClassExpression.js";
import { PgCondition, PgConditionCapableParent, PgHavingConditionSpec, PgWhereConditionSpec, pgWhereConditionSpecListToSQL } from "./steps/pgCondition.js";
import { PgCursorStep } from "./steps/pgCursor.js";
import { pgDeleteSingle, PgDeleteSingleQueryBuilder, PgDeleteSingleStep } from "./steps/pgDeleteSingle.js";
import { pgInsertSingle, PgInsertSingleQueryBuilder, PgInsertSingleStep } from "./steps/pgInsertSingle.js";
import { pgPageInfo, PgPageInfoStep } from "./steps/pgPageInfo.js";
import { generatePgParameterAnalysis, pgFromExpression, pgFromExpressionRuntime, PgGroupDetails, pgSelect, PgSelectArgumentDigest, PgSelectArgumentRuntimeValue, PgSelectArgumentSpec, pgSelectFromRecords, PgSelectIdentifierSpec, PgSelectMode, PgSelectOptions, PgSelectParsedCursorStep, PgSelectQueryBuilder, PgSelectRowsStep, PgSelectStep, sqlFromArgDigests } from "./steps/pgSelect.js";
import { pgSelectFromRecord, pgSelectSingleFromRecord, PgSelectSinglePlanOptions, PgSelectSingleStep } from "./steps/pgSelectSingle.js";
import { PgTempTable } from "./steps/pgTempTable.js";
import { pgUnionAll, PgUnionAllQueryBuilder, PgUnionAllRowsStep, PgUnionAllSingleStep, PgUnionAllStep, PgUnionAllStepCondition, PgUnionAllStepConfig, PgUnionAllStepConfigAttributes, PgUnionAllStepMember, PgUnionAllStepOrder } from "./steps/pgUnionAll.js";
import { pgUpdateSingle, PgUpdateSingleQueryBuilder, PgUpdateSingleStep } from "./steps/pgUpdateSingle.js";
import { pgValidateParsedCursor, PgValidateParsedCursorStep } from "./steps/pgValidateParsedCursor.js";
import { toPg, ToPgStep } from "./steps/toPg.js";
import { withPgClient, WithPgClientStep, WithPgClientStepCallback, withPgClientTransaction } from "./steps/withPgClient.js";
import { assertPgClassSingleStep } from "./utils.js";
export { assertPgClassSingleStep, domainOfCodec, enumCodec, generatePgParameterAnalysis, getCodecByPgCatalogTypeName, getInnerCodec, GetPgCodecAttributes, GetPgRegistryCodecRelations, GetPgRegistryCodecs, GetPgRegistrySources, GetPgResourceAttributes, GetPgResourceCodec, GetPgResourceRegistry, GetPgResourceRelations, GetPgResourceUniques, getWithPgClientFromPgService, isEnumCodec, KeysOfType, listOfCodec, makePgResourceOptions, MakePgServiceOptions, makeRegistry, makeRegistryBuilder, ObjectFromPgCodecAttributes, PgAdaptor, PgBooleanFilter, PgBox, PgCircle, pgClassExpression, PgClassExpressionStep, PgClassFilter, PgClassSingleStep, PgClient, PgClientQuery, PgClientResult, PgCodec, PgCodecAnyScalar, PgCodecAttribute, PgCodecAttributeExtensions, PgCodecAttributes, PgCodecAttributeVia, PgCodecAttributeViaExplicit, PgCodecExtensions, PgCodecList, PgCodecPolymorphism, PgCodecPolymorphismRelational, PgCodecPolymorphismRelationalTypeSpec, PgCodecPolymorphismSingle, PgCodecPolymorphismSingleTypeAttributeSpec, PgCodecPolymorphismSingleTypeSpec, PgCodecPolymorphismUnion, PgCodecRef, PgCodecRefExtensions, PgCodecRefPath, PgCodecRefPathEntry, PgCodecRefs, PgCodecRelation, PgCodecRelationConfig, PgCodecRelationExtensions, PgCodecWithAttributes, PgCondition, PgConditionCapableParent, PgConditionLike, PgContextPlugin, PgCursorStep, PgDecode, pgDeleteSingle, PgDeleteSingleQueryBuilder, PgDeleteSingleStep, PgEncode, PgEnumCodec, PgEnumCodecSpec, PgEnumValue, PgExecutor, PgExecutorContext, PgExecutorContextPlans, PgExecutorInput, PgExecutorMutationOptions, PgExecutorOptions, pgFromExpression, pgFromExpressionRuntime, PgFunctionResourceOptions, PgGroupDetails, PgGroupSpec, PgHavingConditionSpec, PgHStore, pgInsertSingle, PgInsertSingleQueryBuilder, PgInsertSingleStep, PgInterval, PgLine, PgLockableParameter, PgLockCallback, PgLseg, PgManyFilter, PgOrderSpec, PgOrFilter, pgPageInfo, PgPageInfoStep, PgPath, PgPoint, PgPolygon, PgRecordTypeCodecSpec, PgRefDefinition, PgRefDefinitionExtensions, PgRefDefinitions, PgRegistry, PgRegistryBuilder, PgResource, PgResourceExtensions, PgResourceOptions, PgResourceParameter, PgResourceUnique, PgResourceUniqueExtensions, pgSelect, PgSelectArgumentDigest, PgSelectArgumentRuntimeValue, PgSelectArgumentSpec, pgSelectFromRecord, pgSelectFromRecords, PgSelectIdentifierSpec, PgSelectMode, PgSelectOptions, PgSelectParsedCursorStep, PgSelectQueryBuilder, PgSelectQueryBuilderCallback, PgSelectRowsStep, pgSelectSingleFromRecord, PgSelectSinglePlanOptions, PgSelectSingleStep, PgSelectStep, PgTempTable, PgTypedStep, pgUnionAll, PgUnionAllQueryBuilder, PgUnionAllQueryBuilderCallback, PgUnionAllRowsStep, PgUnionAllSingleStep, PgUnionAllStep, PgUnionAllStepCondition, PgUnionAllStepConfig, PgUnionAllStepConfigAttributes, PgUnionAllStepMember, PgUnionAllStepOrder, pgUpdateSingle, PgUpdateSingleQueryBuilder, PgUpdateSingleStep, pgValidateParsedCursor, PgValidateParsedCursorStep, PgWhereConditionSpec, pgWhereConditionSpecListToSQL, PlanByUniques, rangeOfCodec, recordCodec, sqlFromArgDigests, sqlValueWithCodec, toPg, ToPgStep, TuplePlanMap, TYPES, WithPgClient, withPgClient, withPgClientFromPgService, WithPgClientStep, WithPgClientStepCallback, withPgClientTransaction, withSuperuserPgClientFromPgService, };
export { version } from "./version.js";
declare global {
namespace GraphileConfig {
interface PgServiceConfiguration<TAdaptor extends keyof GraphileConfig.PgAdaptors = keyof GraphileConfig.PgAdaptors> {
name: string;
schemas?: string[];
adaptor: PgAdaptor<TAdaptor>;
adaptorSettings?: GraphileConfig.PgAdaptors[TAdaptor]["adaptorSettings"];
/** The key on 'context' where the withPgClient function will be sourced */
withPgClientKey: KeysOfType<Grafast.Context & object, WithPgClient<GraphileConfig.PgAdaptors[TAdaptor]["client"]>>;
/** Return settings to set in the session */
pgSettings?: ((requestContext: Grafast.RequestContext) => Record<string, string | undefined>) | Record<string, string | undefined> | null;
/** Settings to set in the session that performs introspection (during gather phase) */
pgSettingsForIntrospection?: Record<string, string | undefined> | null;
/** The key on 'context' where the pgSettings for this DB will be sourced */
pgSettingsKey?: KeysOfType<Grafast.Context & object, Record<string, string | undefined> | null | undefined>;
/** The GrafastSubscriber to use for subscriptions */
pgSubscriber?: GrafastSubscriber<Record<string, string>> | null;
/** Where on the context should the PgSubscriber be stored? */
pgSubscriberKey?: KeysOfType<Grafast.Context & object, GrafastSubscriber<any> | null | undefined>;
/**
* Call this when you no longer need this service configuration any more;
* releases any created resources (e.g. connection pools).
*/
release?: () => void | PromiseLike<void>;
}
interface Preset {
pgServices?: ReadonlyArray<{
[Key in keyof GraphileConfig.PgAdaptors]: PgServiceConfiguration<Key>;
}[keyof GraphileConfig.PgAdaptors]>;
}
interface PgAdaptors {
}
}
namespace DataplanPg {
interface PgConditionExtensions {
}
/**
* Custom metadata for a codec
*/
interface PgCodecExtensions {
oid?: string;
listItemNonNull?: boolean;
isEnumTableEnum?: boolean;
}
/**
* Extra metadata you can attach to a unique constraint.
*/
interface PgResourceUniqueExtensions {
}
/**
* Space for extra metadata about this resource
*/
interface PgResourceExtensions {
}
interface PgResourceParameterExtensions {
variant?: string;
}
interface PgCodecRefExtensions {
}
interface PgCodecAttributeExtensions {
}
interface PgRefDefinitionExtensions {
}
interface PgCodecRelationExtensions {
}
}
}
//# sourceMappingURL=index.d.ts.map