@prisma-next/extension-pgvector 0.1.0-dev.2 → 0.1.0-dev.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -2
- package/dist/exports/control.d.ts +3 -2
- package/dist/exports/control.js +49 -0
- package/dist/exports/control.js.map +1 -1
- package/package.json +19 -14
package/README.md
CHANGED
|
@@ -12,6 +12,7 @@ This extension pack adds support for the `vector` data type and vector similarit
|
|
|
12
12
|
- **Vector Operations**: Registers vector similarity operations (e.g., `cosineDistance`) for use in queries
|
|
13
13
|
- **CLI Integration**: Provides extension descriptor for `prisma-next.config.ts` configuration
|
|
14
14
|
- **Runtime Extension**: Registers codecs and operations at runtime for vector column operations
|
|
15
|
+
- **Database Dependencies**: Declares the `vector` Postgres extension as a database dependency, which the migration planner emits as a `CREATE EXTENSION IF NOT EXISTS vector` operation and the verifier checks against the schema IR
|
|
15
16
|
|
|
16
17
|
## Dependencies
|
|
17
18
|
|
|
@@ -28,12 +29,16 @@ pnpm add @prisma-next/extension-pgvector
|
|
|
28
29
|
|
|
29
30
|
## Database Setup
|
|
30
31
|
|
|
31
|
-
|
|
32
|
+
The pgvector extension declares its database requirements as component-owned database dependencies. When using the `prisma-next db init` command, the migration planner automatically includes a `CREATE EXTENSION IF NOT EXISTS vector` operation.
|
|
33
|
+
|
|
34
|
+
For manual database setup, ensure the pgvector extension is installed:
|
|
32
35
|
|
|
33
36
|
```sql
|
|
34
37
|
CREATE EXTENSION IF NOT EXISTS vector;
|
|
35
38
|
```
|
|
36
39
|
|
|
40
|
+
The verifier will check for the presence of the `vector` extension in your database schema and report an error if it's missing.
|
|
41
|
+
|
|
37
42
|
## Configuration
|
|
38
43
|
|
|
39
44
|
Add the extension to your `prisma-next.config.ts`:
|
|
@@ -42,7 +47,7 @@ Add the extension to your `prisma-next.config.ts`:
|
|
|
42
47
|
import { defineConfig } from '@prisma-next/cli/config-types';
|
|
43
48
|
import postgresAdapter from '@prisma-next/adapter-postgres/control';
|
|
44
49
|
import sql from '@prisma-next/family-sql/cli';
|
|
45
|
-
import postgres from '@prisma-next/
|
|
50
|
+
import postgres from '@prisma-next/target-postgres/control';
|
|
46
51
|
import pgvector from '@prisma-next/extension-pgvector/control';
|
|
47
52
|
|
|
48
53
|
export default defineConfig({
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { SqlControlExtensionDescriptor } from '@prisma-next/family-sql/control';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* pgvector extension descriptor for CLI config.
|
|
5
|
+
* Declares database dependencies for the 'vector' Postgres extension.
|
|
5
6
|
*/
|
|
6
|
-
declare const pgvectorExtensionDescriptor:
|
|
7
|
+
declare const pgvectorExtensionDescriptor: SqlControlExtensionDescriptor<'postgres'>;
|
|
7
8
|
|
|
8
9
|
export { pgvectorExtensionDescriptor as default };
|
package/dist/exports/control.js
CHANGED
|
@@ -35,6 +35,54 @@ function loadExtensionManifest() {
|
|
|
35
35
|
}
|
|
36
36
|
return result;
|
|
37
37
|
}
|
|
38
|
+
function verifyVectorExtensionInstalled(schema) {
|
|
39
|
+
if (!schema.extensions.includes("vector")) {
|
|
40
|
+
return [
|
|
41
|
+
{
|
|
42
|
+
kind: "extension_missing",
|
|
43
|
+
table: "",
|
|
44
|
+
message: 'Extension "vector" is missing from database (required by pgvector)'
|
|
45
|
+
}
|
|
46
|
+
];
|
|
47
|
+
}
|
|
48
|
+
return [];
|
|
49
|
+
}
|
|
50
|
+
var pgvectorDatabaseDependencies = {
|
|
51
|
+
init: [
|
|
52
|
+
{
|
|
53
|
+
id: "postgres.extension.vector",
|
|
54
|
+
label: "Enable vector extension",
|
|
55
|
+
install: [
|
|
56
|
+
{
|
|
57
|
+
id: "extension.vector",
|
|
58
|
+
label: 'Enable extension "vector"',
|
|
59
|
+
summary: "Ensures the vector extension is available for pgvector operations",
|
|
60
|
+
operationClass: "additive",
|
|
61
|
+
target: { id: "postgres" },
|
|
62
|
+
precheck: [
|
|
63
|
+
{
|
|
64
|
+
description: 'verify extension "vector" is not already enabled',
|
|
65
|
+
sql: "SELECT NOT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'vector')"
|
|
66
|
+
}
|
|
67
|
+
],
|
|
68
|
+
execute: [
|
|
69
|
+
{
|
|
70
|
+
description: 'create extension "vector"',
|
|
71
|
+
sql: "CREATE EXTENSION IF NOT EXISTS vector"
|
|
72
|
+
}
|
|
73
|
+
],
|
|
74
|
+
postcheck: [
|
|
75
|
+
{
|
|
76
|
+
description: 'confirm extension "vector" is enabled',
|
|
77
|
+
sql: "SELECT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'vector')"
|
|
78
|
+
}
|
|
79
|
+
]
|
|
80
|
+
}
|
|
81
|
+
],
|
|
82
|
+
verifyDatabaseDependencyInstalled: verifyVectorExtensionInstalled
|
|
83
|
+
}
|
|
84
|
+
]
|
|
85
|
+
};
|
|
38
86
|
var pgvectorExtensionDescriptor = {
|
|
39
87
|
kind: "extension",
|
|
40
88
|
familyId: "sql",
|
|
@@ -42,6 +90,7 @@ var pgvectorExtensionDescriptor = {
|
|
|
42
90
|
// pgvector is postgres-specific
|
|
43
91
|
id: "pgvector",
|
|
44
92
|
manifest: loadExtensionManifest(),
|
|
93
|
+
databaseDependencies: pgvectorDatabaseDependencies,
|
|
45
94
|
create: () => ({
|
|
46
95
|
familyId: "sql",
|
|
47
96
|
targetId: "postgres"
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/exports/control.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport type { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';\nimport type {
|
|
1
|
+
{"version":3,"sources":["../../src/exports/control.ts"],"sourcesContent":["import { readFileSync } from 'node:fs';\nimport { dirname, join } from 'node:path';\nimport { fileURLToPath } from 'node:url';\nimport type { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';\nimport type { SchemaIssue } from '@prisma-next/core-control-plane/types';\nimport type {\n ComponentDatabaseDependencies,\n SqlControlExtensionDescriptor,\n} from '@prisma-next/family-sql/control';\nimport type { SqlSchemaIR } from '@prisma-next/sql-schema-ir/types';\nimport { type } from 'arktype';\n\nconst __filename = fileURLToPath(import.meta.url);\nconst __dirname = dirname(__filename);\n\nconst TypesImportSpecSchema = type({\n package: 'string',\n named: 'string',\n alias: 'string',\n});\n\nconst ExtensionPackManifestSchema = type({\n id: 'string',\n version: 'string',\n 'targets?': type({ '[string]': type({ 'minVersion?': 'string' }) }),\n 'capabilities?': 'Record<string, unknown>',\n 'types?': type({\n 'codecTypes?': type({\n import: TypesImportSpecSchema,\n }),\n 'operationTypes?': type({\n import: TypesImportSpecSchema,\n }),\n }),\n 'operations?': 'unknown[]',\n});\n\n/**\n * Loads the extension pack manifest from packs/manifest.json.\n */\nfunction loadExtensionManifest(): ExtensionPackManifest {\n const manifestPath = join(__dirname, '../../packs/manifest.json');\n const manifestJson = JSON.parse(readFileSync(manifestPath, 'utf-8'));\n\n const result = ExtensionPackManifestSchema(manifestJson);\n if (result instanceof type.errors) {\n const messages = result.map((p: { message: string }) => p.message).join('; ');\n throw new Error(`Invalid extension manifest structure at ${manifestPath}: ${messages}`);\n }\n\n return result as ExtensionPackManifest;\n}\n\n/**\n * Pure verification hook: checks whether the 'vector' extension is installed\n * based on the in-memory schema IR (no DB I/O).\n */\nfunction verifyVectorExtensionInstalled(schema: SqlSchemaIR): readonly SchemaIssue[] {\n if (!schema.extensions.includes('vector')) {\n return [\n {\n kind: 'extension_missing',\n table: '',\n message: 'Extension \"vector\" is missing from database (required by pgvector)',\n },\n ];\n }\n return [];\n}\n\n/**\n * Database dependencies for the pgvector extension.\n * Declares the 'vector' Postgres extension as a required dependency.\n */\nconst pgvectorDatabaseDependencies: ComponentDatabaseDependencies<unknown> = {\n init: [\n {\n id: 'postgres.extension.vector',\n label: 'Enable vector extension',\n install: [\n {\n id: 'extension.vector',\n label: 'Enable extension \"vector\"',\n summary: 'Ensures the vector extension is available for pgvector operations',\n operationClass: 'additive',\n target: { id: 'postgres' },\n precheck: [\n {\n description: 'verify extension \"vector\" is not already enabled',\n sql: \"SELECT NOT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'vector')\",\n },\n ],\n execute: [\n {\n description: 'create extension \"vector\"',\n sql: 'CREATE EXTENSION IF NOT EXISTS vector',\n },\n ],\n postcheck: [\n {\n description: 'confirm extension \"vector\" is enabled',\n sql: \"SELECT EXISTS (SELECT 1 FROM pg_extension WHERE extname = 'vector')\",\n },\n ],\n },\n ],\n verifyDatabaseDependencyInstalled: verifyVectorExtensionInstalled,\n },\n ],\n};\n\n/**\n * pgvector extension descriptor for CLI config.\n * Declares database dependencies for the 'vector' Postgres extension.\n */\nconst pgvectorExtensionDescriptor: SqlControlExtensionDescriptor<'postgres'> = {\n kind: 'extension',\n familyId: 'sql',\n targetId: 'postgres', // pgvector is postgres-specific\n id: 'pgvector',\n manifest: loadExtensionManifest(),\n databaseDependencies: pgvectorDatabaseDependencies,\n create: () => ({\n familyId: 'sql' as const,\n targetId: 'postgres' as const,\n }),\n};\n\nexport default pgvectorExtensionDescriptor;\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,SAAS,SAAS,YAAY;AAC9B,SAAS,qBAAqB;AAQ9B,SAAS,YAAY;AAErB,IAAM,aAAa,cAAc,YAAY,GAAG;AAChD,IAAM,YAAY,QAAQ,UAAU;AAEpC,IAAM,wBAAwB,KAAK;AAAA,EACjC,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AACT,CAAC;AAED,IAAM,8BAA8B,KAAK;AAAA,EACvC,IAAI;AAAA,EACJ,SAAS;AAAA,EACT,YAAY,KAAK,EAAE,YAAY,KAAK,EAAE,eAAe,SAAS,CAAC,EAAE,CAAC;AAAA,EAClE,iBAAiB;AAAA,EACjB,UAAU,KAAK;AAAA,IACb,eAAe,KAAK;AAAA,MAClB,QAAQ;AAAA,IACV,CAAC;AAAA,IACD,mBAAmB,KAAK;AAAA,MACtB,QAAQ;AAAA,IACV,CAAC;AAAA,EACH,CAAC;AAAA,EACD,eAAe;AACjB,CAAC;AAKD,SAAS,wBAA+C;AACtD,QAAM,eAAe,KAAK,WAAW,2BAA2B;AAChE,QAAM,eAAe,KAAK,MAAM,aAAa,cAAc,OAAO,CAAC;AAEnE,QAAM,SAAS,4BAA4B,YAAY;AACvD,MAAI,kBAAkB,KAAK,QAAQ;AACjC,UAAM,WAAW,OAAO,IAAI,CAAC,MAA2B,EAAE,OAAO,EAAE,KAAK,IAAI;AAC5E,UAAM,IAAI,MAAM,2CAA2C,YAAY,KAAK,QAAQ,EAAE;AAAA,EACxF;AAEA,SAAO;AACT;AAMA,SAAS,+BAA+B,QAA6C;AACnF,MAAI,CAAC,OAAO,WAAW,SAAS,QAAQ,GAAG;AACzC,WAAO;AAAA,MACL;AAAA,QACE,MAAM;AAAA,QACN,OAAO;AAAA,QACP,SAAS;AAAA,MACX;AAAA,IACF;AAAA,EACF;AACA,SAAO,CAAC;AACV;AAMA,IAAM,+BAAuE;AAAA,EAC3E,MAAM;AAAA,IACJ;AAAA,MACE,IAAI;AAAA,MACJ,OAAO;AAAA,MACP,SAAS;AAAA,QACP;AAAA,UACE,IAAI;AAAA,UACJ,OAAO;AAAA,UACP,SAAS;AAAA,UACT,gBAAgB;AAAA,UAChB,QAAQ,EAAE,IAAI,WAAW;AAAA,UACzB,UAAU;AAAA,YACR;AAAA,cACE,aAAa;AAAA,cACb,KAAK;AAAA,YACP;AAAA,UACF;AAAA,UACA,SAAS;AAAA,YACP;AAAA,cACE,aAAa;AAAA,cACb,KAAK;AAAA,YACP;AAAA,UACF;AAAA,UACA,WAAW;AAAA,YACT;AAAA,cACE,aAAa;AAAA,cACb,KAAK;AAAA,YACP;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,MACA,mCAAmC;AAAA,IACrC;AAAA,EACF;AACF;AAMA,IAAM,8BAAyE;AAAA,EAC7E,MAAM;AAAA,EACN,UAAU;AAAA,EACV,UAAU;AAAA;AAAA,EACV,IAAI;AAAA,EACJ,UAAU,sBAAsB;AAAA,EAChC,sBAAsB;AAAA,EACtB,QAAQ,OAAO;AAAA,IACb,UAAU;AAAA,IACV,UAAU;AAAA,EACZ;AACF;AAEA,IAAO,kBAAQ;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,34 +1,37 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@prisma-next/extension-pgvector",
|
|
3
|
-
"version": "0.1.0-dev.
|
|
3
|
+
"version": "0.1.0-dev.20",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"arktype": "^2.0.0",
|
|
8
|
-
"@prisma-next/cli": "0.1.0-dev.
|
|
9
|
-
"@prisma-next/contract": "0.1.0-dev.
|
|
10
|
-
"@prisma-next/contract-authoring": "0.1.0-dev.
|
|
11
|
-
"@prisma-next/core-control-plane": "0.1.0-dev.
|
|
12
|
-
"@prisma-next/sql
|
|
13
|
-
"@prisma-next/sql-
|
|
14
|
-
"@prisma-next/sql-
|
|
8
|
+
"@prisma-next/cli": "0.1.0-dev.20",
|
|
9
|
+
"@prisma-next/contract": "0.1.0-dev.20",
|
|
10
|
+
"@prisma-next/contract-authoring": "0.1.0-dev.20",
|
|
11
|
+
"@prisma-next/core-control-plane": "0.1.0-dev.20",
|
|
12
|
+
"@prisma-next/family-sql": "0.1.0-dev.20",
|
|
13
|
+
"@prisma-next/sql-operations": "0.1.0-dev.20",
|
|
14
|
+
"@prisma-next/sql-relational-core": "0.1.0-dev.20",
|
|
15
|
+
"@prisma-next/sql-runtime": "0.1.0-dev.20",
|
|
16
|
+
"@prisma-next/sql-schema-ir": "0.1.0-dev.20"
|
|
15
17
|
},
|
|
16
18
|
"devDependencies": {
|
|
17
19
|
"tsup": "^8.3.0",
|
|
18
20
|
"typescript": "^5.9.3",
|
|
19
21
|
"vite-tsconfig-paths": "^5.1.4",
|
|
20
|
-
"vitest": "^
|
|
21
|
-
"@prisma-next/adapter-postgres": "0.1.0-dev.
|
|
22
|
-
"@prisma-next/operations": "0.1.0-dev.
|
|
23
|
-
"@prisma-next/sql-contract": "0.1.0-dev.
|
|
24
|
-
"@prisma-next/sql-contract-ts": "0.1.0-dev.
|
|
25
|
-
"@prisma-next/sql-lane": "0.1.0-dev.
|
|
22
|
+
"vitest": "^4.0.16",
|
|
23
|
+
"@prisma-next/adapter-postgres": "0.1.0-dev.20",
|
|
24
|
+
"@prisma-next/operations": "0.1.0-dev.20",
|
|
25
|
+
"@prisma-next/sql-contract": "0.1.0-dev.20",
|
|
26
|
+
"@prisma-next/sql-contract-ts": "0.1.0-dev.20",
|
|
27
|
+
"@prisma-next/sql-lane": "0.1.0-dev.20",
|
|
26
28
|
"@prisma-next/test-utils": "0.0.1"
|
|
27
29
|
},
|
|
28
30
|
"files": [
|
|
29
31
|
"dist"
|
|
30
32
|
],
|
|
31
33
|
"exports": {
|
|
34
|
+
"./package.json": "./package.json",
|
|
32
35
|
"./control": {
|
|
33
36
|
"types": "./dist/exports/control.d.ts",
|
|
34
37
|
"import": "./dist/exports/control.js"
|
|
@@ -56,6 +59,8 @@
|
|
|
56
59
|
"test:coverage": "vitest run --coverage",
|
|
57
60
|
"typecheck": "tsc --project tsconfig.json --noEmit",
|
|
58
61
|
"lint": "biome check . --config-path ../../../biome.json --error-on-warnings",
|
|
62
|
+
"lint:fix": "biome check --write . --config-path ../../../biome.json",
|
|
63
|
+
"lint:fix:unsafe": "biome check --write --unsafe . --config-path ../../../biome.json",
|
|
59
64
|
"clean": "node ../../../scripts/clean.mjs"
|
|
60
65
|
}
|
|
61
66
|
}
|