Index of exports

Every function, class, constant and type that the packages export, with the first sentence of its documentation. Each name links to its page in the API reference, which has the full signature and an example; the guide pages explain how they fit together.

egon-orm

Schemas and associations

Guide: Schemas and associations.

Export	Kind	Summary
AnySchema	type	Any schema class.
assoc	function	A query for the rows of association name of one parent or several.
Assoc	interface	An association declaration.
AssocKeys	type	The names of the associations of schema class S.
AssocKind	type	The four association kinds.
AssocMeta	interface	Everything known about one association, resolved lazily.
AssocOrderBy	type	The default order of an association's rows.
AssocOrderMeta	interface	One entry of an association's default preload order.
AssocWhere	type	A condition that an association always applies to its target.
belongsTo	function	Declares that this schema holds a foreign key to target.
BelongsToOptions	interface	Options of belongsTo.
DefaultFieldFlags	interface	The flags of a field with no modifier applied.
EmbeddedSchema	function	Defines an embedded schema.
EmbeddedSchemaOptions	interface	Options of EmbeddedSchema.
EmbedFieldBuilder	interface	The builder of an embed field, as the types see it.
EmbedMeta	interface	Everything known about one embed.
EmbedOnReplace	type	What a nested write does with an embed that the new value replaces.
EmbedOptions	interface	Options of t.embedOne and t.embedMany.
FieldBuilder	interface	A field declaration.
FieldFlags	interface	The facts about a field that the type system tracks, as a record of booleans.
FieldMeta	interface	Everything known about one field of a schema.
fieldNames	function	The field names of a schema class, in declaration order.
FieldNames	type	The field names of a schema class.
FieldsShape	type	The fields object passed to Schema(source, fields).
FieldTypes	interface	The field types.
hasMany	function	Declares that any number of rows of target point at this schema.
HasManyOptions	interface	Options of hasMany.
hasOne	function	Declares that at most one row of target points at this schema.
HasOneOptions	interface	Options of hasOne.
InsertShape	type	The object a caller supplies to insert a row of schema S.
isLoaded	function	Whether association name is loaded on row.
isRow	function	Whether value is a row.
isSchema	function	Whether value is a schema class.
JoinKeyMeta	interface	One side of a manyToMany join.
JoinKeys	interface	The two sides of a join table.
JoinThroughMeta	interface	The join table of a manyToMany association.
Json	type	The type of T once it has been through JSON.stringify and JSON.parse.
JsonReturn	type	The JSON of what function F resolves to.
KeyFields	type	A field name, or several for a composite key.
Loaded	type	A row of schema S with the associations in P loaded.
LoadedAs	type	A row of schema S with association K loaded as elements of type E, whatever E is.
LoadedUnchecked	type	A row of S with the associations of preload spec P loaded.
manyToMany	function	Declares that rows of target are linked to this schema through a join table.
ManyToManySchemaOptions	interface	Options of manyToMany when the join table has a schema class of its own.
ManyToManyTableOptions	interface	Options of manyToMany when the join table is given by name.
meta	function	The metadata of a schema class.
Naming	type	How field names become column names (or, in an embedded schema, JSON keys).
OnReplace	type	What happens to associated rows that a parent changeset no longer mentions.
PreloadMarker	interface	The type-only marker of a Loaded row type.
PreloadSpec	type	Which associations of schema S are loaded, to any depth.
primaryKeyOf	function	The value that identifies a row.
PrimaryKeyOf	type	The value that identifies one row of schema S.
Row	type	The type of a row of schema S.
RowMarker	class, as a type	What every row type has besides its fields and the class's own members.
RowMeta	interface	Per-row metadata, stored under ROW.
RowState	type	Where a row stands relative to the database.
Schema	function	Defines the schema of a table.
SchemaClass	type	What Schema(source, fields) returns.
SchemaMeta	interface	Everything derived from a schema definition, computed once and cached on the class under META.
SchemaOptions	interface	Options of Schema.
stateOf	function	Where a row stands relative to the database.
t	constant	The field builder.
ThroughOptions	interface	Options of a hasOne or hasMany that follows a chain of other associations.
TimestampFields	type	The fields timestamps returns.
timestamps	function	The two bookkeeping fields, to spread into a schema's fields.
TimestampsOptions	interface	Options of timestamps.
VirtualOptions	interface	Options of .virtual().
WithFlag	type	F with the flag K set to true.
WithoutJson	type	F with the flag json set to false.
Writable	type	When a field may be written.

