API Map

This page maps the public exports from src/index.ts into practical groups.

Schema Definition Helpers

• column
• entity
• primaryKey
• foreignKey
• index

Use these to describe tables, columns, keys, and indexes in code.

Runtime Engines

• SqliteReflector
• PostgresReflector
• MySqlReflector

These are the main entry points for schema synchronization, query creation, and engine-specific operations.

SQLite, PostgreSQL, and MySQL are exported runtime engines in the current public API. SQL Server remains a documentation track for future support.

Query Builders

• SqliteQueryBuilder
• PostgresQueryBuilder
• MySqlQueryBuilder
• SqliteInsertBuilder
• SqliteUpdateBuilder
• SqliteDeleteBuilder
• PostgresInsertBuilder
• PostgresUpdateBuilder
• PostgresDeleteBuilder
• MySqlInsertBuilder
• MySqlUpdateBuilder
• MySqlDeleteBuilder
• SqliteStrictEntityQueryBuilder

Use these when you want fluent SQL while still controlling the final query shape.

Schema Inspection And Generation

• inspectSqliteSchema
• generateSqliteSchemaOutput
• inspectPostgresSchema
• generatePostgresSchemaOutput
• inspectMySqlSchema
• generateMySqlSchemaOutput

Use these when you need to reverse-engineer an existing database or generate entity classes.

Aggregation Utilities

• agg

Use this helper to build safe aggregate expressions such as COUNT, SUM, AVG, MIN, and MAX.

PostgreSQL Advanced Runtime Features

• StoreProcedure
• PostgreSQL trigger, view, transaction, and schema-preview types
• PostgreSQL destructive-change planning and dependency orchestration types

These are intended for procedural database logic, controlled runtime evolution, and dependency-aware rebuild flows.

MySQL Advanced Runtime Features

• MySqlStoreProcedure
• MySQL trigger, view, transaction, and schema-preview types
• MySQL destructive-change planning, dependency orchestration, history, and audit types

These cover MySQL runtime evolution, DML returning emulation, procedural objects, and dependency-aware rebuild flows.

Shared Types

The API reference also exposes shared types for:

• column definitions
• key definitions
• query values and join options
• inspector output shapes
• schema preview results
• audit and change-history payloads

If you are integrating this library into a larger system, those types are the right place to anchor wrappers, adapters, and tooling.