@venizia/ignis-connectors/postgres/supabase
Generated from the built declarations by
vulcan x atlas api gen- do not edit.
14 exports, 14 with TSDoc.
anonRole
const
anonRole: import("../pg-core/roles.js").PgRoleauthenticatedRole
const
authenticatedRole: import("../pg-core/roles.js").PgRoleauthUid
const
authUid: import("../sql/sql.js").SQL<unknown>authUsers
const
authUsers: import("../pg-core/index.js").PgTableWithColumns<{ name: "users"; schema: "auth"; columns: { id: import("../pg-core/index.js").PgColumn<{ name: "id"; tableName: "users"; dataType: "string"; columnType: "PgUUID"; data: string; driverParam: string; notNull: true; hasDefault: false; isPrimarIPostgresJsOptions
interface
postgres-js client options derived from a pooler mode; prepare is the server-side prepared-statements switch.
export interface IPostgresJsOptions {
prepare: boolean;
max?: number;
}Source: packages/connectors/src/relational/postgres/supabase/pooler.ts
PoolerModes
class
How the app reaches Supabase. Direct and session pooler are 5432; transaction pooler is 6543.
export declare class PoolerModes extends ConstClass {
static readonly DIRECT = "direct";
static readonly SESSION = "session";
static readonly TRANSACTION = "transaction";
}Source: packages/connectors/src/relational/postgres/supabase/pooler.ts
postgresRole
const
postgresRole: import("../pg-core/roles.js").PgRolerealtimeMessages
const
realtimeMessages: import("../pg-core/index.js").PgTableWithColumns<{ name: "messages"; schema: "realtime"; columns: { id: import("../pg-core/index.js").PgColumn<{ name: "id"; tableName: "messages"; dataType: "bigint"; columnType: "PgBigSerial64"; data: bigint; driverParam: string; notNull: true; hasrealtimeTopic
const
realtimeTopic: import("../sql/sql.js").SQL<unknown>serviceRole
const
serviceRole: import("../pg-core/roles.js").PgRolesupabaseAuthAdminRole
const
supabaseAuthAdminRole: import("../pg-core/roles.js").PgRoleSupabasePooler
class
Derives postgres-js options for connecting to Supabase through its direct, session or transaction pooler.
export declare class SupabasePooler {
/** Supavisor's TRANSACTION mode rebinds the backend connection per transaction, so server-side prepared statements do not survive - `prepare: false` is required there, not a tuning knob. `max` is forwarded only when supplied; postgres-js has its own default. */
static buildPostgresJsOptions(opts: {
mode: TPoolerMode;
max?: number;
}): IPostgresJsOptions;
}Source: packages/connectors/src/relational/postgres/supabase/pooler.ts
SupabaseRls
class
Row-level-security helpers for Supabase transactions.
export declare class SupabaseRls {
/** Sets the Supabase auth context for THIS transaction so `auth.uid()` resolves in RLS policies. `SET LOCAL` only - plain `SET` would leak the identity to the connection's next borrower under a pooler. `role` defaults to the JWT's own `role` claim, the only default that cannot contradict `request.jwt.claims`. */
static withAuthContext(opts: {
transaction: IDatabaseTransaction;
claims: Record<string, unknown>;
role?: string;
}): Promise<void>;
}Source: packages/connectors/src/relational/postgres/supabase/rls.ts
TPoolerMode
type
One of the {@link PoolerModes} values.
export type TPoolerMode = TConstValue<typeof PoolerModes>;Source: packages/connectors/src/relational/postgres/supabase/pooler.ts