Deprecated enableExtension for Knex.js and Objection.js (use createEx…

…tensionIfNotExists instead)
pgvector · Aug 3, 2024 · 0e01cc9 · 0e01cc9
1 parent 74ceb9d
commit 0e01cc9
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.2.1 (unreleased)
+
+- Deprecated `enableExtension` for Knex.js and Objection.js (use `createExtensionIfNotExists` instead)
+
 ## 0.2.0 (2024-06-27)
 
 - Added support for `halfvec` and `sparsevec` types to node-postgres

diff --git a/src/knex/index.js b/src/knex/index.js
@@ -1,9 +1,10 @@
 const knex = require('knex');
+const util = require('node:util');
 const { fromSql, toSql, vectorType, halfvecType, sparsevecType } = require('../utils');
 
-knex.SchemaBuilder.extend('enableExtension', function (name) {
+knex.SchemaBuilder.extend('enableExtension', util.deprecate(function (name) {
  return this.raw('CREATE EXTENSION IF NOT EXISTS ??', [name]);
-});
+}, 'enableExtension() is deprecated. Use createExtensionIfNotExists() instead.'));
 
 knex.TableBuilder.extend('vector', function (name, options) {
  const dimensions = options && (Number.isInteger(options) ? options : options.dimensions);

diff --git a/tests/knex.test.mjs b/tests/knex.test.mjs
@@ -10,7 +10,7 @@ test('knex example', async () => {
  connection: {database: 'pgvector_node_test'}
  });
 
- await knex.schema.createExtensionIfNotExists('vector');
+ await knex.schema.enableExtension('vector');
  await knex.schema.dropTableIfExists('knex_items');
  await knex.schema.createTable('knex_items', (table) => {
  table.increments('id');