# db-semantic-planner

> The intent-first query planner

Declare what you want. The planner decides how. Then shows you why.

## Table of Contents

### Introduction

- [Getting Started](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/getting-started.md)
- [Why db-semantic-planner?](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/why-dbsp.md)

### Core Concepts

- [Schema Definition](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/schema.md)
- [Queries](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/queries.md)
- [Pagination](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/pagination.md): Four patterns for paginating queries with @dbsp/core — offset, cursor, streaming, and manual builder loops.
- [Relations & Includes](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/includes.md)
- [Result Hydration](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/result-hydration.md)
- [Mutations](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/mutations.md)
- [Transactions](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/transactions.md): What orm.transaction() guarantees, what it refuses, and what it cannot promise.
- [How to use raw SQL safely](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/raw-sql.md)
- [Observability](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/observability.md)

### Advanced

- [Expression Primitives](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/expression-primitives.md)
- [exists() vs rawExists()](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/exists-vs-rawexists.md)
- [Manual Joins](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/joins.md)
- [Set Operations](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/set-operations.md): Combine multiple query results with UNION, INTERSECT, and EXCEPT using the @dbsp/core set operation builders.
- [Subqueries](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/subqueries.md): IN subqueries, scalar subqueries in SELECT, and correlated EXISTS patterns with @dbsp/core subquery builders.
- [Recursive CTEs](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/recursive-cte.md)
- [Row-Level Locking](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/locking.md): Pessimistic concurrency control with FOR UPDATE, FOR SHARE, SKIP LOCKED, and NOWAIT in @dbsp/core.
- [CASE Expressions](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/case-expressions.md)
- [Window Functions](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/window-functions.md): Compute rankings, running totals, and lag/lead comparisons across result sets with @dbsp/core window function helpers.
- [Batch Values](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/batch-values.md)
- [Full-Text Search](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/full-text-search.md)
- [Range Operators](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/range-operators.md)
- [Extensions (pgvector + ParadeDB)](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/extensions.md)
- [JSONB Queries](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/jsonb.md): Query, filter, and aggregate JSONB columns in PostgreSQL using @dbsp/core expression primitives.

### Operations

- [DDL Helpers](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/ddl-helpers.md)
- [DDL Provisioning](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/ddl-provisioning.md)
- [Managed schema history](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/schema-versioning.md)
- [Row-Level Security Policies](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/rls-policies.md)
- [Multi-tenant Isolation](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/multi-tenant.md)
- [Production Deployment](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/production.md)
- [CLI Usage](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/cli-usage.md)

### Migration

- [Migrating from Prisma](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/migrating-from-prisma.md)
- [Migrating from Drizzle](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/migrating-from-drizzle.md)
- [Migrating from Kysely](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/guide/migrating-from-kysely.md)

### API

- [API Reference](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/api.md)
- [ORM API Reference](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/api/orm-api.md)

### NQL

- [NQL Reference](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/nql.md)

### Other

- [Architectural Patterns](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/patterns.md)
- [Feature Comparison](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/comparison.md)
- [Playground](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/playground.md)
- [Roadmap](https://oorabona.github.io/db-semantic-planner/db-semantic-planner/roadmap.md)