indexes-test.ts

import { expect } from 'chai'
import * as Indexes from '../src/operations/indexes'
import { options1, options2 } from './utils'

type CreateIndexParams = Parameters<ReturnType<typeof Indexes.createIndex>>

describe('src/operations/indexes', () => {
  describe('.create', () => {
    it('check schema not included in index name', () => {
      const args: CreateIndexParams = [{ schema: 'mySchema', name: 'myTable' }, ['colA', 'colB']]
      const sql1 = Indexes.createIndex(options1)(...args)
      const sql2 = Indexes.createIndex(options2)(...args)
      expect(sql1).to.equal('CREATE INDEX "myTable_colA_colB_index" ON "mySchema"."myTable" ("colA", "colB");')
      expect(sql2).to.equal('CREATE INDEX "my_table_col_a_col_b_index" ON "my_schema"."my_table" ("col_a", "col_b");')
    })

    it('add opclass option (deprecated)', () => {
      const args: CreateIndexParams = [
        'xTable',
        ['yName'],
        {
          method: 'gist',
          name: 'zIndex',
          opclass: 'someOpclass',
          where: 'some condition',
        },
      ]
      const sql1 = Indexes.createIndex(options1)(...args)
      const sql2 = Indexes.createIndex(options2)(...args)
      expect(sql1).to.equal(
        'CREATE INDEX "zIndex" ON "xTable" USING gist ("yName" "someOpclass") WHERE some condition;',
      )
      expect(sql2).to.equal(
        'CREATE INDEX "z_index" ON "x_table" USING gist ("y_name" "some_opclass") WHERE some condition;',
      )
    })

    it('add opclass option', () => {
      const args: CreateIndexParams = [
        'xTable',
        [{ name: 'yName', opclass: { schema: 'someSchema', name: 'someOpclass' } }],
        {
          method: 'gist',
          name: 'zIndex',
          where: 'some condition',
        },
      ]
      const sql1 = Indexes.createIndex(options1)(...args)
      const sql2 = Indexes.createIndex(options2)(...args)
      expect(sql1).to.equal(
        'CREATE INDEX "zIndex" ON "xTable" USING gist ("yName" "someSchema"."someOpclass") WHERE some condition;',
      )
      expect(sql2).to.equal(
        'CREATE INDEX "z_index" ON "x_table" USING gist ("y_name" "some_schema"."some_opclass") WHERE some condition;',
      )
    })

    it('add sort option', () => {
      const args: CreateIndexParams = [
        'xTable',
        [{ name: 'yName', sort: 'DESC' }],
        {
          method: 'gist',
          name: 'zIndex',
          where: 'some condition',
        },
      ]
      const sql1 = Indexes.createIndex(options1)(...args)
      const sql2 = Indexes.createIndex(options2)(...args)
      expect(sql1).to.equal('CREATE INDEX "zIndex" ON "xTable" USING gist ("yName" DESC) WHERE some condition;')
      expect(sql2).to.equal('CREATE INDEX "z_index" ON "x_table" USING gist ("y_name" DESC) WHERE some condition;')
    })

    it('add include option', () => {
      const args: CreateIndexParams = ['xTable', ['yName'], { name: 'zIndex', include: 'someOtherColumn' }]
      const sql1 = Indexes.createIndex(options1)(...args)
      const sql2 = Indexes.createIndex(options2)(...args)
      expect(sql1).to.equal('CREATE INDEX "zIndex" ON "xTable" ("yName") INCLUDE ("someOtherColumn");')
      expect(sql2).to.equal('CREATE INDEX "z_index" ON "x_table" ("y_name") INCLUDE ("some_other_column");')
    })
  })
})