EntityTS — Enterprise TypeScript ORM

Classes

Class	Description
CockroachDbAdapter	CockroachDB distributed database adapter. Extends PostgresAdapter with CockroachDB-specific provider identity and PostgreSQL wire compatibility.
D1Adapter	Cloudflare D1 serverless SQLite adapter. Runs directly on Cloudflare Workers / Pages using the environment D1 binding.
InterceptingDbAdapter	-
MockDbAdapter	-
MssqlAdapter	-
MysqlAdapter	-
NeonAdapter	Neon Serverless PostgreSQL adapter using @neondatabase/serverless. Supports serverless connection pooling via WebSockets and HTTP.
PlanetScaleAdapter	PlanetScale serverless MySQL adapter using @planetscale/database. Communicates with PlanetScale over HTTP with low latency.
PostgresAdapter	-
ReplicaRoutingDbAdapter	An adapter wrapper that routes read operations across read replicas and locks write operations, procedures, and transactions to the primary database.
SqliteAdapter	-
SupabaseAdapter	Supabase PostgreSQL adapter. Extends PostgresAdapter with Supabase provider identity and SSL defaults.
TursoAdapter	Turso / libSQL adapter using @libsql/client. Works with remote Turso edge databases, embedded replicas, or local libSQL files.
AuditEngine	Engine that builds and persists AuditLogEntry rows to the audit changelog table.
AuditMetadataRegistry	Internal registry mapping entity constructors to their AuditOptions. Populated by the @Auditable class decorator at decoration-time.
BenchmarkRunner	Runner that executes benchmark scenarios with warmup, high-precision timing, percentile distributions, and terminal table formatting.
BenchmarkUser	-
BenchmarkDbContext	Base database context class representing a session with the database.
BulkDeleteBuilder	High-performance bulk delete engine for removing multiple rows matching filter conditions.
BulkInsertBuilder	High-throughput batch insert engine that splits large entity arrays into chunked multi-row INSERT queries.
BulkUpdateBuilder	High-performance batch update engine that processes large numbers of entity mutations in transactions.
BulkUpsertBuilder	High-performance bulk upsert engine executing chunked batch insert-or-update operations across database engines.
EntityCache	Second-level (L2) cache for entities keyed by their primary key. Integrates with TaggedQueryCache to enable entity-wide and per-record cache invalidation.
MemoryQueryCache	-
RedisQueryCache	-
TaggedQueryCache	Advanced cache layer supporting tag-based associations and wildcard tag invalidations.
WriteThroughCache	High-performance Write-Through & Read-Through caching coordinator. Automatically synchronizes cache state with database operations, evicts stale entries, and handles L2 entity cache invalidation on mutations.
SchemaGenerator	Code-First schema generation utilities.
SchemaMigrationDiff	Builds migration statements from a detailed schema diff.
DbContext	Base database context class representing a session with the database.
DbContextFactory	-
DbContextOptionsBuilder	Fluent options builder for configuring a DbContext instance.
DbContextModule	-
DatabaseErrorTranslator	-
DbException	-
ConnectionException	-
ProcedureException	-
QueryException	-
EntityNotFoundException	-
DbUpdateConcurrencyException	-
IdempotencyConflictException	-
EntityValidationException	-
UniqueConstraintViolationException	-
ForeignKeyViolationException	-
CheckConstraintViolationException	-
CannotNullConstraintViolationException	-
SqlSyntaxErrorException	-
TableNotFoundException	-
ColumnNotFoundException	-
ProcedureNotFoundException	-
EntityCreated	Event emitted immediately after an entity is successfully inserted/created.
EntityUpdated	Event emitted immediately after an entity is successfully updated.
EntityDeleted	Event emitted immediately after an entity is successfully removed/deleted (soft or hard).
EntityEventBus	High-performance, zero-dependency async event bus for entity domain and lifecycle events.
GlobalQueryFilterRegistry	-
DataLoaderBatcher	Lightweight in-memory batcher for GraphQL relationship resolvers. Batches individual foreign-key requests across an event loop turn into a single batch query, eliminating the N+1 query problem without requiring external dependencies.
GraphQLSchemaBuilder	Automatically builds GraphQL schema definitions (SDL) and CRUD resolvers directly from EntityTS entity metadata.
IdempotencyManager	Enterprise Idempotency Engine for EntityTS. Guarantees that client retries, webhook dispatches, and duplicate mutation instructions never execute transactions twice.
DrizzleImporter	-
PrismaImporter	-
TypeormImporter	-
ColumnBuilder	-
TableBuilder	-
MigrationBuilder	-
MigrationRunner	-
ModelMetadataRegistry	-
EntityTypeBuilder	Fluent builder for configuring metadata, table names, primary keys, and properties of an entity.
ModelBuilder	Fluent model configuration builder used in DbContext.onModelCreating(modelBuilder).
PropertyBuilder	-
DocumentQuery	LINQ query compiler for document-oriented databases (MongoDB).
NoSqlContext	Top-level context for NoSQL / MongoDB applications in entityTS.
NoSqlSet	LINQ-inspired typed collection for NoSQL / MongoDB document querying and persistence.
DynamoDbAdapter	Amazon DynamoDB adapter for entityTS NoSQL layer.
MockNoSqlAdapter	In-memory NoSQL document database adapter for fast, zero-dependency unit tests.
MongoDbAdapter	MongoDB adapter for entityTS implementing INoSqlAdapter.
RedisAdapter	Redis adapter for entityTS NoSQL and key-value/document caching.
OutboxDispatcher	Enterprise Transactional Outbox Engine for EntityTS. Guarantees zero message loss and at-least-once delivery between local database transactions and distributed message brokers (e.g. Kafka, RabbitMQ, SQS, Webhooks).
ConnectionPool	-
PooledDbAdapter	Adapter decorator that manages connection pooling, acquisition bounds, and background health heartbeat checks over any underlying IDbAdapter.
MultipleResultsReader	Forward-only reader for stored procedures that return multiple tabular result sets (tables). Modeled after Dapper's GridReader and ADO.NET SqlDataReader.NextResult().
SprocOutputBuilder	Intermediate execution builder returned after defining output parameters with .output<TOut>().
StoredProcedureBuilder	Fluent builder for configuring and executing database stored procedures and routines across all supported database engines.
HavingExpressionBuilder	-
AggregateExpression	-
GroupKeyExpression	-
GroupedQueryBuilder	Builds and executes fluent GROUP BY, HAVING, and projected aggregation queries.
ProjectedGroupedQuery	Projected query awaiting terminal execution (toList, first, etc.)
QueryBuilder	Low-level SQL AST and query compiler supporting multiple database dialects.
WhereClause	Fluent builder for constructing SQL WHERE filter conditions.
WindowSpecBuilder	-
WindowFunctionExpression	-
WindowFunction	Fluent builder for SQL window functions (ROW_NUMBER, RANK, DENSE_RANK, LAG, LEAD, etc.)
SqlFragment	Represents a raw SQL expression snippet generated by dialect-aware functions.
RdbmsFunctionBuilder	Cross-dialect database functions builder providing typed SQL expressions.
CdcEmitter	Change Data Capture (CDC) emitter and subscriber.
DefaultExecutionStrategy	-
EntityScaffolder	Takes a list of IntrospectedTable descriptors and scaffolds TypeScript entity files and a DbContext subclass to the output directory.
SchemaIntrospector	Queries the live database to produce an array of IntrospectedTable descriptors. Supports PostgreSQL, MySQL, SQL Server, and SQLite.
EncryptionEngine	Enterprise AES-256-GCM Authenticated Encryption Engine. Provides military-grade, tamper-evident field-level encryption for PCI-DSS, HIPAA, and enterprise PII compliance with zero external dependencies.
SeedRunner	Tracks and executes structured seed modules, preventing double-execution via a __entityts_seeds table.
DbSet	Represents a typed collection of entities in the database for querying and mutation operations.
LazyRelation	Encapsulates a deferred navigation property reference. Allows on-demand asynchronous resolution of related entities without upfront eager .include().
UpdateSetBuilder	Fluent builder for specifying property updates in LINQ executeUpdate queries.
FixtureBuilder	Fixture builder instance providing build(), create(), buildList(), createList().
FixtureFactory	Fixture factory system for unit and integration testing in EntityTS.
InMemoryContext	Lightweight, zero-setup in-memory DbContext for fast unit and integration testing. Powered by MockDbAdapter with full in-memory SQL execution, query inspection, and state reset capabilities.
SqlAssertions	Custom assertions for testing SQL generation and parameter bindings.
ChangeTracker	Tracks changes made to entity instances to enable unit-of-work persistence via DbContext.saveChanges().
EntityEntry	-
DbTransaction	Encapsulates an active database transaction.
TrpcRouterBuilder	Generates typed procedure routers for tRPC backends from EntityTS entity metadata.
UnitOfWork	Enterprise Unit of Work pattern implementation for EntityTS.
ValidationRegistry	-
ValidationEngine	-

