knex-schema-inspector

import knex, { Knex } from 'knex'; import { expect } from 'chai'; import schemaInspector from '../lib'; import { SchemaInspector } from '../lib/types/schema-inspector'; describe('postgres-no-search-path', () => { let database: Knex; let inspector: SchemaInspector; before(() => { database = knex({ client: 'pg', connection: { host: '127.0.0.1', port: 5101, user: 'postgres', password: 'secret', database: 'test_db', charset: 'utf8', }, }); inspector = schemaInspector(database); }); after(async () => { await database.destroy(); }); describe('.tables', () => { it('returns tables', async () => { expect(await inspector.tables()).to.have.deep.members([ 'teams', 'users', 'camelCase', 'page_visits', ]); }); }); describe('.tableInfo', () => { it('returns information for all tables', async () => { expect(await inspector.tableInfo()).to.have.deep.members([ { name: 'camelCase', schema: 'public', comment: null }, { name: 'page_visits', schema: 'public', comment: null }, { name: 'teams', schema: 'public', comment: 'Teams in competition' }, { name: 'users', schema: 'public', comment: null }, ]); }); it('returns information for specific table', async () => { expect(await inspector.tableInfo('teams')).to.deep.equal({ comment: 'Teams in competition', name: 'teams', schema: 'public', }); }); }); describe('.hasTable', () => { it('returns if table exists or not', async () => { expect(await inspector.hasTable('teams')).to.equal(true); expect(await inspector.hasTable('foobar')).to.equal(false); }); }); describe('.columns', () => { it('returns information for all tables', async () => { database.transaction(async (trx) => { expect(await schemaInspector(trx).columns()).to.have.deep.members([ { table: 'users', column: 'id' }, { table: 'page_visits', column: 'request_path' }, { table: 'users', column: 'password' }, { table: 'users', column: 'status' }, { table: 'camelCase', column: 'primaryKey' }, { table: 'users', column: 'email' }, { table: 'teams', column: 'uuid' }, { table: 'page_visits', column: 'created_at' }, { table: 'teams', column: 'credits' }, { table: 'teams', column: 'created_at' }, { table: 'teams', column: 'description' }, { table: 'teams', column: 'id' }, { table: 'page_visits', column: 'user_agent' }, { table: 'users', column: 'team_id' }, { table: 'teams', column: 'name' }, { table: 'teams', column: 'name_upper' }, { table: 'teams', column: 'activated_at' }, ]); }); expect(await inspector.columns()).to.have.deep.members([ { table: 'users', column: 'id' }, { table: 'page_visits', column: 'request_path' }, { table: 'users', column: 'password' }, { table: 'users', column: 'status' }, { table: 'camelCase', column: 'primaryKey' }, { table: 'users', column: 'email' }, { table: 'teams', column: 'uuid' }, { table: 'page_visits', column: 'created_at' }, { table: 'teams', column: 'credits' }, { table: 'teams', column: 'created_at' }, { table: 'teams', column: 'description' }, { table: 'teams', column: 'id' }, { table: 'page_visits', column: 'user_agent' }, { table: 'users', column: 'team_id' }, { table: 'teams', column: 'name' }, { table: 'teams', column: 'name_upper' }, { table: 'teams', column: 'activated_at' }, ]); }); it('returns information for specific table', async () => { expect(await inspector.columns('teams')).to.have.deep.members([ { table: 'teams', column: 'id' }, { table: 'teams', column: 'uuid' }, { table: 'teams', column: 'name' }, { table: 'teams', column: 'name_upper' }, { table: 'teams', column: 'description' }, { table: 'teams', column: 'credits' }, { table: 'teams', column: 'created_at' }, { table: 'teams', column: 'activated_at' }, ]); }); }); describe('.columnInfo', () => { it('returns information for all columns in all tables', async () => { expect(await inspector.columnInfo()).to.have.deep.members([ { name: 'primaryKey', table: 'camelCase', data_type: 'integer', default_value: 'nextval(\'"camelCase_primaryKey_seq"\'::regclass)', max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: true, has_auto_increment: true, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'request_path', table: 'page_visits', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'user_agent', table: 'page_visits', data_type: 'character varying', default_value: null, max_length: 200, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'created_at', table: 'page_visits', data_type: 'timestamp without time zone', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'id', table: 'teams', data_type: 'integer', default_value: "nextval('teams_id_seq'::regclass)", max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: true, has_auto_increment: true, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'uuid', table: 'teams', data_type: 'character', default_value: null, max_length: 36, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'name', table: 'teams', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'name_upper', table: 'teams', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: true, generation_expression: 'upper((name)::text)', is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'description', table: 'teams', data_type: 'text', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'credits', table: 'teams', data_type: 'integer', default_value: null, max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: 'Remaining usage credits', schema: 'public', foreign_key_schema: null, }, { name: 'created_at', table: 'teams', data_type: 'timestamp without time zone', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'activated_at', table: 'teams', data_type: 'date', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'id', table: 'users', data_type: 'integer', default_value: "nextval('users_id_seq'::regclass)", max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: true, has_auto_increment: true, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'team_id', table: 'users', data_type: 'integer', default_value: null, max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: false, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: 'id', foreign_key_table: 'teams', comment: null, schema: 'public', foreign_key_schema: 'public', }, { name: 'email', table: 'users', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'password', table: 'users', data_type: 'character varying', default_value: null, max_length: 60, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'status', table: 'users', data_type: 'character varying', default_value: 'active', max_length: 60, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, ]); }); it('returns information for all columns in specific table', async () => { expect(await inspector.columnInfo('teams')).to.have.deep.members([ { name: 'id', table: 'teams', data_type: 'integer', default_value: "nextval('teams_id_seq'::regclass)", max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: true, has_auto_increment: true, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'uuid', table: 'teams', data_type: 'character', default_value: null, max_length: 36, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'name', table: 'teams', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'name_upper', table: 'teams', data_type: 'character varying', default_value: null, max_length: 100, numeric_precision: null, numeric_scale: null, is_generated: true, generation_expression: 'upper((name)::text)', is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'description', table: 'teams', data_type: 'text', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'credits', table: 'teams', data_type: 'integer', default_value: null, max_length: null, numeric_precision: 32, numeric_scale: 0, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: 'Remaining usage credits', schema: 'public', foreign_key_schema: null, }, { name: 'created_at', table: 'teams', data_type: 'timestamp without time zone', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, { name: 'activated_at', table: 'teams', data_type: 'date', default_value: null, max_length: null, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: true, is_unique: false, is_primary_key: false, has_auto_increment: false, foreign_key_column: null, foreign_key_table: null, comment: null, schema: 'public', foreign_key_schema: null, }, ]); }); it('returns information for a specific column in a specific table', async () => { expect(await inspector.columnInfo('teams', 'uuid')).to.deep.equal({ schema: 'public', name: 'uuid', table: 'teams', data_type: 'character', default_value: null, max_length: 36, numeric_precision: null, numeric_scale: null, is_generated: false, generation_expression: null, is_nullable: false, is_unique: true, is_primary_key: false, has_auto_increment: false, foreign_key_schema: null, foreign_key_column: null, foreign_key_table: null, comment: null, }); }); }); describe('.primary', () => { it('returns primary key for a table', async () => { expect(await inspector.primary('users')).to.equal('id'); expect(await inspector.primary('page_visits')).to.equal(null); }); }); describe('.transaction', () => { it('works with transactions transaction', async () => { database.transaction(async (trx) => { expect(await schemaInspector(trx).primary('teams')).to.equal('id'); }); }); }); }); describe('postgres-with-search-path', () => { let database: Knex; let inspector: SchemaInspector; before(() => { database = knex({ searchPath: ['public', 'test'], client: 'pg', connection: { host: '127.0.0.1', port: 5101, user: 'postgres', password: 'secret', database: 'test_db', charset: 'utf8', }, }); inspector = schemaInspector(database); }); after(async () => { await database.destroy(); }); describe('.primary', () => { it('returns primary key for a table', async () => { expect(await inspector.primary('users')).to.equal('id'); }); }); describe('.transaction', () => { it('works with transactions transaction', async () => { database.transaction(async (trx) => { expect(await schemaInspector(trx).primary('test')).to.equal('id'); }); }); }); describe('.foreignKeys', () => { it('returns foreign keys for all tables', async () => { expect(await inspector.foreignKeys()).to.deep.equal([ { table: 'users', column: 'team_id', foreign_key_schema: 'public', foreign_key_table: 'teams', foreign_key_column: 'id', constraint_name: 'fk_team_id', on_delete: 'CASCADE', on_update: 'CASCADE', }, ]); }); it('filters based on table param', async () => { expect(await inspector.foreignKeys('teams')).to.deep.equal([]); }); }); });