github/directus
1
0
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-01-23 21:18:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Move schema inspector in house

Browse Source
This commit is contained in:
rijkvanzanten
2020-11-09 11:27:23 -05:00
parent 427bd8564e
commit 651eef4878
6 changed files with 909 additions and 4442 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
packages/schema/.github/workflows/tests.yml vendored
View File

@@ -1,31 +0,0 @@
name: Tests
on: [push, pull_request]
defaults:
run:
shell: bash
jobs:
tests:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x]
steps:
- uses: actions/checkout@v2
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- run: docker-compose up -d
- run: npm ci
- run: "while ! docker-compose logs mysql | grep -q 'mysqld: ready for connections.'; do sleep 2; done"
- run: "while ! docker-compose logs postgres | grep -q 'database system is ready to accept connections'; do sleep 2; done"
- run: npm test

21
packages/schema/LICENSE
View File

@@ -1,21 +0,0 @@
MIT License
Copyright (c) 2020 knex
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

3476
packages/schema/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

3
packages/schema/package.json
View File

@@ -45,6 +45,9 @@
"ts-mocha": "^7.0.0",
"typescript": "^3.9.5"
},
"peerDependencies": {
"knex": "^0.21.12"
},
"dependencies": {
"lodash.flatten": "^4.4.0"
}

834
packages/schema/test/mysql.spec.ts
View File