Interfaces

Interface	Description
AdapterParam	-
CockroachDbAdapterConfig	-
D1PreparedStatementLike	-
D1DatabaseLike	-
D1AdapterConfig	-
DriverPackageInfo	-
IDbAdapter	-
MockProcedureHandler	-
MockProcedureDef	-
MockDbAdapterOptions	-
MssqlAdapterConfig	-
MysqlAdapterConfig	-
NeonAdapterConfig	-
PlanetScaleAdapterConfig	-
PostgresAdapterConfig	-
ReplicaRoutingOptions	-
SqliteAdapterConfig	-
SupabaseAdapterConfig	-
TursoAdapterConfig	-
AuditOptions	Options for the @Auditable class decorator.
AuditLogEntry	A single row written to the audit changelog table for every tracked mutation.
BenchmarkResult	Result metrics collected for an individual benchmark scenario.
BenchmarkScenario	Definition of an individual benchmark scenario.
BenchmarkOptions	Configuration options for the benchmark runner.
BulkDeleteOptions	Options for high-performance bulk deletion.
BulkInsertOptions	Options for high-performance chunked bulk insertion.
BulkUpdateOptions	Options for high-performance chunked bulk updates.
BulkUpsertOptions	Configuration options for batch bulk upsert operations.
EntityCacheOptions	-
IQueryCache	-
MemoryQueryCacheOptions	-
RedisLikeClient	-
RedisQueryCacheOptions	-
TaggedQueryCacheOptions	-
WriteThroughCacheOptions	-
ReadThroughOptions	-
SchemaDiff	-
SchemaGeneratorOptions	-
ColumnDiffDetail	-
DetailedSchemaDiff	-
DbHealthResult	Diagnostic health status object returned by context.health().
IDbContextFactory	-
DbContextOptions	-
BelongsToOptions	-
ColumnOptions	-
DecimalOptions	-
CurrencyOptions	-
HasManyOptions	-
HasOneOptions	-
IndexOptions	-
ManyToManyOptions	-
ManyToOneOptions	-
OneToManyOptions	-
OneToOneOptions	-
PrimaryKeyOptions	-
ForeignKeyOptions	-
SoftDeleteOptions	Options for the @SoftDelete decorator.
TableOptions	-
EntityOptions	-
VectorOptions	-
VersionOptions	-
DbContextMiddlewareOptions	-
FastifyDbContextOptions	-
DbContextModuleOptions	-
DbContextModuleAsyncOptions	-
IDomainEvent	Base interface for all typed entity lifecycle domain events.
GraphQLResolverMap	-
QueryHooks	-
IdempotencyOptions	-
IdempotencyRecord	-
GeneratedFile	-
ImportResult	-
ColumnDefinition	-
MigrationRecord	-
MigrationModule	-
ColumnMetadata	-
SoftDeleteMetadata	-
IndexMetadata	-
RelationMetadata	-
VersionMetadata	-
EntityLifecycleHooks	-
EntityMetadata	-
InsertOneResult	-
InsertManyResult	-
UpdateResult	-
DeleteResult	-
FindOptions	-
UpdateOptions	-
DeleteOptions	-
InsertOptions	-
CountOptions	-
AggregateOptions	-
NoSqlTransaction	-
INoSqlAdapter	Universal interface for document-oriented (NoSQL) database adapters in entityTS.
NoSqlPagedResult	-
DynamoDbAdapterOptions	-
MongoDbAdapterConfig	-
RedisAdapterOptions	-
OpenTelemetryTracerLike	-
PlanNode	A single node extracted from the query plan tree (PostgreSQL JSON format).
QueryPlanResult	Parsed result of an EXPLAIN [ANALYZE] execution.
QueryPlanLoggerOptions	Options for createQueryPlanLogger.
SlowQueryLoggerOptions	-
StructuredQueryLoggerOptions	-
OutboxMessage	-
DispatchOptions	-
DispatchSummary	-
PoolHealthResult	-
ConnectionPoolOptions	-
IConnectionPool	-
ParamOptions	-
SprocResult	Simplified result returned by .output().query(), .output().queryMultiple(), and .output().run().
StoredProcedureResult	-
CursorPaginationOptions	-
CursorPageResult	-
PagedListOptions	-
HavingCondition	-
IGroupProxy	-
OrderByClause	-
JoinClause	-
PagedResult	-
SqlResult	-
Subquery	Encapsulates a compiled or chainable subquery with an assigned table alias.
CommonTableExpression	Definition of a Common Table Expression (WITH clause).
NearestOptions	Options for AI vector embedding distance search.
JoinFieldRef	-
JoinComparison	-
PredicateBuilder	-
SearchOptions	-
SubqueryCondition	-
WhereCondition	-
CdcEvent	-
CdcSubscriptionFilter	-
IExecutionStrategy	-
ExecutionStrategyOptions	-
EntityScaffolderOptions	-
ScaffoldResult	-
IntrospectedColumn	-
IntrospectedForeignKey	-
IntrospectedTable	-
EncryptionOptions	-
SeedModule	-
SeedRecord	-
SeedStatus	-
DbSetOptions	-
InMemoryContextOptions	-
SqlQueryResult	-
IDbTransactionDriver	-
TrpcProcedureHandler	-
EntityTrpcRouter	-
UnitOfWorkOperation	-
UnitOfWorkCommitResult	-
ValidationRule	-
ValidationResult	-

