feat(database): foundation — schema builder, plugin skeleton, connectors

.gitignore

@@ -11,3 +11,4 @@ coverage
 .turbo
 
 .databricks
+internal

docs/docs/api/appkit/Class.Plugin.md

@@ -208,12 +208,12 @@ Plugin initialization phase.
 ### abortActiveOperations()
 
 ```ts
-abortActiveOperations(): void;
+abortActiveOperations(): void | Promise<void>;
 ```
 
 #### Returns
 
-`void`
+`void` \| `Promise`\<`void`\>
 
 #### Implementation of
 

docs/docs/api/appkit/Function.bigint.md

@@ -0,0 +1,13 @@
+# Function: bigint()
+
+```ts
+function bigint(): AppKitColumnChain;
+```
+
+Create a bigint column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.boolean.md

@@ -0,0 +1,13 @@
+# Function: boolean()
+
+```ts
+function boolean(): AppKitColumnChain;
+```
+
+Create a boolean column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.defineSchema.md

@@ -0,0 +1,26 @@
+# Function: defineSchema()
+
+```ts
+function defineSchema<T>(build: (ctx: SchemaBuilderContext) => T, options: DefineSchemaOptions): Schema<T>;
+```
+
+Define a schema. This is used to build the schema for the database.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `Record`\<`string`, [`AppKitTable`](Interface.AppKitTable.md)\<`string`\>\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `build` | (`ctx`: [`SchemaBuilderContext`](Interface.SchemaBuilderContext.md)) => `T` | A function that builds the schema. |
+| `options` | [`DefineSchemaOptions`](Interface.DefineSchemaOptions.md) | Options for defining the schema. |
+
+## Returns
+
+[`Schema`](TypeAlias.Schema.md)\<`T`\>
+
+The defined schema.

docs/docs/api/appkit/Function.enumColumn.md

@@ -0,0 +1,20 @@
+# Function: enumColumn()
+
+```ts
+function enumColumn(name: string, values: readonly string[]): AppKitColumnChain;
+```
+
+Create an enum column.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `name` | `string` | The name of the enum. |
+| `values` | readonly `string`[] | The values of the enum. |
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.fk.md

@@ -0,0 +1,27 @@
+# Function: fk()
+
+```ts
+function fk(target: AppKitColumn): FkColumnChain;
+```
+
+Create a foreign key column. The reference target is captured live and
+resolved at `buildTable()` time, so forward references (e.g. `fk(other.id)`
+declared before `table("other", ...)`) work.
+
+The FK column type is currently fixed to `integer`. If the target is a
+`bigid()` (`bigserial`) or `uuid()` PK, declare the FK column with the
+matching type explicitly until per-target type inference is added.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `target` | [`AppKitColumn`](Interface.AppKitColumn.md) | The target column to reference. |
+
+## Returns
+
+[`FkColumnChain`](Interface.FkColumnChain.md)
+
+A FK column chain. `onDelete`/`onUpdate` return the FK chain so
+order does not matter; chain methods (`.notNull()`, `.unique()`, etc.) also
+return the FK chain so `.notNull().onDelete("cascade")` typechecks.

docs/docs/api/appkit/Function.id.md

@@ -0,0 +1,13 @@
+# Function: id()
+
+```ts
+function id(): AppKitColumnChain;
+```
+
+Create a primary key column with a serial type.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.integer.md

@@ -0,0 +1,13 @@
+# Function: integer()
+
+```ts
+function integer(): AppKitColumnChain;
+```
+
+Create an integer column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.isPrivateColumn.md

@@ -0,0 +1,18 @@
+# Function: isPrivateColumn()
+
+```ts
+function isPrivateColumn(table: AppKitTable, columnName: string): boolean;
+```
+
+Returns true if `columnName` is marked `.private()` on `table`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `table` | [`AppKitTable`](Interface.AppKitTable.md) |
+| `columnName` | `string` |
+
+## Returns
+
+`boolean`

docs/docs/api/appkit/Function.jsonb.md

@@ -0,0 +1,13 @@
+# Function: jsonb()
+
+```ts
+function jsonb(): AppKitColumnChain;
+```
+
+Create a jsonb column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.nonPrivateColumnNames.md

@@ -0,0 +1,17 @@
+# Function: nonPrivateColumnNames()
+
+```ts
+function nonPrivateColumnNames(table: AppKitTable): string[];
+```
+
+Returns the column names of `table` that are NOT marked `.private()`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `table` | [`AppKitTable`](Interface.AppKitTable.md) |
+
+## Returns
+
+`string`[]

docs/docs/api/appkit/Function.privateColumnNames.md

@@ -0,0 +1,17 @@
+# Function: privateColumnNames()
+
+```ts
+function privateColumnNames(table: AppKitTable): string[];
+```
+
+Returns the column names of `table` that ARE marked `.private()`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `table` | [`AppKitTable`](Interface.AppKitTable.md) |
+
+## Returns
+
+`string`[]

docs/docs/api/appkit/Function.text.md

@@ -0,0 +1,13 @@
+# Function: text()
+
+```ts
+function text(): AppKitColumnChain;
+```
+
+Create a text column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.timestamp.md

@@ -0,0 +1,13 @@
+# Function: timestamp()
+
+```ts
+function timestamp(): AppKitColumnChain;
+```
+
+Create a timestamp column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.uuid.md

@@ -0,0 +1,13 @@
+# Function: uuid()
+
+```ts
+function uuid(): AppKitColumnChain;
+```
+
+Create a uuid column.
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Function.varchar.md

@@ -0,0 +1,19 @@
+# Function: varchar()
+
+```ts
+function varchar(length: number): AppKitColumnChain;
+```
+
+Create a varchar column.
+
+## Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `length` | `number` | `255` | The length of the column. |
+
+## Returns
+
+[`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+The wrapped column chain.

docs/docs/api/appkit/Interface.AppKitColumn.md

@@ -0,0 +1,23 @@
+# Interface: AppKitColumn
+
+An AppKit column. This is returned by the column builder methods.
+
+## Extended by
+
+- [`AppKitColumnChain`](Interface.AppKitColumnChain.md)
+
+## Properties
+
+### $builder
+
+```ts
+$builder: unknown;
+```
+
+***
+
+### $meta
+
+```ts
+$meta: ColumnMeta;
+```