@@ -1,436 +1,432 @@
import Knex from 'knex';
import { expect } from 'chai';
import schemaInspector from '../src';
import { SchemaInspector } from '../src/types/schema-inspector';
import schema from '../src';
import { Schema } from '../src/types/schema-inspector';
describe('mysql', () => {
let database: Knex;
let inspector: SchemaInspector;
let database: Knex;
let inspector: Schema;
before(() => {
database = Knex({
client: 'mysql',
connection: {
host: '127.0.0.1',
port: 5100,
user: 'root',
password: 'secret',
database: 'test_db',
charset: 'utf8',
},
});
inspector = schemaInspector(database);
});
before(() => {
database = Knex({
client: 'mysql',
connection: {
host: '127.0.0.1',
port: 5100,
user: 'root',
password: 'secret',
database: 'test_db',
charset: 'utf8',
},
});
inspector = schema(database);
});
after(async () => {
await database.destroy();
});
after(async () => {
await database.destroy();
});
describe('.tables', () => {
it('returns tables', async () => {
expect(await inspector.tables()).to.deep.equal([
'page_visits',
'teams',
'users',
]);
});
});
describe('.tables', () => {
it('returns tables', async () => {
expect(await inspector.tables()).to.deep.equal(['page_visits', 'teams', 'users']);
});
});
describe('.tableInfo', () => {
it('returns information for all tables', async () => {
expect(await inspector.tableInfo()).to.deep.equal([
{
name: 'page_visits',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
{
name: 'teams',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
{
name: 'users',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
]);
});
describe('.tableInfo', () => {
it('returns information for all tables', async () => {
expect(await inspector.tableInfo()).to.deep.equal([
{
name: 'page_visits',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
{
name: 'teams',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
{
name: 'users',
schema: 'test_db',
comment: '',
collation: 'latin1_swedish_ci',
engine: 'InnoDB',
},
]);
});
it('returns information for specific table', async () => {
expect(await inspector.tableInfo('teams')).to.deep.equal({
collation: 'latin1_swedish_ci',
comment: '',
engine: 'InnoDB',
name: 'teams',
schema: 'test_db',
});
});
});
it('returns information for specific table', async () => {
expect(await inspector.tableInfo('teams')).to.deep.equal({
collation: 'latin1_swedish_ci',
comment: '',
engine: 'InnoDB',
name: 'teams',
schema: 'test_db',
});
});
});
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('.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 () => {
expect(await inspector.columns()).to.deep.equal([
{ table: 'page_visits', column: 'request_path' },
{ table: 'page_visits', column: 'user_agent' },
{ table: 'page_visits', column: 'created_at' },
{ table: 'teams', column: 'id' },
{ table: 'teams', column: 'name' },
{ table: 'teams', column: 'description' },
{ table: 'teams', column: 'credits' },
{ table: 'teams', column: 'created_at' },
{ table: 'teams', column: 'activated_at' },
{ table: 'users', column: 'id' },
{ table: 'users', column: 'team_id' },
{ table: 'users', column: 'email' },
{ table: 'users', column: 'password' },
]);
});
describe('.columns', () => {
it('returns information for all tables', async () => {
expect(await inspector.columns()).to.deep.equal([
{ table: 'page_visits', column: 'request_path' },
{ table: 'page_visits', column: 'user_agent' },
{ table: 'page_visits', column: 'created_at' },
{ table: 'teams', column: 'id' },
{ table: 'teams', column: 'name' },
{ table: 'teams', column: 'description' },
{ table: 'teams', column: 'credits' },
{ table: 'teams', column: 'created_at' },
{ table: 'teams', column: 'activated_at' },
{ table: 'users', column: 'id' },
{ table: 'users', column: 'team_id' },
{ table: 'users', column: 'email' },
{ table: 'users', column: 'password' },
]);
});
it('returns information for specific table', async () => {
expect(await inspector.columns('teams')).to.deep.equal([
{ column: 'id', table: 'teams' },
{ column: 'name', table: 'teams' },
{ column: 'description', table: 'teams' },
{ column: 'credits', table: 'teams' },
{ column: 'created_at', table: 'teams' },
{ column: 'activated_at', table: 'teams' },
]);
});
});
it('returns information for specific table', async () => {
expect(await inspector.columns('teams')).to.deep.equal([
{ column: 'id', table: 'teams' },
{ column: 'name', table: 'teams' },
{ column: 'description', table: 'teams' },
{ column: 'credits', table: 'teams' },
{ column: 'created_at', table: 'teams' },
{ column: 'activated_at', table: 'teams' },
]);
});
});
describe('.columnInfo', () => {
it('returns information for all columns in all tables', async () => {
expect(await inspector.columnInfo()).to.deep.equal([
{
name: 'team_id',
table: 'users',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: 'id',
foreign_key_table: 'teams',
comment: '',
},
{
name: 'id',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'id',
table: 'users',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'request_path',
table: 'page_visits',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'user_agent',
table: 'page_visits',
type: 'varchar',
default_value: null,
max_length: 200,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'created_at',
table: 'page_visits',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'description',
table: 'teams',
type: 'text',
default_value: null,
max_length: 65535,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'credits',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: 'Remaining usage credits',
},
{
name: 'created_at',
table: 'teams',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'activated_at',
table: 'teams',
type: 'date',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'email',
table: 'users',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'password',
table: 'users',
type: 'varchar',
default_value: null,
max_length: 60,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
]);
});
describe('.columnInfo', () => {
it('returns information for all columns in all tables', async () => {
expect(await inspector.columnInfo()).to.deep.equal([
{
name: 'team_id',
table: 'users',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: 'id',
foreign_key_table: 'teams',
comment: '',
},
{
name: 'id',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'id',
table: 'users',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'request_path',
table: 'page_visits',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'user_agent',
table: 'page_visits',
type: 'varchar',
default_value: null,
max_length: 200,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'created_at',
table: 'page_visits',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'description',
table: 'teams',
type: 'text',
default_value: null,
max_length: 65535,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'credits',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: 'Remaining usage credits',
},
{
name: 'created_at',
table: 'teams',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'activated_at',
table: 'teams',
type: 'date',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'email',
table: 'users',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'password',
table: 'users',
type: 'varchar',
default_value: null,
max_length: 60,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
]);
});
it('returns information for all columns in specific table', async () => {
expect(await inspector.columnInfo('teams')).to.deep.equal([
{
name: 'id',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'description',
table: 'teams',
type: 'text',
default_value: null,
max_length: 65535,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'credits',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: 'Remaining usage credits',
},
{
name: 'created_at',
table: 'teams',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'activated_at',
table: 'teams',
type: 'date',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
]);
});
it('returns information for all columns in specific table', async () => {
expect(await inspector.columnInfo('teams')).to.deep.equal([
{
name: 'id',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: false,
is_primary_key: true,
has_auto_increment: true,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'description',
table: 'teams',
type: 'text',
default_value: null,
max_length: 65535,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'credits',
table: 'teams',
type: 'int',
default_value: null,
max_length: null,
precision: 10,
scale: 0,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: 'Remaining usage credits',
},
{
name: 'created_at',
table: 'teams',
type: 'datetime',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
{
name: 'activated_at',
table: 'teams',
type: 'date',
default_value: null,
max_length: null,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
},
]);
});
it('returns information for a specific column in a specific table', async () => {
expect(await inspector.columnInfo('teams', 'name')).to.deep.equal({
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
});
});
});
it('returns information for a specific column in a specific table', async () => {
expect(await inspector.columnInfo('teams', 'name')).to.deep.equal({
name: 'name',
table: 'teams',
type: 'varchar',
default_value: null,
max_length: 100,
precision: null,
scale: null,
is_nullable: true,
is_primary_key: false,
has_auto_increment: false,
foreign_key_column: null,
foreign_key_table: null,
comment: '',
});
});
});
describe('.primary', () => {
it('returns primary key for a table', async () => {
expect(await inspector.primary('teams')).to.equal('id');
expect(await inspector.primary('page_visits')).to.equal(null);
});
});
describe('.primary', () => {
it('returns primary key for a table', async () => {
expect(await inspector.primary('teams')).to.equal('id');
expect(await inspector.primary('page_visits')).to.equal(null);
});
});
});

986
packages/schema/test/postgres.spec.ts
View File

File diff suppressed because it is too large Load Diff