如何使用Knex.js添加GIN索引

时间:2017-08-24 21:53:51

标签: javascript node.js postgresql knex.js

我一直在尝试使用Knex.js在我的表中的一列上添加GIN索引,但我无法实现这一点。我想做这样的事情 -

exports.up = function(knex, Promise) {
    return knex.schema.createTable('prediction_models', function(table){
            table.increments('id');
            table.string('model_name').index();
            table.jsonb('model_params');
            table.timestamp('createdAt').defaultTo(knex.fn.now());
        })
        .then(createGinIndex());

    function createGinIndex() {
        return knex.raw('CREATE INDEX modelgin ON public.prediction_models USING GIN (model_params);');
    }
};

exports.down = function(knex, Promise) {
    return knex.schema.dropTable('prediction_models');
};

我正在使用PostgreSQL数据库。任何人都可以告诉我,这是否是正确的实现方式?如果是的话我的代码有什么问题,如果不是如何实现呢?谢谢!

2 个答案:

答案 0 :(得分:3)

那些寻求更“笨拙”解决这个问题的人:没有必要使用.raw,就像MikaelLepistö的解决方案一样。 .index chainable接受名为indexType的第二个参数。它可以像这样使用:

knex.schema.createTable('table_name', table => {
  table.jsonb('column_name').index(null, 'GIN')
})

(第一个参数的null是我说“为我命名这个索引”)

这段代码将产生以下查询:

create table "table_name" ("column_name" jsonb);
create index "table_name_column_name_index" on "table_name" using GIN ("column_name")

目前我正在创建这样一个索引,但出于性能原因,我希望它只支持jsonb_path_ops运算符类(根据section 8.14.4 of the documentation)。这需要以create index结尾的using GIN ("column_name" jsonb_path_ops)语句。因此,我需要使用raw,但有很多用例.index就足够了。

答案 1 :(得分:0)

您应该能够像这样创建完整的GIN索引:

var knex = require("knex")({ client: 'pg' });
const queries = knex.schema.createTable('prediction_models', function (table){
    table.increments('id');
    table.string('model_name').index();
    table.jsonb('model_params');
    table.timestamp('createdAt').defaultTo(knex.fn.now());
}).raw('CREATE INDEX on prediction_models USING GIN (model_params)')
.toSQL();

queries.forEach(toSql => console.log(toSql.sql));

有关为jsonb列创建索引的更多信息,请参阅https://www.vincit.fi/en/blog/objection-js-postgresql-power-json-queries/

的末尾

您可以打印出这样的迁移运行的查询(http://runkit.com/embed/8fm3z9xzjz9b):

mikaelle=# begin;
BEGIN
mikaelle=# create table "prediction_models" ("id" serial primary key, "model_name" varchar(255), "model_params" jsonb, "createdAt" timestamptz default CURRENT_TIMESTAMP);
CREATE TABLE
mikaelle=# create index "prediction_models_model_name_index" on "prediction_models" ("model_name");
CREATE INDEX
mikaelle=# CREATE INDEX on prediction_models USING GIN (model_params);
CREATE INDEX
mikaelle=# commit;
COMMIT
mikaelle=#
mikaelle=# \d prediction_models
                                     Table "public.prediction_models"
    Column    |           Type           |                           Modifiers                            
--------------+--------------------------+----------------------------------------------------------------
 id           | integer                  | not null default nextval('prediction_models_id_seq'::regclass)
 model_name   | character varying(255)   | 
 model_params | jsonb                    | 
 createdAt    | timestamp with time zone | default now()
Indexes:
    "prediction_models_pkey" PRIMARY KEY, btree (id)
    "prediction_models_model_name_index" btree (model_name)
    "prediction_models_model_params_idx" gin (model_params)

mikaelle=# 

将它们复制粘贴到psql:

ORDER