Types

Guide: Types.

Export	Kind	Summary
AnyFieldType	type	A FieldType whose type parameters are not known statically.
AppTypeOf	type	The application type of a FieldType.
CastResult	type	The outcome of FieldType.cast.
Codec	interface	A pair of driver conversions.
DbType	type	The logical column type of a FieldType.
DbTypeKind	type	The kind of a DbType.
DbTypeOf	type	The driver type of a FieldType.
DecimalOptions	interface	Options of t.decimal().
defineType	function	Creates a type.
EnumMapping	type	The mapping of `t.enum({ ...
FieldType	interface	A type.
parameterized	function	Builds a family of types from options, and remembers the result per option set.
TimestampOptions	interface	Options of t.timestamp() and t.localTimestamp().
TimestampPrecision	type	The precision of a timestamp field.
TypeDefinition	type	What defineType takes.

Changesets and validation

Guide: Changesets and validation.

Export	Kind	Summary
Action	type	What a changeset is being used for.
AnyChildChangeset	type	A changeset of T of either kind, as a with function may return it.
AppliedData	type	What applyChanges() returns.
applyAction	function	Applies the changes if the changeset is valid, without the database.
applyActionOrThrow	function	Applies the changes if the changeset is valid, without the database, as applyAction does, and returns the updated row (or plain data object).
AssocChange	type	The change of association K of S in changeset.changes.
AssocName	type	The association names of S.
AssocTarget	type	The target class of association K of S, or never when the types do not know it (a changeset made from a row alone).
BASE	constant	The error key for problems that belong to the record as a whole.
buildAssoc	function	A changeset for a new record of a hasOne or hasMany association of parent, with the foreign key set from the parent's key (and the association's declared defaults applied) before values.
cast	function	Starts a changeset from untrusted input, such as a request body.
CastNestedArgs	type	The options argument of a nested cast.
CastNestedOptions	interface	The options of castAssoc and castEmbed.
CastOptions	interface	Options of cast.
change	function	Starts a changeset from trusted values, such as values your own code computed.
Changes	type	The changes of a changeset.
Changeset	class	A change to one record.
ChangesetData	type	The existing record of a changeset whose target has one.
ChangesetError	interface	One validation or constraint error on a field.
ChangesetLike	interface	The part of a changeset that code outside changeset/ may rely on.
ChangesetModel	type	The class of a changeset's records, typed by its rows.
ChangesetSource	type	What a changeset describes.
ChangeValidatorError	interface	An error returned by a validateChange function.
ChangeValidatorResult	type	What a validateChange function returns.
CheckConstraintOptions	interface	Options of checkConstraint.
ConfirmationOptions	interface	Options of validateConfirmation.
Constraint	interface	A constraint declared on a changeset.
ConstraintOptions	interface	Options of the constraint declarations.
ConstraintType	type	The kinds of constraint a changeset can declare.
EmbedName	type	The names castEmbed and putEmbed take.
EmbedTarget	type	The embedded schema class of embed field K of S, or never when the types do not know it.
ErrorFormatter	type	The callback of traverseErrors.
ErrorMessages	type	The type of errorMessages().
ErrorTree	interface	The errors of a changeset as traverseErrors returns them.
ErrorTreeOf	type	What traverseErrors(changeset, fn) returns, for a changeset of type C and a callback returning T.
FieldChange	type	The change of field K of S in changeset.changes.
FieldName	type	The field names of S.
FieldOfType	type	The fields of S whose value (without null) is a T.
FieldValidator	type	What validateField takes.
FieldValidatorFn	type	A function given to validateField.
FieldValues	type	The value of every field of S, virtual fields included.
LengthOptions	interface	Options of validateLength.
LooseNestedOptions	interface	The options of a nested cast whose target the types do not know (a changeset made from a row alone).
MessageOption	type	A message given to a validation in place of its default.
MessageOptions	interface	The message option every validation takes.
NumberOptions	interface	Options of validateNumber.
PrepareFunction	type	A function given to prepareChanges.
PutAssocValue	type	What putAssoc(name, value) takes for association K of S.
PutEmbedValue	type	What putEmbed(name, value) takes for embed field K of S.
PutItem	type	One record given to putAssoc or putEmbed.
PutObject	type	A plain object given to putAssoc for one record of T.
RequiredOptions	interface	Options of validateRequired.
RowSchema	type	The schema a changeset is typed with when it is made from a row alone.
SchemalessTarget	interface	A changeset without a schema class.
StandardSchemaV1	interface	A schema of any library that implements Standard Schema v1.
StandardSchemaV1Issue	interface	One validation issue.
StandardSchemaV1PathSegment	interface	A path segment in object form.
StandardSchemaV1Result	type	What validate returns.
traverseErrors	function	Turns every error of a changeset, and of the changesets nested in its changes, into a value with fn.
TypedErrorTree	type	The errors of a changeset of S with the extra error keys E, as traverseErrors returns them.
UniqueAsyncOptions	interface	Options of validateUniqueAsync.
ValidateOptions	interface	Options of validate and validateAsync.
ValidationEntry	type	One entry of cs.validations.
ValidationIssue	interface	One problem reported by a ValidatorFn.
Validator	type	Anything a changeset can be validated with.
ValidatorContext	interface	What a ValidatorFn is told besides the values.
ValidatorFn	type	A validator written as a plain function.
ValidatorResult	type	What a ValidatorFn returns.
WithFunction	type	The function that makes the changeset of one child.

Queries and expressions

Guide: Queries and expressions.

Export	Kind	Summary
Aggregate	class, as a type	An aggregate call.
and	function	a AND b AND ….
arrayAgg	function	array_agg(x).
avg	function	avg(x).
Binding	type	The binding of schema S in a query.
Case	class, as a type	CASE WHEN … THEN … [WHEN …] [ELSE …] END.
caseWhen	function	Starts a CASE expression.
coalesce	function	coalesce(a, b, …).
Col	class, as a type	A column of a binding.
count	function	count(*) with no argument.
countDistinct	function	count(DISTINCT x).
cte	function	A CTE of the query as a source, typed by a schema class (its rows are whole rows of it) or by the CTE's own query.
CteOptions	interface	Options of withCte.
cumeDist	function	cume_dist().
denseRank	function	dense_rank().
dynamic	constant	A condition or expression built before the query it is used in, for filters assembled from data.
Dynamic	type	An expression built before its query.
DynamicBindings	type	The bindings a dynamic expression receives for the schemas Bs.
DynamicFunction	interface	The dynamic function, and dynamic.true() / dynamic.false().
DynamicMethods	interface	The methods of a dynamic condition.
ExcludableClause	type	The clauses exclude can remove.
exists	function	EXISTS (query).
Expr	class, as a type	A typed SQL expression.
field	function	A column of a binding chosen by a name known only at run time, such as a sort key from a request.
firstValue	function	first_value(value).
fragment	constant	Raw SQL, as a tagged template.
FragmentFunction	interface	The fragment tag, and fragment.ident for a dynamic identifier.
from	function	Starts a query.
hasNamedBinding	function	Whether query has a binding named alias, and with a schema class, whether that binding is of that schema.
jsonAgg	function	json_agg(x).
lag	function	lag(value, offset = 1, default).
lastValue	function	last_value(value).
lead	function	lead(value, offset = 1, default).
lit	function	A literal written into the SQL text, for the kinds that are safe there.
LockMode	type	The row lock modes.
LockOptions	interface	Options of lock.
max	function	max(x).
min	function	min(x).
NeedsWindow	interface	Type only.
NoParams	type	The named parameters of an expression that uses none.
not	function	NOT x.
now	function	now().
nthValue	function	nth_value(value, n).
ntile	function	ntile(buckets).
Operand	type	What a comparison or arithmetic operator takes for an expression of type T.
or	function	a OR b OR ….
OrderExpr	class, as a type	One ORDER BY item.
outerRef	function	The binding alias of the query a subquery is nested in, with the columns of schema.
param	function	A named parameter.
percentRank	function	percent_rank().
PreloadQuery	type	The query a preload callback receives, and what assoc() returns.
prepare	function	Marks a query that runs many times.
PreparedQuery	class, as a type	A query prepared with prepare.
Query	class, as a type	A query.
Queryable	type	What a repo method reads.
QueryLike	interface	Anything with a query's type information.
QueryParams	type	The named parameters a query needs when it runs.
QueryResult	type	The type of the rows a query returns.
QueryWith	type	A query that has a binding of schema S under each alias of Bs, whatever else it has.
rank	function	rank().
rowNumber	function	row_number().
scalar	function	A query as one value, (SELECT …).
selectedAs	function	Names a selected expression in the SQL (… AS "total"), so that orderBy and groupBy can refer to it with selectedAs("total").
SetInput	type	What set takes for schema S.
SomeParams	type	The named-parameter position that accepts an expression whatever parameters it needs.
Source	type	A source made by subquery(q) or cte(name, shape).
SourceBindingOf	type	The binding a query gives as a source.
SourceRowOf	type	The row a query over the source returns when it selects nothing.
stringAgg	function	string_agg(x, separator).
subquery	function	A query as a source, for from or a join.
SubqueryBinding	type	The binding of a source that returns objects of values (a subquery or CTE whose query selects an object of expressions).
sum	function	sum(x).
tuple	function	A row value for a row comparison.
Tuple	class, as a type	A row value.
UsesWindow	interface	Type only.
val	function	An explicit bound parameter, for a value whose type cannot come from the other side of an operator (in a select, in a fragment, as the first argument).
WhereObject	type	The object form of where for schema S.
WindowDefs	type	The named windows of .windows({ … }).
WindowFunction	type	A window function before over(…).
WindowSpec	interface	The window an aggregate is computed over (OVER (…)), when it is not a named one.

Repo and results

Guide: Repo and results.

Export	Kind	Summary
AggregateFunction	type	The aggregate functions of repo.aggregate.
BulkResult	interface	What a bulk write returns.
ConflictTargetOption	type	Which conflict an upsert handles.
ConflictUpdateOption	type	Which columns an upsert updates on the row it collided with.
createRepo	function	Creates a repo over an adapter.
DeleteOptions	interface	The options of repo.delete.
ExplainReadOptions	interface	The options of repo.explain.
failure	function	Builds a failed Result.
Failure	interface	The failure half of a Result.
InsertAllOptions	interface	The options of repo.insertAll.
InsertAllRow	type	One row of insertAll.
InsertOptions	interface	The options of repo.insert.
InsertOrUpdateOptions	interface	The options of repo.insertOrUpdate.
LogOption	type	Logs each statement the repo runs.
OnConflictOption	type	What an insert does when it collides with an existing row.
PlanCacheStats	interface	Counters of a plan cache, for telemetry and tests.
PreloadOptions	interface	The options of repo.preload.
RawRows	interface	What repo.raw returns.
ReadArgs	type	The arguments after the queryable.
ReadOptions	interface	The options every read method takes, last.
Repo	interface	The repo.
RepoOperation	type	What a repo method reports in its query events as operation.
RepoOptions	interface	The options of {@link createRepo }.
RepoQueryEvent	interface	One statement the repo ran, as its query listeners receive it.
Result	type	Either data or an error, discriminated by success.
ResultOf	type	What a read of Q returns per row.
RootSchemaOf	type	The schema class of the root binding of Q.
SqlAndParams	interface	What repo.toSql returns.
StaleErrorOption	interface	How a stale update or delete is reported on the changeset instead of thrown.
StreamReadOptions	interface	The options of repo.stream.
success	function	Builds a successful Result.
Success	interface	The success half of a Result.
TransactionOptions	interface	The options of repo.transaction and repo.transactionOrThrow.
UpdateOptions	interface	The options of repo.update.

Batch

Guide: Batch.

Export	Kind	Summary
Batch	class	A list of named steps that run in one transaction.
BatchFailure	interface	How a batch failed.
BatchOperation	type	The operations a batch step can be.
BatchStep	interface	One step of a batch, as Batch.toList lists it.
createBatch	function	Starts a batch with no steps.

Adapters

Guide: Adapters.

Export	Kind	Summary
Adapter	interface	A database, as the repo sees it.
AdapterDefinition	interface	What a dialect package gives createAdapter, internal to the Egon packages like createAdapter, and not a supported extension point.
AdapterEvents	interface	The events an adapter emits, by name.
BeginOptions	interface	Options for starting a transaction.
Capabilities	interface	What a dialect supports.
Connection	interface	One checked-out database connection.
createAdapter	function	Creates an adapter from a dialect's definition, internal to the Egon packages.
DatabaseAdapter	interface	An adapter as the dialect packages create it.
Dialect	type	The SQL dialects.
DriverCodec	interface	How one driver's values for a column kind differ from the canonical driver values the types expect.
DriverCodecs	type	The fixes of one driver, by column kind.
ExecuteOptions	interface	Options for one execution.
Executor	interface	Anything that can run SQL.
IsolationLevel	type	The transaction isolation levels.
PoolEvent	interface	The state of the connection pool, reported with pool events.
PoolStats	type	The state of an adapter's connection pool.
QueryEvent	interface	One executed statement, as reported to telemetry listeners.
QueryListenerOptions	interface	Options of a query listener.
RawResult	interface	What a statement returned, exactly as the driver reported it.
StreamOptions	interface	Options for a streamed execution.

Errors

Guide: Errors.

Export	Kind	Summary
CastError	class	A value could not be converted to the type it was supposed to have, outside a changeset (inside one, a failed cast is a changeset error, not an exception).
ConstraintError	class	The database rejected a write because of a constraint that the changeset did not declare.
ConstraintViolationType	type	The kinds of constraint violation a database reports.
DatabaseError	class	The database or its driver failed.
DatabaseErrorCode	type	The codes of a DatabaseError.
EgonError	class	The base class of every error Egon throws.
ErrorCatalog	type	A catalog of full messages.
ErrorCode	type	The stable codes of the error classes.
ErrorDetails	interface	What an error's constructor takes besides the identifier and the short sentence.
ErrorId	type	The identifier of every message Egon throws, such as "query.aliasTaken".
ErrorParams	type	The values named by in an identifier's catalog entry.
InvalidChangesetError	class	An …OrThrow write was given an invalid changeset.
isEgonError	function	Whether value is an error thrown by Egon, optionally with a given code.
MultipleResultsError	class	A query that may return at most one row returned more (one, getBy, …).
NoResultsError	class	A query that had to return a row returned none (oneOrThrow, getOrThrow, …).
NotLoadedError	class	An association was needed but had not been preloaded.
QueryError	class	A query is wrong.
RollbackError	class	A transaction was rolled back where its caller expected a value.
SchemaDefinitionError	class	A schema is declared wrongly.
StaleEntryError	class	An update or delete matched no row.
useFullErrorMessages	function	Makes every error constructed from now on carry its full message.

The package

Guide: The package.

Export	Kind	Summary
VERSION	constant	The version of the egon-orm package.

egon-orm/testing

Export	Kind	Summary
createSandbox	function	Makes a sandbox for a repo made by createRepo.
expectQueries	function	Runs fn and returns the query events of the statements the repo ran meanwhile, in order.
Sandbox	interface	A sandbox over one repo.

egon-orm/migration

Export	Kind	Summary
AlterTableBuilder	class, as a type	The t of m.alterTable(name, (t) => …).
ColumnAdder	class, as a type	The column methods shared by createTable and alterTable.
ColumnBuilder	class, as a type	One column being defined.
ColumnKind	type	The column types that have a name of their own.
ColumnType	type	The type of a column, as a migration names it.
CreateConstraintOptions	interface	Options of MigrationBuilder.createConstraint.
createDatabase	function	Runs CREATE DATABASE name through adapter, which must be connected to another database of the same server (on Postgres, usually postgres).
createMigrator	function	Creates a migration runner over an adapter.
CreateTableOptions	interface	Options of MigrationBuilder.createTable.
DefaultValue	type	A column default.
defineMigration	function	Defines a migration.
DownOptions	interface	Options of Migrator.down.
DropConstraintOptions	interface	Options of MigrationBuilder.dropConstraint.
dropDatabase	function	Runs DROP DATABASE [IF EXISTS] name through adapter, which must be connected to another database of the same server.
DropIndexOptions	interface	Options of MigrationBuilder.dropIndex.
DropTableOptions	interface	Options of MigrationBuilder.dropTable.
IdOptions	interface	Options of ColumnAdder.id.
IndexOptions	interface	Options of MigrationBuilder.createIndex.
JsonValue	type	A JSON value, for the default of a json or jsonb column.
Migration	interface	A migration, as defineMigration returns it.
MigrationBuilder	class, as a type	The m a migration's up and down receive.
MigrationDefinition	interface	What a migration is written as.
MigrationError	class	A migration could not be defined, loaded or run.
MigrationEvent	type	What the runner reports while it works.
MigrationRun	interface	One migration that was run (or, in a dry run, would be).
MigrationSource	interface	One migration with its version and name.
MigrationStatus	interface	The state of one migration.
Migrator	interface	Applies, rolls back and reports migrations.
MigratorOptions	interface	Options of createMigrator.
ModifyOptions	interface	Options of AlterTableBuilder.modify.
parseMigrationFileName	function	Parses a migration file name.
ReferenceAction	type	What a foreign key does when the row it points at is deleted or its key is updated.
ReferencesOptions	interface	Options of ColumnAdder.references.
SqlFragment	type	SQL written by the program, as a fragment template.
TableBuilder	class, as a type	The t of m.createTable(name, (t) => …).
TimestampsColumnsOptions	interface	Options of ColumnAdder.timestamps.
UpOptions	interface	Options of Migrator.up.

egon-orm/messages

Export	Kind	Summary
explain	function	The full text of one error.
messages	constant	The full text of every error message, by identifier.

@egon-orm/postgres

Export	Kind	Summary
postgres	function	Creates a Postgres adapter.
PostgresOptions	interface	The options of {@link postgres }.
PostgresPoolOptions	interface	Pool settings for the pool the adapter creates.
VERSION	constant	The version of the @egon-orm/postgres package.

@egon-orm/sqlite

Export	Kind	Summary
PragmaValue	type	A pragma's value.
sqlite	function	Creates a SQLite adapter over better-sqlite3.
SqliteOptions	interface	The options of {@link sqlite }.
VERSION	constant	The version of the @egon-orm/sqlite package.

@egon-orm/mysql

Export	Kind	Summary
mysql	function	Creates a MySQL adapter over mysql2.
MysqlOptions	interface	The options of {@link mysql }.
MysqlPoolOptions	interface	Pool settings for the pool the adapter creates.
VERSION	constant	The version of the @egon-orm/mysql package.

@egon-orm/zod

Export	Kind	Summary
castWith	function	Casts params with the keys of a Zod object schema as the permitted fields, then validates the changeset with that schema.
toZod	function	Derives a Zod object schema from a schema class.
ToZodKeys	type	The field names toZod can pick from in a mode.
ToZodMode	type	Which shape toZod derives.
ToZodOptions	interface	Options of toZod.
ToZodShape	type	The shape of the Zod object toZod returns.
VERSION	constant	The version of the @egon-orm/zod package.
ZodHint	interface	The hint a custom type gives toZod.

@egon-orm/cli

Export	Kind	Summary
CliIo	interface	What the CLI talks to.
defineConfig	function	Types a configuration object; returns it unchanged.
EgonConfig	interface	What egon.config.ts exports (as its default export, or as config).
MigrationsConfig	type	Where the migrations are and how they are tracked.
run	function	Runs egon with argv (the arguments after the program name) and returns the exit code.
VERSION	constant	The version of the @egon-orm/cli package.