@vertz/db 0.2.11 → 0.2.13

package/README.md

@@ -82,8 +82,7 @@ d.textArray()               // TEXT[] → string[]
 d.integerArray()            // INTEGER[] → number[]
 d.enum('status', ['active', 'inactive'])  // ENUM → 'active' | 'inactive'
 
-// Multi-tenancy
-d.tenant(orgsTable)         // UUID FK to tenant root → string
+// Multi-tenancy — see d.model() options below
 ```
 
 ### Column Modifiers
@@ -131,6 +130,64 @@ const users = d.table('users', {
 });
 ```
 
+### Indexes
+
+Define indexes on tables via the `indexes` option:
+
+```typescript
+const posts = d.table('posts', {
+  id: d.uuid().primary(),
+  title: d.text(),
+  status: d.text(),
+  authorId: d.uuid(),
+}, {
+  indexes: [
+    d.index('title'),                          // basic index
+    d.index('authorId', { unique: true }),      // unique index
+    d.index(['status', 'authorId']),            // composite index
+  ],
+});
+```
+
+#### Index Types (PostgreSQL)
+
+PostgreSQL supports multiple index types via the `type` option. The default is `btree`.
+
+```typescript
+d.index('title', { type: 'gin' })    // GIN — full-text search, arrays, JSONB
+d.index('location', { type: 'gist' }) // GiST — geometric/spatial data
+d.index('email', { type: 'hash' })   // Hash — equality-only lookups
+d.index('created_at', { type: 'brin' }) // BRIN — large sorted datasets
+d.index('name', { type: 'btree' })   // B-tree (default)
+```
+
+Available types: `'btree' | 'hash' | 'gin' | 'gist' | 'brin'`
+
+When targeting SQLite, non-btree index types are silently ignored (SQLite only supports B-tree). A console warning is emitted during migration generation.
+
+#### Partial Indexes
+
+Use the `where` option to create partial indexes that only index rows matching a condition:
+
+```typescript
+d.index('email', {
+  unique: true,
+  where: "status = 'active'",
+})
+// SQL: CREATE UNIQUE INDEX ... ON ... ("email") WHERE status = 'active';
+```
+
+Partial indexes are supported on both PostgreSQL and SQLite.
+
+#### Index Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `unique` | `boolean` | Create a UNIQUE index |
+| `type` | `IndexType` | Index type — PostgreSQL only (`btree`, `hash`, `gin`, `gist`, `brin`) |
+| `where` | `string` | WHERE clause for partial indexes |
+| `name` | `string` | Custom index name (auto-generated if omitted) |
+
 ### Annotations
 
 Column annotations control visibility and mutability across the stack:
@@ -476,11 +533,15 @@ const orgsTable = d.table('organizations', {
 const usersTable = d.table('users', {
   id: d.uuid().primary(),
   email: d.email(),
-  orgId: d.tenant(orgsTable),  // scopes this table to a tenant
+  orgId: d.uuid(),
 });
 
 const orgsModel = d.model(orgsTable);
-const usersModel = d.model(usersTable);
+const usersModel = d.model(
+  usersTable,
+  { organization: d.ref.one(() => orgsTable, 'orgId') },
+  { tenant: 'organization' },  // scopes this model to a tenant via relation
+);
 
 const tenantGraph = computeTenantGraph({ organizations: orgsModel, users: usersModel });
 

package/dist/d1/index.d.ts

@@ -32,11 +32,6 @@ interface ColumnMetadata {
 	readonly _annotations: Record<string, true>;
 	readonly isReadOnly: boolean;
 	readonly isAutoUpdate: boolean;
-	readonly isTenant: boolean;
-	readonly references: {
-		readonly table: string;
-		readonly column: string;
-	} | null;
 	readonly check: string | null;
 	readonly defaultValue?: unknown;
 	readonly format?: string;
@@ -87,18 +82,15 @@ interface ColumnBuilder<
 	check(sql: string): ColumnBuilder<TType, Omit<TMeta, "check"> & {
 		readonly check: string;
 	}>;
-	references(table: string, column?: string): ColumnBuilder<TType, Omit<TMeta, "references"> & {
-		readonly references: {
-			readonly table: string;
-			readonly column: string;
-		};
-	}>;
 }
 type InferColumnType<C> = C extends ColumnBuilder<infer T, ColumnMetadata> ? T : never;
+type IndexType = "btree" | "hash" | "gin" | "gist" | "brin";
 interface IndexDef {
 	readonly columns: readonly string[];
 	readonly name?: string;
 	readonly unique?: boolean;
+	readonly type?: IndexType;
+	readonly where?: string;
 }
 /** A record of column builders -- the shape passed to d.table(). */
 type ColumnRecord = Record<string, ColumnBuilder<unknown, ColumnMetadata>>;

package/dist/d1/index.js

@@ -1,7 +1,7 @@
 import {
   createD1Adapter,
   createD1Driver
-} from "../shared/chunk-pnk6yzjv.js";
+} from "../shared/chunk-ndxe1h28.js";
 export {
   createD1Driver,
   createD1Adapter

package/dist/index.d.ts

@@ -72,11 +72,6 @@ interface ColumnMetadata {
 	readonly _annotations: Record<string, true>;
 	readonly isReadOnly: boolean;
 	readonly isAutoUpdate: boolean;
-	readonly isTenant: boolean;
-	readonly references: {
-		readonly table: string;
-		readonly column: string;
-	} | null;
 	readonly check: string | null;
 	readonly defaultValue?: unknown;
 	readonly format?: string;
@@ -127,12 +122,6 @@ interface ColumnBuilder<
 	check(sql: string): ColumnBuilder<TType, Omit<TMeta, "check"> & {
 		readonly check: string;
 	}>;
-	references(table: string, column?: string): ColumnBuilder<TType, Omit<TMeta, "references"> & {
-		readonly references: {
-			readonly table: string;
-			readonly column: string;
-		};
-	}>;
 }
 type InferColumnType<C> = C extends ColumnBuilder<infer T, ColumnMetadata> ? T : never;
 type DefaultMeta<TSqlType extends string> = {
@@ -144,8 +133,6 @@ type DefaultMeta<TSqlType extends string> = {
 	readonly _annotations: {};
 	readonly isReadOnly: false;
 	readonly isAutoUpdate: false;
-	readonly isTenant: false;
-	readonly references: null;
 	readonly check: null;
 };
 /** Metadata for varchar columns — carries the length constraint. */
@@ -184,24 +171,6 @@ type SerialMeta = {
 	readonly _annotations: {};
 	readonly isReadOnly: false;
 	readonly isAutoUpdate: false;
-	readonly isTenant: false;
-	readonly references: null;
-	readonly check: null;
-};
-type TenantMeta = {
-	readonly sqlType: "uuid";
-	readonly primary: false;
-	readonly unique: false;
-	readonly nullable: false;
-	readonly hasDefault: false;
-	readonly _annotations: {};
-	readonly isReadOnly: false;
-	readonly isAutoUpdate: false;
-	readonly isTenant: true;
-	readonly references: {
-		readonly table: string;
-		readonly column: string;
-	};
 	readonly check: null;
 };
 interface ThroughDef<TJoin extends TableDef<ColumnRecord> = TableDef<ColumnRecord>> {
@@ -221,10 +190,19 @@ interface RelationDef<
 interface ManyRelationDef<TTarget extends TableDef<ColumnRecord> = TableDef<ColumnRecord>> extends RelationDef<TTarget, "many"> {
 	through<TJoin extends TableDef<ColumnRecord>>(joinTable: () => TJoin, thisKey: string, thatKey: string): RelationDef<TTarget, "many">;
 }
+type IndexType = "btree" | "hash" | "gin" | "gist" | "brin";
 interface IndexDef {
 	readonly columns: readonly string[];
 	readonly name?: string;
 	readonly unique?: boolean;
+	readonly type?: IndexType;
+	readonly where?: string;
+}
+interface IndexOptions {
+	name?: string;
+	unique?: boolean;
+	type?: IndexType;
+	where?: string;
 }
 /** A record of column builders -- the shape passed to d.table(). */
 type ColumnRecord = Record<string, ColumnBuilder<unknown, ColumnMetadata>>;
@@ -906,30 +884,34 @@ interface D1PreparedStatement2 {
 	}>;
 }
 interface TenantGraph {
-	/** The tenant root table name (e.g., "organizations"). Null if no tenant columns exist. */
+	/** The tenant root table key (e.g., "organizations"). Null if no tenant declarations exist. */
 	readonly root: string | null;
-	/** Tables with a direct d.tenant() column pointing to the root. */
+	/** Model keys with a direct { tenant } declaration pointing to the root. */
 	readonly directlyScoped: readonly string[];
-	/** Tables reachable from directly scoped tables via .references() chains. */
+	/** Model keys reachable from scoped models via relation chains. */
 	readonly indirectlyScoped: readonly string[];
-	/** Tables marked with .shared(). */
+	/** Model keys whose tables are marked with .shared(). */
 	readonly shared: readonly string[];
 }
-interface TableRegistryEntry {
+interface ModelRegistryEntry {
 	readonly table: TableDef<ColumnRecord>;
-	readonly relations: Record<string, unknown>;
+	readonly relations: Record<string, RelationDef>;
+	readonly _tenant?: string | null;
 }
-type TableRegistry = Record<string, TableRegistryEntry>;
+type ModelRegistry = Record<string, ModelRegistryEntry>;
 /**
-* Analyzes a table registry to compute the tenant scoping graph.
+* Analyzes a model registry to compute the tenant scoping graph.
 *
-* 1. Finds the tenant root — the table that tenant columns point to.
-* 2. Classifies tables as directly scoped (has d.tenant()), indirectly scoped
-*    (references a scoped table via .references()), or shared (.shared()).
-* 3. Tables that are none of the above are unscoped — the caller should
+* Fully relation-derived — reads _tenant from model options and follows
+* relation chains for indirect scoping. Does NOT scan column metadata.
+*
+* 1. Finds the tenant root — the table that tenant relations point to.
+* 2. Classifies models as directly scoped (has { tenant } option),
+*    indirectly scoped (has a relation to a scoped model), or shared (.shared()).
+* 3. Models that are none of the above are unscoped — the caller should
 *    log a notice for those.
 */
-declare function computeTenantGraph(registry: TableRegistry): TenantGraph;
+declare function computeTenantGraph(registry: ModelRegistry): TenantGraph;
 interface PoolConfig {
 	/** Maximum number of connections in the pool. */
 	readonly max?: number;
@@ -1124,8 +1106,8 @@ type DatabaseClient<TModels extends Record<string, ModelEntry>> = { readonly [K
 * Each model in the registry becomes a property on the returned client
 * with all CRUD methods typed for that specific model.
 *
-* Computes the tenant graph at creation time from d.tenant() metadata,
-* traversing references to find indirect tenant paths.
+* Computes the tenant graph at creation time from model-level { tenant }
+* options, traversing relations to find indirect tenant paths.
 * Logs notices for tables without tenant paths and not .shared().
 *
 * When `url` is provided and `_queryFn` is NOT provided, creates a real
@@ -1214,6 +1196,37 @@ declare function parseMigrationName(filename: string): {
 	timestamp: number;
 	name: string;
 } | null;
+interface SchemaLike<T> {
+	parse(value: unknown): {
+		ok: true;
+		data: T;
+	} | {
+		ok: false;
+		error: Error;
+	};
+}
+interface ModelSchemas<TTable extends TableDef<ColumnRecord>> {
+	readonly response: SchemaLike<TTable["$response"]>;
+	readonly createInput: SchemaLike<TTable["$create_input"]>;
+	readonly updateInput: SchemaLike<TTable["$update_input"]>;
+}
+interface ModelDef<
+	TTable extends TableDef<ColumnRecord> = TableDef<ColumnRecord>,
+	TRelations extends Record<string, RelationDef> = {}
+> {
+	readonly table: TTable;
+	readonly relations: TRelations;
+	readonly schemas: ModelSchemas<TTable>;
+	readonly _tenant: string | null;
+}
+interface ModelOptions<TRelations extends Record<string, RelationDef>> {
+	/**
+	* The relation that defines the tenant boundary for this model.
+	* Must reference a key in the relations record. The referenced relation's
+	* target table is the tenant root.
+	*/
+	readonly tenant?: Extract<keyof TRelations, string>;
+}
 interface ColumnSnapshot {
 	type: string;
 	nullable: boolean;
@@ -1226,6 +1239,8 @@ interface IndexSnapshot {
 	columns: string[];
 	name?: string;
 	unique?: boolean;
+	type?: IndexType;
+	where?: string;
 }
 interface ForeignKeySnapshot {
 	column: string;
@@ -1243,7 +1258,7 @@ interface SchemaSnapshot {
 	tables: Record<string, TableSnapshot>;
 	enums: Record<string, string[]>;
 }
-declare function createSnapshot(tables: TableDef<ColumnRecord>[]): SchemaSnapshot;
+declare function createSnapshot(entries: (TableDef<ColumnRecord> | ModelDef)[]): SchemaSnapshot;
 type ChangeType = "table_added" | "table_removed" | "column_added" | "column_removed" | "column_altered" | "column_renamed" | "index_added" | "index_removed" | "enum_added" | "enum_removed" | "enum_altered";
 interface CollisionInfo {
 	existingName: string;
@@ -1399,28 +1414,6 @@ interface PostgresDriver extends DbDriver {
 * @returns A PostgresDriver with queryFn, close(), and isHealthy()
 */
 declare function createPostgresDriver(url: string, pool?: PoolConfig): PostgresDriver;
-interface SchemaLike<T> {
-	parse(value: unknown): {
-		ok: true;
-		data: T;
-	} | {
-		ok: false;
-		error: Error;
-	};
-}
-interface ModelSchemas<TTable extends TableDef<ColumnRecord>> {
-	readonly response: SchemaLike<TTable["$response"]>;
-	readonly createInput: SchemaLike<TTable["$create_input"]>;
-	readonly updateInput: SchemaLike<TTable["$update_input"]>;
-}
-interface ModelDef<
-	TTable extends TableDef<ColumnRecord> = TableDef<ColumnRecord>,
-	TRelations extends Record<string, RelationDef> = {}
-> {
-	readonly table: TTable;
-	readonly relations: TRelations;
-	readonly schemas: ModelSchemas<TTable>;
-}
 interface EnumSchemaLike<T extends readonly string[]> {
 	readonly values: T;
 }
@@ -1455,9 +1448,8 @@ declare const d: {
 		TName extends string,
 		const TValues extends readonly [string, ...string[]]
 	>(name: TName, schema: EnumSchemaLike<TValues>): ColumnBuilder<TValues[number], EnumMeta<TName, TValues>>;
-	tenant(targetTable: TableDef<ColumnRecord>): ColumnBuilder<string, TenantMeta>;
 	table<TColumns extends ColumnRecord>(name: string, columns: TColumns, options?: TableOptions): TableDef<TColumns>;
-	index(columns: string | string[]): IndexDef;
+	index(columns: string | string[], options?: IndexOptions): IndexDef;
 	ref: {
 		one<TTarget extends TableDef<ColumnRecord>>(target: () => TTarget, foreignKey: string): RelationDef<TTarget, "one">;
 		many<TTarget extends TableDef<ColumnRecord>>(target: () => TTarget, foreignKey: string): RelationDef<TTarget, "many">;
@@ -1473,8 +1465,17 @@ declare const d: {
 		TTable extends TableDef<ColumnRecord>,
 		TRelations extends Record<string, RelationDef>
 	>(table: TTable, relations: TRelations): ModelDef<TTable, TRelations>;
+	model<
+		TTable extends TableDef<ColumnRecord>,
+		TRelations extends Record<string, RelationDef>
+	>(table: TTable, relations: TRelations, options: ModelOptions<TRelations>): ModelDef<TTable, TRelations>;
 };
 /**
+* Validate index definitions against a target dialect.
+* Returns warning messages for unsupported features.
+*/
+declare function validateIndexes(tables: Record<string, TableSnapshot>, dialect: "postgres" | "sqlite"): string[];
+/**
 * Convenience utility for creating a frozen bag of annotation constants.
 *
 * Usage:
@@ -1654,4 +1655,4 @@ type StrictKeys<
 	TAllowed extends string,
 	TTable extends string
 > = TRecord extends Record<string, unknown> ? { [K in keyof TRecord] : K extends TAllowed ? TRecord[K] : InvalidColumn<K & string, TTable> } : TRecord;
-export { toWriteError, toReadError, resolveErrorCode, reset, push, parsePgError, parseMigrationName, migrateStatus, migrateDev, migrateDeploy, generateId, formatDiagnostic, explainError, diagnoseError, detectSchemaDrift, defineAnnotations, defaultSqliteDialect, defaultPostgresDialect, dbErrorToHttpError, d, createSqliteDriver2 as createSqliteDriver, createSqliteAdapter, createSnapshot, createRegistry, createPostgresDriver, createEnumRegistry, createDb, createDatabaseBridgeAdapter, createD1Driver, createD1Adapter, computeTenantGraph, baseline, WriteError, VarcharMeta, ValidateKeys, UpdateInput, UniqueConstraintErrorOptions, UniqueConstraintError, TenantMeta, TenantGraph, TableDef, StrictKeys, SqliteDialect, SqliteAdapterOptions, SelectOption, SelectNarrow, SchemaSnapshot, SchemaLike, ResetResult, ResetOptions, RenameSuggestion, RelationDef, RegisteredEnum, ReadError, QueryResult, PushResult, PushOptions, PostgresDriver, PostgresDialect, PoolConfig, PgErrorInput, PgCodeToName, OrderByType, NotNullErrorOptions, NotNullError, NotFoundError, ModelSchemas, ModelEntry, ModelDelegate, ModelDef, MixedSelectError, MigrationQueryFn, MigrationInfo, MigrationFile, MigrationError2 as MigrationError, MigrateStatusResult, MigrateStatusOptions, MigrateDevResult, MigrateDevOptions, MigrateDeployResult, MigrateDeployOptions, ListOptions, JsonbValidator, InvalidRelation, InvalidFilterType, InvalidColumn, InsertInput, InferColumnType, IndexDef, IncludeResolve, IncludeOption, HttpErrorResponse, FormatMeta, ForeignKeyErrorOptions, ForeignKeyError, FindResult, FindOptions, FilterType, EnumMeta, EntityDbAdapter, DriftEntry, Dialect, DiagnosticResult, DecimalMeta, DbQueryError, DbNotFoundError, DbErrorJson, DbErrorCodeValue, DbErrorCodeName, DbErrorCode, DbErrorBase, DbError, DbDriver, DbConstraintError, DbConnectionError, DatabaseInternals, DatabaseClient, Database, D1PreparedStatement, D1DatabaseBinding, D1AdapterOptions, CreateDbOptions, ConnectionPoolExhaustedError, ConnectionError, ColumnTypeMeta, ColumnMetadata, ColumnBuilder, CodeChange, CheckConstraintErrorOptions, CheckConstraintError, BaselineResult, BaselineOptions };
+export { validateIndexes, toWriteError, toReadError, resolveErrorCode, reset, push, parsePgError, parseMigrationName, migrateStatus, migrateDev, migrateDeploy, generateId, formatDiagnostic, explainError, diagnoseError, detectSchemaDrift, defineAnnotations, defaultSqliteDialect, defaultPostgresDialect, dbErrorToHttpError, d, createSqliteDriver2 as createSqliteDriver, createSqliteAdapter, createSnapshot, createRegistry, createPostgresDriver, createEnumRegistry, createDb, createDatabaseBridgeAdapter, createD1Driver, createD1Adapter, computeTenantGraph, baseline, WriteError, VarcharMeta, ValidateKeys, UpdateInput, UniqueConstraintErrorOptions, UniqueConstraintError, TenantGraph, TableDef, StrictKeys, SqliteDialect, SqliteAdapterOptions, SelectOption, SelectNarrow, SchemaSnapshot, SchemaLike, ResetResult, ResetOptions, RenameSuggestion, RelationDef, RegisteredEnum, ReadError, QueryResult, PushResult, PushOptions, PostgresDriver, PostgresDialect, PoolConfig, PgErrorInput, PgCodeToName, OrderByType, NotNullErrorOptions, NotNullError, NotFoundError, ModelSchemas, ModelOptions, ModelEntry, ModelDelegate, ModelDef, MixedSelectError, MigrationQueryFn, MigrationInfo, MigrationFile, MigrationError2 as MigrationError, MigrateStatusResult, MigrateStatusOptions, MigrateDevResult, MigrateDevOptions, MigrateDeployResult, MigrateDeployOptions, ListOptions, JsonbValidator, InvalidRelation, InvalidFilterType, InvalidColumn, InsertInput, InferColumnType, IndexType, IndexOptions, IndexDef, IncludeResolve, IncludeOption, HttpErrorResponse, FormatMeta, ForeignKeyErrorOptions, ForeignKeyError, FindResult, FindOptions, FilterType, EnumMeta, EntityDbAdapter, DriftEntry, Dialect, DiagnosticResult, DecimalMeta, DbQueryError, DbNotFoundError, DbErrorJson, DbErrorCodeValue, DbErrorCodeName, DbErrorCode, DbErrorBase, DbError, DbDriver, DbConstraintError, DbConnectionError, DatabaseInternals, DatabaseClient, Database, D1PreparedStatement, D1DatabaseBinding, D1AdapterOptions, CreateDbOptions, ConnectionPoolExhaustedError, ConnectionError, ColumnTypeMeta, ColumnMetadata, ColumnBuilder, CodeChange, CheckConstraintErrorOptions, CheckConstraintError, BaselineResult, BaselineOptions };