wikijs-fork/server/db/migrations/2.0.0.js

326 lines
14 KiB
JavaScript
Raw Normal View History

2019-07-17 02:23:41 +00:00
/* global WIKI */
exports.up = knex => {
2019-01-07 03:03:34 +00:00
const dbCompat = {
blobLength: (WIKI.config.db.type === `mysql` || WIKI.config.db.type === `mariadb`),
charset: (WIKI.config.db.type === `mysql` || WIKI.config.db.type === `mariadb`),
selfCascadeDelete: WIKI.config.db.type !== 'mssql'
2019-01-07 03:03:34 +00:00
}
return knex.schema
2018-05-20 22:50:51 +00:00
// =====================================
// MODEL TABLES
// =====================================
// ANALYTICS ---------------------------
.createTable('analytics', table => {
if (dbCompat.charset) { table.charset('utf8mb4') }
table.string('key').notNullable().primary()
table.boolean('isEnabled').notNullable().defaultTo(false)
table.json('config').notNullable()
})
2018-05-20 22:50:51 +00:00
// ASSETS ------------------------------
.createTable('assets', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
table.string('filename').notNullable()
table.string('hash').notNullable()
2018-05-20 22:50:51 +00:00
table.string('ext').notNullable()
table.enum('kind', ['binary', 'image']).notNullable().defaultTo('binary')
table.string('mime').notNullable().defaultTo('application/octet-stream')
table.integer('fileSize').unsigned().comment('In kilobytes')
table.json('metadata')
2018-05-20 22:50:51 +00:00
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
// ASSET DATA --------------------------
.createTable('assetData', table => {
if (dbCompat.charset) { table.charset('utf8mb4') }
table.integer('id').primary()
if (dbCompat.blobLength) {
table.specificType('data', 'LONGBLOB').notNullable()
} else {
table.binary('data').notNullable()
}
})
2018-05-20 22:50:51 +00:00
// ASSET FOLDERS -----------------------
.createTable('assetFolders', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
table.string('name').notNullable()
table.string('slug').notNullable()
table.integer('parentId').unsigned().references('id').inTable('assetFolders')
})
2018-05-28 18:46:55 +00:00
// AUTHENTICATION ----------------------
.createTable('authentication', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-05-28 18:46:55 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
table.json('config').notNullable()
table.boolean('selfRegistration').notNullable().defaultTo(false)
table.json('domainWhitelist').notNullable()
table.json('autoEnrollGroups').notNullable()
2018-05-28 18:46:55 +00:00
})
2018-05-20 22:50:51 +00:00
// COMMENTS ----------------------------
.createTable('comments', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
table.text('content').notNullable()
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
2018-05-28 18:46:55 +00:00
// EDITORS -----------------------------
.createTable('editors', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-05-28 18:46:55 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
table.json('config').notNullable()
2018-05-28 18:46:55 +00:00
})
2018-05-20 22:50:51 +00:00
// GROUPS ------------------------------
.createTable('groups', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.string('name').notNullable()
table.json('permissions').notNullable()
table.json('pageRules').notNullable()
table.boolean('isSystem').notNullable().defaultTo(false)
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
2018-05-20 22:50:51 +00:00
// LOCALES -----------------------------
.createTable('locales', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2019-07-17 02:23:41 +00:00
table.string('code', 5).notNullable().primary()
table.json('strings')
table.boolean('isRTL').notNullable().defaultTo(false)
table.string('name').notNullable()
table.string('nativeName').notNullable()
table.integer('availability').notNullable().defaultTo(0)
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
2018-09-01 19:15:44 +00:00
// LOGGING ----------------------------
.createTable('loggers', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-09-01 19:15:44 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
table.string('level').notNullable().defaultTo('warn')
table.json('config')
})
// NAVIGATION ----------------------------
.createTable('navigation', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.string('key').notNullable().primary()
table.json('config')
})
// PAGE HISTORY ------------------------
.createTable('pageHistory', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.string('path').notNullable()
table.string('hash').notNullable()
table.string('title').notNullable()
table.string('description')
table.boolean('isPrivate').notNullable().defaultTo(false)
table.boolean('isPublished').notNullable().defaultTo(false)
table.string('publishStartDate')
table.string('publishEndDate')
table.string('action').defaultTo('updated')
table.integer('pageId').unsigned()
table.text('content')
table.string('contentType').notNullable()
table.string('createdAt').notNullable()
})
// PAGE LINKS --------------------------
.createTable('pageLinks', table => {
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.string('path').notNullable()
table.string('localeCode', 5).notNullable()
})
2018-05-20 22:50:51 +00:00
// PAGES -------------------------------
.createTable('pages', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
table.string('path').notNullable()
table.string('hash').notNullable()
2018-05-20 22:50:51 +00:00
table.string('title').notNullable()
table.string('description')
2018-05-28 18:46:55 +00:00
table.boolean('isPrivate').notNullable().defaultTo(false)
2018-05-20 22:50:51 +00:00
table.boolean('isPublished').notNullable().defaultTo(false)
table.string('privateNS')
2018-05-20 22:50:51 +00:00
table.string('publishStartDate')
table.string('publishEndDate')
switch (WIKI.config.db.type) {
case 'postgres':
case 'sqlite':
table.text('content')
table.text('render')
break
case 'mariadb':
case 'mysql':
table.specificType('content', 'LONGTEXT')
table.specificType('render', 'LONGTEXT')
break
case 'mssql':
table.specificType('content', 'VARCHAR(max)')
table.specificType('render', 'VARCHAR(max)')
break
}
table.json('toc')
table.string('contentType').notNullable()
2018-05-20 22:50:51 +00:00
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
// PAGE TREE ---------------------------
.createTable('pageTree', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.integer('id').unsigned().primary()
table.string('path').notNullable()
table.integer('depth').unsigned().notNullable()
table.string('title').notNullable()
table.boolean('isPrivate').notNullable().defaultTo(false)
table.boolean('isFolder').notNullable().defaultTo(false)
table.string('privateNS')
})
// RENDERERS ---------------------------
2018-08-20 05:02:57 +00:00
.createTable('renderers', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-09-01 19:15:44 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
table.json('config')
})
// SEARCH ------------------------------
.createTable('searchEngines', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-08-20 05:02:57 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
table.json('config')
})
2018-05-20 22:50:51 +00:00
// SETTINGS ----------------------------
.createTable('settings', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
table.json('value')
2018-05-20 22:50:51 +00:00
table.string('updatedAt').notNullable()
})
2018-05-28 18:46:55 +00:00
// STORAGE -----------------------------
.createTable('storage', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-09-08 19:49:36 +00:00
table.string('key').notNullable().primary()
2018-05-28 18:46:55 +00:00
table.boolean('isEnabled').notNullable().defaultTo(false)
2018-08-20 05:02:57 +00:00
table.string('mode', ['sync', 'push', 'pull']).notNullable().defaultTo('push')
table.json('config')
table.string('syncInterval')
table.json('state')
2018-05-28 18:46:55 +00:00
})
2018-05-20 22:50:51 +00:00
// TAGS --------------------------------
.createTable('tags', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
table.string('tag').notNullable().unique()
table.string('title')
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
// USER KEYS ---------------------------
.createTable('userKeys', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.string('kind').notNullable()
2018-12-24 06:03:10 +00:00
table.string('token').notNullable()
table.string('createdAt').notNullable()
table.string('validUntil').notNullable()
})
2018-05-20 22:50:51 +00:00
// USERS -------------------------------
.createTable('users', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.string('email').notNullable()
table.string('name').notNullable()
table.string('providerId')
table.string('password')
table.boolean('tfaIsActive').notNullable().defaultTo(false)
table.string('tfaSecret')
2018-05-28 18:46:55 +00:00
table.string('jobTitle').defaultTo('')
table.string('location').defaultTo('')
table.string('pictureUrl')
table.string('timezone').notNullable().defaultTo('America/New_York')
table.boolean('isSystem').notNullable().defaultTo(false)
table.boolean('isActive').notNullable().defaultTo(false)
table.boolean('isVerified').notNullable().defaultTo(false)
table.boolean('mustChangePwd').notNullable().defaultTo(false)
table.string('createdAt').notNullable()
table.string('updatedAt').notNullable()
})
2018-05-20 22:50:51 +00:00
// =====================================
// RELATION TABLES
// =====================================
// PAGE HISTORY TAGS ---------------------------
.createTable('pageHistoryTags', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
table.integer('pageId').unsigned().references('id').inTable('pageHistory').onDelete('CASCADE')
table.integer('tagId').unsigned().references('id').inTable('tags').onDelete('CASCADE')
})
2018-05-20 22:50:51 +00:00
// PAGE TAGS ---------------------------
.createTable('pageTags', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
2018-05-20 22:50:51 +00:00
table.increments('id').primary()
2018-05-21 03:27:06 +00:00
table.integer('pageId').unsigned().references('id').inTable('pages').onDelete('CASCADE')
table.integer('tagId').unsigned().references('id').inTable('tags').onDelete('CASCADE')
2018-05-20 22:50:51 +00:00
})
// USER GROUPS -------------------------
.createTable('userGroups', table => {
2019-01-07 03:03:34 +00:00
if (dbCompat.charset) { table.charset('utf8mb4') }
table.increments('id').primary()
2018-05-21 03:27:06 +00:00
table.integer('userId').unsigned().references('id').inTable('users').onDelete('CASCADE')
table.integer('groupId').unsigned().references('id').inTable('groups').onDelete('CASCADE')
})
2018-05-20 22:50:51 +00:00
// =====================================
// REFERENCES
// =====================================
.table('assets', table => {
table.integer('folderId').unsigned().references('id').inTable('assetFolders')
table.integer('authorId').unsigned().references('id').inTable('users')
})
.table('comments', table => {
table.integer('pageId').unsigned().references('id').inTable('pages')
table.integer('authorId').unsigned().references('id').inTable('users')
})
.table('pageHistory', table => {
table.string('editorKey').references('key').inTable('editors')
2019-07-17 02:23:41 +00:00
table.string('localeCode', 5).references('code').inTable('locales')
table.integer('authorId').unsigned().references('id').inTable('users')
})
.table('pageLinks', table => {
table.integer('pageId').unsigned().references('id').inTable('pages').onDelete('CASCADE')
table.index(['path', 'localeCode'])
})
2018-05-20 22:50:51 +00:00
.table('pages', table => {
2018-07-22 04:29:39 +00:00
table.string('editorKey').references('key').inTable('editors')
2019-07-17 02:23:41 +00:00
table.string('localeCode', 5).references('code').inTable('locales')
2018-05-20 22:50:51 +00:00
table.integer('authorId').unsigned().references('id').inTable('users')
table.integer('creatorId').unsigned().references('id').inTable('users')
2018-05-20 22:50:51 +00:00
})
.table('pageTree', table => {
if (dbCompat.selfCascadeDelete) {
table.integer('parent').unsigned().references('id').inTable('pageTree').onDelete('CASCADE')
} else {
table.integer('parent').unsigned()
}
table.integer('pageId').unsigned().references('id').inTable('pages').onDelete('CASCADE')
2019-07-17 02:23:41 +00:00
table.string('localeCode', 5).references('code').inTable('locales')
})
.table('userKeys', table => {
table.integer('userId').unsigned().references('id').inTable('users')
})
2018-05-20 22:50:51 +00:00
.table('users', table => {
2018-07-22 04:29:39 +00:00
table.string('providerKey').references('key').inTable('authentication').notNullable().defaultTo('local')
2019-07-17 02:23:41 +00:00
table.string('localeCode', 5).references('code').inTable('locales').notNullable().defaultTo('en')
2018-05-28 18:46:55 +00:00
table.string('defaultEditor').references('key').inTable('editors').notNullable().defaultTo('markdown')
2018-07-22 04:29:39 +00:00
table.unique(['providerKey', 'email'])
2018-05-20 22:50:51 +00:00
})
}
exports.down = knex => { }