Functions

Function	Description
detectPackageManager	Detect the package manager used in the given directory or process.cwd().
getInstallCommand	Get install command line for a given package and package manager.
normalizeProvider	Normalizes provider aliases (e.g. 'sqlserver' -> 'mssql', 'postgresql' -> 'postgres').
loadDriver	Loads a database driver dynamically and throws a targeted ConnectionException if the package is not installed in the consuming application.
Auditable	Class decorator that enables automatic audit changelog tracking for an entity.
createExecutionBenchmarkSuite	Creates and configures the Execution Benchmark Suite for EntityTS.
runExecutionBenchmarks	Convenience helper to run the complete execution benchmark suite.
sqlTypeToColumnType	Maps a SqlType to a dialect-appropriate SQL column type string.
entityToMigrationBuilder	Converts an EntityMetadata object into a populated MigrationBuilder that generates correct CREATE TABLE DDL for all supported adapters. Returns undefined for view entities — DDL is skipped for views.
BelongsTo	Property decorator establishing a child-to-parent inverse relationship.
Column	Property decorator mapping a class property to a database table column.
CompositeKey	Class decorator designating a multi-column composite primary key for an entity.
Computed	Property decorator designating a database-computed / virtual column.
CreatedAt	Property decorator indicating that this field is auto-populated with the creation timestamp (new Date()) on INSERT.
CreatedBy	Property decorator indicating that this field is auto-populated with the current user / author identifier on INSERT.
Decimal	Property decorator defining a high-precision decimal database column. Typically maps to SQL DECIMAL(precision, scale) or NUMERIC(precision, scale). Default precision is 18 and scale is 4.
Currency	Property decorator defining an ISO 4217 3-character currency code column (e.g. 'USD', 'EUR', 'GBP').
Default	Property decorator designating a default value or generator function for an entity property.
Encrypted	Property decorator marking a class property for transparent AES-256-GCM field-level encryption. Automatically encrypts plaintext values before database persistence (INSERT / UPDATE) and decrypts values upon entity hydration during queries.
Enum	Property decorator restricting a column's value to a specific set of allowed enum strings.
HasMany	Property decorator establishing a one-to-many relationship with another entity.
HasOne	Property decorator establishing a one-to-one parent relationship with another entity.
Index	Decorator defining an index on an entity table.
BeforeInsert	Method decorator marking a method to run immediately before this entity is inserted into the database.
AfterInsert	Method decorator marking a method to run immediately after this entity is inserted and its ID is assigned.
BeforeUpdate	Method decorator marking a method to run immediately before an existing entity is updated.
AfterUpdate	Method decorator marking a method to run immediately after an existing entity is updated.
BeforeRemove	Method decorator marking a method to run immediately before an entity is removed or soft-deleted.
AfterRemove	Method decorator marking a method to run immediately after an entity is removed.
ManyToMany	Property decorator establishing a many-to-many relationship joined via a junction table.
ManyToOne	Property decorator establishing a many-to-one relationship with a parent entity. Supports both TypeORM style @ManyToOne(() => User, u => u.posts, { foreignKey: 'userId' }) and EntityTS style @ManyToOne(() => User, 'userId').
OneToMany	Property decorator establishing a one-to-many relationship with another entity. Supports both TypeORM style @OneToMany(() => Post, p => p.user, { cascade: true }) and EntityTS @OneToMany(() => Post, { foreignKey: 'userId' }).
OneToOne	Property decorator establishing a one-to-one relationship with another entity.
PrimaryKey	Property decorator designating a property as the primary key of the entity.
ForeignKey	Property decorator defining an explicit foreign key column referencing another entity.
Ignore	Property decorator telling the ORM to completely ignore this property during database operations.
SoftDelete	Class or Property decorator to enable soft deletion for an entity model.
Table	Class decorator mapping an entity class to a specific database table name and schema.
Entity	Class decorator marking a TypeScript class as a database entity managed by DbContext.
ViewEntity	Class decorator mapping an entity class to a database VIEW rather than a table.
TenantId	Property decorator marking a field as the tenant discriminator identifier.
Unique	Property decorator that enforces a UNIQUE constraint on the mapped database column.
UpdatedAt	Property decorator indicating that this field is auto-updated with current timestamp (new Date()) on INSERT and UPDATE.
Vector	Property decorator defining an AI vector embedding column (e.g. pgvector, OpenAI, Cohere, Llama). Supports similarity searches with cosine distance (<=>), Euclidean/L2 distance (<->), and inner product (<#>).
Version	Property decorator for optimistic concurrency control.
RowVersion	Alias for @Version() configured with the sequential numeric strategy.
ConcurrencyCheck	Property decorator that verifies an individual property hasn't changed before executing UPDATE or DELETE.
dbContextMiddleware	Express / Connect middleware that attaches a scoped DbContext instance to req.dbContext. Automatically disconnects on response finish if autoDispose is enabled.
fastifyDbContext	Fastify plugin that attaches a scoped DbContext instance to request.dbContext. Automatically disposes the context on the onResponse hook if autoDispose is enabled (default true).
getDbContextToken	-
InjectDbContext	Parameter decorator for injecting DbContext into NestJS constructors.
createDbContext	-
createOpenTelemetryHooks	-
createQueryPlanLogger	Creates a QueryHooks plugin that transparently runs EXPLAIN [ANALYZE] alongside each SELECT query and prints a rich, structured plan report with:
createSlowQueryLogger	-
createStructuredQueryLogger	Creates a structured query logger that formats executed SQL operations like Prisma.
encodeCursor	Encodes cursor data into a URL-safe Base64 string.
decodeCursor	Decodes a cursor token (Base64 string or plain object) into an object.
createJoinProxy	Creates a dynamic proxy tracking column access and operations for cross-table predicates.
extractColumnName	Extracts a property or column name from either a string key or a lambda property accessor.
isTransientError	Checks whether a given database error is transient and safe to retry.
createTestContext	Creates an in-memory DbContext instance for testing.
expectQuery	Creates an SqlAssertions wrapper for query verification.
IsEmail	Validates that the property value is a valid email address string.
Length	Validates that a string's length is between min and max inclusive.
Min	Validates that a number is greater than or equal to a minimum value.
Max	Validates that a number is less than or equal to a maximum value.
IsNotEmpty	Validates that a value is neither null, undefined, nor empty string/array.
Matches	Validates that a string matches a specified Regular Expression pattern.
IsUrl	Validates that a string is a well-formed HTTP/HTTPS URL.
CustomValidator	Validates property using a custom validation function.

Type Aliases

Type Alias	Description
DbProvider	-
LoadBalancingStrategy	-
ColumnChangeType	-
NamingConvention	-
LogMode	-
LogFunction	-
QueryTrackingBehavior	-
EventHandler	-
QueryFilterCallback	-
PropertySelector	-
EntityConstructor	-
DocumentFieldSelector	-
NoSqlProvider	-
NoSqlFilter	-
NoSqlUpdate	-
AggregationStage	-
CollectionTarget	-
NoSqlPredicate	-
NoSqlFieldSelector	-
LogFormat	-
OutboxStatus	-
PoolStatus	-
UnpackAggregate	-
ProjectedResult	-
JoinType	-
JoinProxy	-
WhereOperator	-
LogicalOperator	-
SearchMode	-
ColumnKey	-
CdcOperation	-
CdcHandler	-
WithLoaded	-
EntityTarget	-
LinqPredicate	-
FactoryGenerator	-
ValidationOptions	-

Variables

Variable	Description
DRIVER_REGISTRY	-
fn	Dialect-aware RDBMS functions namespace (fn).
rdbms	Alias for fn.

Enumerations

Enumeration	Description
ParameterDirection	-
SqlType	-
EntityState	-
IsolationLevel	-

References

EntityCreatedEvent

Renames and re-exports EntityCreated

---

EntityUpdatedEvent

Renames and re-exports EntityUpdated

---

EntityDeletedEvent

Renames and re-exports EntityDeleted