@venizia/ignis-connectors
Generated from the built declarations by
vulcan x atlas api gen- do not edit.
3 exports, 3 with TSDoc. 134 more are re-exported from other entries (listed at the end).
AbstractDriverDataSource
class
A datasource that holds one client and a connector built over it through a driver: the lifecycle every connector family that talks to an external engine shares - wiring the driver named by @datasource({ driver }), closing once, soft-evicting the client after a secret rotation, draining a client by whichever verb its engine spells it with. No SQL members: the relational family adds its dialect, executor and transactions in AbstractRelationalDataSource, a raw-SQL engine adds nothing (BaseRawSqlDataSource). Transactions stay NotSupported, as in AbstractDataSource.
mapSecretToSettings is a driver-config convention, not Postgres SQL, so it belongs on this neutral base - do not move it down into a family.
export declare abstract class AbstractDriverDataSource<Settings extends object = {}, Schema extends TAnyDataSourceSchema = TAnyDataSourceSchema, ConfigurableOptions extends object = {}, Client = unknown, TConnector = unknown, TDriver extends IConnectorDriver<TConnector, unknown> = IConnectorDriver<TConnector, Client>> extends AbstractDataSource<Settings, Schema, ConfigurableOptions> {
connector?: TConnector;
protected client?: Client;
protected driver?: TDriver;
private closePromise?;
/**
* Lazy and idempotent: builds the driver named by `@datasource({ driver })` over the client
* `configure()` assigned, then the connector from it. Returns the connector.
*/
protected wireDriverFromMetadata(): TConnector;
/**
* Rejects a driver-name string from untyped JS
* callers: a string carries no module into the bundle.
*/
protected resolveDriverClass(): TClass<TDriver>;
protected resolveDriver(): TDriver;
/**
* Assigns `this.driver` AND builds `this.connector` in one step - a
* driver without its connector is silently bypassed on pooled queries. Returns the connector.
*/
protected useDriver(opts: {
driver: TDriver;
schema?: Schema;
}): TConnector;
/** A datasource that opens on first use has no client, driver or connector until the first call that needs it has awaited `ensureOpen()`. */
private assertOpenForSyncUse;
/** The handles `configure()` is given: the connector and the client through the ungated internals, so its own database work (migrations, seeding) needs no gate. */
protected createOpening(): IDataSourceOpening<TConnector, Client>;
/** Wires the driver on first use, so a `configure()` that only builds `this.client` is enough. */
getConnector(): TConnector;
/**
* Raw driver client (`pg.Pool` / `Sql`). Throws rather
* than handing back an `undefined` typed as `Client`.
*/
getClient(): Client;
private readClient;
/**
* Ends the connection `configure()` opened. Runs once: every later call returns the first call's
* promise. Goes through the driver, wired now if nothing queried yet, because its `end()` is the
* engine's whole teardown - PGlite also clears the exit status it plants on the host process.
*/
close(): Promise<void>;
/** Ends a client that a failed open left half-built and forgets the driver and connector, so the next open starts from nothing. */
protected discardPartialOpen(): Promise<void>;
private endConnection;
/**
* Soft-evicts the pool after a secret rotation: rebuilds against the rotated credentials without
* touching live fields, swaps atomically, then drains the old pool. On failure live state is
* restored, any half-built pool drained, and the error rethrown.
*/
onSecretRotated(opts: {
key: string;
secret: Record<string, string>;
}): Promise<void>;
/** Puts `settings` back to the snapshot: a key the failed rotation added (the rotated `password`) is removed, not left behind. */
private restoreSettings;
/**
* Shuts a client down by whichever verb its engine spells it with -
* `pg.Pool` and postgres.js have `end()`, PGlite and libsql only `close()`.
* Probed rather than type-tested: this tier must not name an engine, and a
* client left undrained keeps a WASM instance or file handle alive forever.
*/
protected drainClient(opts: {
client: unknown;
}): Promise<boolean>;
/** Vault's database engine returns `{ username, password }`; pg expects `{ user, password }`. */
protected mapSecretToSettings(opts: {
secret: Record<string, string>;
}): Record<string, unknown>;
}Source: packages/connectors/src/common/driver-data-source.ts
IConnectorDriver
interface
What every connector driver supplies, whatever the engine: a connector built over its client, the raw client, and its teardown. A relational driver adds connection acquisition for transactions (IRelationalDriver); a raw-SQL driver adds nothing. configure() stays app-written: the framework never builds the driver for you.
export interface IConnectorDriver<TConnector, Client = unknown> {
createConnector(opts: {
schema: TAnyDataSourceSchema;
}): TConnector;
getClient(): Client;
end(): Promise<void>;
}Source: packages/connectors/src/common/driver.ts
ScopeFilterUtility
class
Boot-time checks for models that declare settings.access (scope filtering).
export declare class ScopeFilterUtility {
/**
* Why a `through` chain cannot work, or undefined. Walks from `name` toward the model that holds a resolver: every
* hop needs a `one` relation with a single-column key, the parent needs an `access`, and the chain is at most
* `ScopeThroughLink.MAX_DEPTH` hops with no model twice. A key with no index is a warning: it still works, slowly.
*/
private static throughProblem;
/**
* Refuses to boot when `settings.access` is declared where it cannot be honoured. Both cases
* are silent at runtime and fail in OPPOSITE directions: a search-backed model returns more rows,
* a context-less one returns none. The caller supplies `asyncContextEnabled` so no application
* config type reaches into this tier.
*/
static assertScopeFilterSupported(opts: {
asyncContextEnabled: boolean;
logger?: ILogger;
}): void;
}Source: packages/connectors/src/common/scope-filter.ts
Re-exported
AbstractRelationalDataSourcefrom@venizia/ignis-connectors/relationalAbstractSearchDataSourcefrom@venizia/ignis-connectors/typesenseAuditUserResolverfrom@venizia/ignis-connectors/relationalBaseRelationalDataSourcefrom@venizia/ignis-connectors/relationalBaseRelationalEntityfrom@venizia/ignis-connectors/relationalBaseSearchConnectorfrom@venizia/ignis-connectors/typesenseBaseSearchDataSourcefrom@venizia/ignis-connectors/typesenseBaseSearchEntityfrom@venizia/ignis-connectors/typesenseDefaultRelationalRepositoryfrom@venizia/ignis-connectors/relationalDefaultSearchRepositoryfrom@venizia/ignis-connectors/typesensefieldfrom@venizia/ignis-connectors/typesenseFilterBuilderfrom@venizia/ignis-connectors/relationalIAliasInfofrom@venizia/ignis-connectors/typesenseICountOptionsfrom@venizia/ignis-connectors/relationalIDefinedEntityfrom@venizia/ignis-connectors/relationalIEntityfrom@venizia/ignis-connectors/relationalIImportResultfrom@venizia/ignis-connectors/typesenseIInsertConflictOptionsfrom@venizia/ignis-connectors/relationalIInsertOptionsfrom@venizia/ignis-connectors/relationalIManyRelationfrom@venizia/ignis-connectors/relationalIMigrationfrom@venizia/ignis-connectors/relationalIOneRelationfrom@venizia/ignis-connectors/relationalIRecursiveTreeOptionsfrom@venizia/ignis-connectors/relationalIRelationalConnectionfrom@venizia/ignis-connectors/relationalIRelationalDataSourcefrom@venizia/ignis-connectors/relationalIRelationalDataSourceOpeningfrom@venizia/ignis-connectors/relationalIRelationalDriverfrom@venizia/ignis-connectors/relationalIRelationalExtraOptionsfrom@venizia/ignis-connectors/relationalIRelationalQueryDialectfrom@venizia/ignis-connectors/relationalIRelationalQueryExecutorfrom@venizia/ignis-connectors/relationalIRelationalQueryOptionsfrom@venizia/ignis-connectors/relationalIRelationalTransactionfrom@venizia/ignis-connectors/relationalIRemoveOptionsfrom@venizia/ignis-connectors/relationalISearchAliasScopedfrom@venizia/ignis-connectors/typesenseISearchCollectionDefinitionfrom@venizia/ignis-connectors/typesenseISearchCollectionScopedfrom@venizia/ignis-connectors/typesenseISearchCompileCapabilitiesfrom@venizia/ignis-connectors/typesenseISearchConnectorfrom@venizia/ignis-connectors/typesenseISearchConnectorCallbacksfrom@venizia/ignis-connectors/typesenseISearchDataSourceOptionsfrom@venizia/ignis-connectors/typesenseISearchDocumentScopedfrom@venizia/ignis-connectors/typesenseISearchEmbedConfigfrom@venizia/ignis-connectors/typesenseISearchEmbedModelConfigfrom@venizia/ignis-connectors/typesenseISearchFacetCountfrom@venizia/ignis-connectors/typesenseISearchFacetStatsfrom@venizia/ignis-connectors/typesenseISearchFacetValuefrom@venizia/ignis-connectors/typesenseISearchFieldDefinitionfrom@venizia/ignis-connectors/typesenseISearchQueryfrom@venizia/ignis-connectors/typesenseISearchQueryDialectfrom@venizia/ignis-connectors/typesenseISearchResultfrom@venizia/ignis-connectors/typesenseISearchSwapScopedfrom@venizia/ignis-connectors/typesenseISearchSynonymScopedfrom@venizia/ignis-connectors/typesenseISearchSynonymSetScopedfrom@venizia/ignis-connectors/typesenseISelectOptionsfrom@venizia/ignis-connectors/relationalisRelationalTransactionfrom@venizia/ignis-connectors/relationalIStatementResultfrom@venizia/ignis-connectors/relationalISynonymfrom@venizia/ignis-connectors/typesenseITransformedUpdateDatafrom@venizia/ignis-connectors/relationalIUniqueKeyfrom@venizia/ignis-connectors/relationalIUpdateOptionsfrom@venizia/ignis-connectors/relationalIWriteResultfrom@venizia/ignis-connectors/relationalJSON_PATH_PATTERNfrom@venizia/ignis-connectors/relationalJsonPathUtilityfrom@venizia/ignis-connectors/relationalmanyfrom@venizia/ignis-connectors/relationalModelFactoryfrom@venizia/ignis-connectors/relationalMultiSearchEntrySchemafrom@venizia/ignis-connectors/typesenseMultiSearchInputSchemafrom@venizia/ignis-connectors/typesenseonefrom@venizia/ignis-connectors/relationalPersistableRelationalRepositoryfrom@venizia/ignis-connectors/relationalPersistableSearchRepositoryfrom@venizia/ignis-connectors/typesenseReadableRelationalRepositoryfrom@venizia/ignis-connectors/relationalReadableSearchRepositoryfrom@venizia/ignis-connectors/typesenseRecursiveTreeDirectionsfrom@venizia/ignis-connectors/relationalRecursiveTreeSqlfrom@venizia/ignis-connectors/relationalRelationalBaseRepositoryfrom@venizia/ignis-connectors/relationalRelationalDialectsfrom@venizia/ignis-connectors/relationalRelationalEntityUtilityfrom@venizia/ignis-connectors/relationalRelationalMigrationRunnerfrom@venizia/ignis-connectors/relationalRelationalUpdateBuilderfrom@venizia/ignis-connectors/relationalRelationDeclarationsfrom@venizia/ignis-connectors/relationalRelationsFactoryfrom@venizia/ignis-connectors/relationalScopeFilterDenialfrom@venizia/ignis-connectors/relationalScopeResolutionfrom@venizia/ignis-connectors/relationalSearchBaseRepositoryfrom@venizia/ignis-connectors/typesenseSearchCollectionFactoryfrom@venizia/ignis-connectors/typesenseSearchErrorsfrom@venizia/ignis-connectors/typesenseSearchFieldTypesfrom@venizia/ignis-connectors/typesenseSearchFilterOutcomesfrom@venizia/ignis-connectors/typesenseSearchInputSchemafrom@venizia/ignis-connectors/typesenseSearchModesfrom@venizia/ignis-connectors/typesenseSearchQueryParamsUtilityfrom@venizia/ignis-connectors/typesenseSoftDeletableRelationalRepositoryfrom@venizia/ignis-connectors/relationalTableColumnCachefrom@venizia/ignis-connectors/relationalTColumnDefinitionfrom@venizia/ignis-connectors/relationalTColumnDefinitionsfrom@venizia/ignis-connectors/relationalTColumnSelectionfrom@venizia/ignis-connectors/relationalTCompiledWherefrom@venizia/ignis-connectors/typesenseTDefinedEntityClassfrom@venizia/ignis-connectors/relationalTDeletedAtColumnfrom@venizia/ignis-connectors/relationalTEntityObjectfrom@venizia/ignis-connectors/relationalTFieldFlagsfrom@venizia/ignis-connectors/typesenseTGetIdTypefrom@venizia/ignis-connectors/relationalTIdColumnfrom@venizia/ignis-connectors/relationalTMultiSearchEntryfrom@venizia/ignis-connectors/typesenseTMultiSearchInputfrom@venizia/ignis-connectors/typesenseTPrimaryKeyfrom@venizia/ignis-connectors/relationalTRecursiveTreeDirectionfrom@venizia/ignis-connectors/relationalTRelationalConnectorOffrom@venizia/ignis-connectors/relationalTRelationalDialectfrom@venizia/ignis-connectors/relationalTRelationalTransactionOffrom@venizia/ignis-connectors/relationalTRelationalTransactionOptionsfrom@venizia/ignis-connectors/relationalTRelationalTransactionOptionsOffrom@venizia/ignis-connectors/relationalTRelationConfigfrom@venizia/ignis-connectors/relationalTRelationDefinitionfrom@venizia/ignis-connectors/relationalTRelationDefinitionsfrom@venizia/ignis-connectors/relationalTRelationMetadatafrom@venizia/ignis-connectors/relationalTSearchDocumentfrom@venizia/ignis-connectors/typesenseTSearchFieldTsTypefrom@venizia/ignis-connectors/typesenseTSearchFieldTypefrom@venizia/ignis-connectors/typesenseTSearchFilterOutcomefrom@venizia/ignis-connectors/typesenseTSearchInputfrom@venizia/ignis-connectors/typesenseTSearchModefrom@venizia/ignis-connectors/typesenseTSearchSchemafrom@venizia/ignis-connectors/typesenseTSoftDeletableTableSchemafrom@venizia/ignis-connectors/relationalTTableColumnKeyfrom@venizia/ignis-connectors/relationalTTableColumnsfrom@venizia/ignis-connectors/relationalTTableInsertfrom@venizia/ignis-connectors/relationalTTableObjectfrom@venizia/ignis-connectors/relationalTTableSchemaWithIdfrom@venizia/ignis-connectors/relationalTUpsertUpdateKeyfrom@venizia/ignis-connectors/relationalTVectorDistancefrom@venizia/ignis-connectors/typesenseTypesenseBaseRepositoryfrom@venizia/ignis-connectors/typesenseUniqueKeysfrom@venizia/ignis-connectors/relationalVectorDistancesfrom@venizia/ignis-connectors/typesense