You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

317 lines
15 KiB

  1. exports.up = knex => {
  2. const dbCompat = {
  3. charset: (WIKI.config.db.type === `mysql` || WIKI.config.db.type === `mariadb`),
  4. noForeign: WIKI.config.db.type === 'sqlite'
  5. }
  6. return knex.schema
  7. // =====================================
  8. // MODEL TABLES
  9. // =====================================
  10. // ASSETS ------------------------------
  11. .createTable('assets', table => {
  12. if (dbCompat.charset) { table.charset('utf8mb4') }
  13. table.increments('id').primary()
  14. table.string('filename').notNullable()
  15. table.string('basename').notNullable()
  16. table.string('ext').notNullable()
  17. table.enum('kind', ['binary', 'image']).notNullable().defaultTo('binary')
  18. table.string('mime').notNullable().defaultTo('application/octet-stream')
  19. table.integer('fileSize').unsigned().comment('In kilobytes')
  20. table.json('metadata')
  21. table.string('createdAt').notNullable()
  22. table.string('updatedAt').notNullable()
  23. table.integer('folderId').unsigned().references('id').inTable('assetFolders')
  24. table.integer('authorId').unsigned().references('id').inTable('users')
  25. })
  26. // ASSET FOLDERS -----------------------
  27. .createTable('assetFolders', table => {
  28. if (dbCompat.charset) { table.charset('utf8mb4') }
  29. table.increments('id').primary()
  30. table.string('name').notNullable()
  31. table.string('slug').notNullable()
  32. table.integer('parentId').unsigned().references('id').inTable('assetFolders')
  33. })
  34. // AUTHENTICATION ----------------------
  35. .createTable('authentication', table => {
  36. if (dbCompat.charset) { table.charset('utf8mb4') }
  37. table.string('key').notNullable().primary()
  38. table.boolean('isEnabled').notNullable().defaultTo(false)
  39. table.json('config').notNullable()
  40. table.boolean('selfRegistration').notNullable().defaultTo(false)
  41. table.json('domainWhitelist').notNullable()
  42. table.json('autoEnrollGroups').notNullable()
  43. })
  44. // COMMENTS ----------------------------
  45. .createTable('comments', table => {
  46. if (dbCompat.charset) { table.charset('utf8mb4') }
  47. table.increments('id').primary()
  48. table.text('content').notNullable()
  49. table.string('createdAt').notNullable()
  50. table.string('updatedAt').notNullable()
  51. table.integer('pageId').unsigned().references('id').inTable('pages')
  52. table.integer('authorId').unsigned().references('id').inTable('users')
  53. })
  54. // EDITORS -----------------------------
  55. .createTable('editors', table => {
  56. if (dbCompat.charset) { table.charset('utf8mb4') }
  57. table.string('key').notNullable().primary()
  58. table.boolean('isEnabled').notNullable().defaultTo(false)
  59. table.json('config').notNullable()
  60. })
  61. // GROUPS ------------------------------
  62. .createTable('groups', table => {
  63. if (dbCompat.charset) { table.charset('utf8mb4') }
  64. table.increments('id').primary()
  65. table.string('name').notNullable()
  66. table.json('permissions').notNullable()
  67. table.json('pageRules').notNullable()
  68. table.boolean('isSystem').notNullable().defaultTo(false)
  69. table.string('createdAt').notNullable()
  70. table.string('updatedAt').notNullable()
  71. })
  72. // LOCALES -----------------------------
  73. .createTable('locales', table => {
  74. if (dbCompat.charset) { table.charset('utf8mb4') }
  75. table.string('code', 2).notNullable().primary()
  76. table.json('strings')
  77. table.boolean('isRTL').notNullable().defaultTo(false)
  78. table.string('name').notNullable()
  79. table.string('nativeName').notNullable()
  80. table.string('createdAt').notNullable()
  81. table.string('updatedAt').notNullable()
  82. })
  83. // LOGGING ----------------------------
  84. .createTable('loggers', table => {
  85. if (dbCompat.charset) { table.charset('utf8mb4') }
  86. table.string('key').notNullable().primary()
  87. table.boolean('isEnabled').notNullable().defaultTo(false)
  88. table.string('level').notNullable().defaultTo('warn')
  89. table.json('config')
  90. })
  91. // NAVIGATION ----------------------------
  92. .createTable('navigation', table => {
  93. if (dbCompat.charset) { table.charset('utf8mb4') }
  94. table.string('key').notNullable().primary()
  95. table.json('config')
  96. })
  97. // PAGE HISTORY ------------------------
  98. .createTable('pageHistory', table => {
  99. if (dbCompat.charset) { table.charset('utf8mb4') }
  100. table.increments('id').primary()
  101. table.string('path').notNullable()
  102. table.string('hash').notNullable()
  103. table.string('title').notNullable()
  104. table.string('description')
  105. table.boolean('isPrivate').notNullable().defaultTo(false)
  106. table.boolean('isPublished').notNullable().defaultTo(false)
  107. table.string('publishStartDate')
  108. table.string('publishEndDate')
  109. table.text('content')
  110. table.string('contentType').notNullable()
  111. table.string('createdAt').notNullable()
  112. table.integer('pageId').unsigned().references('id').inTable('pages')
  113. table.string('editorKey').references('key').inTable('editors')
  114. table.string('localeCode', 2).references('code').inTable('locales')
  115. table.integer('authorId').unsigned().references('id').inTable('users')
  116. })
  117. // PAGES -------------------------------
  118. .createTable('pages', table => {
  119. if (dbCompat.charset) { table.charset('utf8mb4') }
  120. table.increments('id').primary()
  121. table.string('path').notNullable()
  122. table.string('hash').notNullable()
  123. table.string('title').notNullable()
  124. table.string('description')
  125. table.boolean('isPrivate').notNullable().defaultTo(false)
  126. table.boolean('isPublished').notNullable().defaultTo(false)
  127. table.string('privateNS')
  128. table.string('publishStartDate')
  129. table.string('publishEndDate')
  130. table.text('content')
  131. table.text('render')
  132. table.json('toc')
  133. table.string('contentType').notNullable()
  134. table.string('createdAt').notNullable()
  135. table.string('updatedAt').notNullable()
  136. table.string('editorKey').references('key').inTable('editors')
  137. table.string('localeCode', 2).references('code').inTable('locales')
  138. table.integer('authorId').unsigned().references('id').inTable('users')
  139. table.integer('creatorId').unsigned().references('id').inTable('users')
  140. })
  141. // PAGE TREE ---------------------------
  142. .createTable('pageTree', table => {
  143. if (dbCompat.charset) { table.charset('utf8mb4') }
  144. table.increments('id').primary()
  145. table.string('path').notNullable()
  146. table.integer('depth').unsigned().notNullable()
  147. table.string('title').notNullable()
  148. table.boolean('isPrivate').notNullable().defaultTo(false)
  149. table.boolean('isFolder').notNullable().defaultTo(false)
  150. table.string('privateNS')
  151. table.integer('parent').unsigned().references('id').inTable('pageTree')
  152. table.integer('pageId').unsigned().references('id').inTable('pages')
  153. table.string('localeCode', 2).references('code').inTable('locales')
  154. })
  155. // RENDERERS ---------------------------
  156. .createTable('renderers', table => {
  157. if (dbCompat.charset) { table.charset('utf8mb4') }
  158. table.string('key').notNullable().primary()
  159. table.boolean('isEnabled').notNullable().defaultTo(false)
  160. table.json('config')
  161. })
  162. // SEARCH ------------------------------
  163. .createTable('searchEngines', table => {
  164. if (dbCompat.charset) { table.charset('utf8mb4') }
  165. table.string('key').notNullable().primary()
  166. table.boolean('isEnabled').notNullable().defaultTo(false)
  167. table.json('config')
  168. })
  169. // SETTINGS ----------------------------
  170. .createTable('settings', table => {
  171. if (dbCompat.charset) { table.charset('utf8mb4') }
  172. table.string('key').notNullable().primary()
  173. table.json('value')
  174. table.string('updatedAt').notNullable()
  175. })
  176. // STORAGE -----------------------------
  177. .createTable('storage', table => {
  178. if (dbCompat.charset) { table.charset('utf8mb4') }
  179. table.string('key').notNullable().primary()
  180. table.boolean('isEnabled').notNullable().defaultTo(false)
  181. table.string('mode', ['sync', 'push', 'pull']).notNullable().defaultTo('push')
  182. table.json('config')
  183. })
  184. // TAGS --------------------------------
  185. .createTable('tags', table => {
  186. if (dbCompat.charset) { table.charset('utf8mb4') }
  187. table.increments('id').primary()
  188. table.string('tag').notNullable().unique()
  189. table.string('title')
  190. table.string('createdAt').notNullable()
  191. table.string('updatedAt').notNullable()
  192. })
  193. // USER KEYS ---------------------------
  194. .createTable('userKeys', table => {
  195. if (dbCompat.charset) { table.charset('utf8mb4') }
  196. table.increments('id').primary()
  197. table.string('kind').notNullable()
  198. table.string('token').notNullable()
  199. table.string('createdAt').notNullable()
  200. table.string('validUntil').notNullable()
  201. table.integer('userId').unsigned().references('id').inTable('users')
  202. })
  203. // USERS -------------------------------
  204. .createTable('users', table => {
  205. if (dbCompat.charset) { table.charset('utf8mb4') }
  206. table.increments('id').primary()
  207. table.string('email').notNullable()
  208. table.string('name').notNullable()
  209. table.string('providerId')
  210. table.string('password')
  211. table.boolean('tfaIsActive').notNullable().defaultTo(false)
  212. table.string('tfaSecret')
  213. table.string('jobTitle').defaultTo('')
  214. table.string('location').defaultTo('')
  215. table.string('pictureUrl')
  216. table.string('timezone').notNullable().defaultTo('America/New_York')
  217. table.boolean('isSystem').notNullable().defaultTo(false)
  218. table.boolean('isActive').notNullable().defaultTo(false)
  219. table.boolean('isVerified').notNullable().defaultTo(false)
  220. table.string('createdAt').notNullable()
  221. table.string('updatedAt').notNullable()
  222. table.string('providerKey').references('key').inTable('authentication').notNullable().defaultTo('local')
  223. table.string('localeCode', 2).references('code').inTable('locales').notNullable().defaultTo('en')
  224. table.string('defaultEditor').references('key').inTable('editors').notNullable().defaultTo('markdown')
  225. })
  226. // =====================================
  227. // RELATION TABLES
  228. // =====================================
  229. // PAGE HISTORY TAGS ---------------------------
  230. .createTable('pageHistoryTags', table => {
  231. if (dbCompat.charset) { table.charset('utf8mb4') }
  232. table.increments('id').primary()
  233. table.integer('pageId').unsigned().references('id').inTable('pageHistory').onDelete('CASCADE')
  234. table.integer('tagId').unsigned().references('id').inTable('tags').onDelete('CASCADE')
  235. })
  236. // PAGE TAGS ---------------------------
  237. .createTable('pageTags', table => {
  238. if (dbCompat.charset) { table.charset('utf8mb4') }
  239. table.increments('id').primary()
  240. table.integer('pageId').unsigned().references('id').inTable('pages').onDelete('CASCADE')
  241. table.integer('tagId').unsigned().references('id').inTable('tags').onDelete('CASCADE')
  242. })
  243. // USER GROUPS -------------------------
  244. .createTable('userGroups', table => {
  245. if (dbCompat.charset) { table.charset('utf8mb4') }
  246. table.increments('id').primary()
  247. table.integer('userId').unsigned().references('id').inTable('users').onDelete('CASCADE')
  248. table.integer('groupId').unsigned().references('id').inTable('groups').onDelete('CASCADE')
  249. })
  250. // =====================================
  251. // REFERENCES
  252. // =====================================
  253. // .table('assets', table => {
  254. // dbCompat.noForeign ? table.integer('folderId').unsigned() : table.integer('folderId').unsigned().references('id').inTable('assetFolders')
  255. // dbCompat.noForeign ? table.integer('authorId').unsigned() : table.integer('authorId').unsigned().references('id').inTable('users')
  256. // })
  257. // .table('comments', table => {
  258. // dbCompat.noForeign ? table.integer('pageId').unsigned() : table.integer('pageId').unsigned().references('id').inTable('pages')
  259. // dbCompat.noForeign ? table.integer('authorId').unsigned() : table.integer('authorId').unsigned().references('id').inTable('users')
  260. // })
  261. // .table('pageHistory', table => {
  262. // dbCompat.noForeign ? table.integer('pageId').unsigned() : table.integer('pageId').unsigned().references('id').inTable('pages')
  263. // dbCompat.noForeign ? table.string('editorKey') : table.string('editorKey').references('key').inTable('editors')
  264. // dbCompat.noForeign ? table.string('localeCode', 2) : table.string('localeCode', 2).references('code').inTable('locales')
  265. // dbCompat.noForeign ? table.integer('authorId').unsigned() : table.integer('authorId').unsigned().references('id').inTable('users')
  266. // })
  267. // .table('pages', table => {
  268. // dbCompat.noForeign ? table.string('editorKey') : table.string('editorKey').references('key').inTable('editors')
  269. // dbCompat.noForeign ? table.string('localeCode', 2) : table.string('localeCode', 2).references('code').inTable('locales')
  270. // dbCompat.noForeign ? table.integer('authorId').unsigned() : table.integer('authorId').unsigned().references('id').inTable('users')
  271. // dbCompat.noForeign ? table.integer('creatorId').unsigned() : table.integer('creatorId').unsigned().references('id').inTable('users')
  272. // })
  273. // .table('pageTree', table => {
  274. // dbCompat.noForeign ? table.integer('parent').unsigned() : table.integer('parent').unsigned().references('id').inTable('pageTree')
  275. // dbCompat.noForeign ? table.integer('pageId').unsigned() : table.integer('pageId').unsigned().references('id').inTable('pages')
  276. // dbCompat.noForeign ? table.string('localeCode', 2) : table.string('localeCode', 2).references('code').inTable('locales')
  277. // })
  278. // .table('userKeys', table => {
  279. // dbCompat.noForeign ? table.integer('userId').unsigned() : table.integer('userId').unsigned().references('id').inTable('users')
  280. // })
  281. .table('users', table => {
  282. // dbCompat.noForeign ? table.string('providerKey') : table.string('providerKey').references('key').inTable('authentication').notNullable().defaultTo('local')
  283. // dbCompat.noForeign ? table.string('localeCode', 2) : table.string('localeCode', 2).references('code').inTable('locales').notNullable().defaultTo('en')
  284. // dbCompat.noForeign ? table.string('defaultEditor') : table.string('defaultEditor').references('key').inTable('editors').notNullable().defaultTo('markdown')
  285. table.unique(['providerKey', 'email'])
  286. })
  287. }
  288. exports.down = knex => {
  289. return knex.schema
  290. .dropTableIfExists('userGroups')
  291. .dropTableIfExists('pageHistoryTags')
  292. .dropTableIfExists('pageHistory')
  293. .dropTableIfExists('pageTags')
  294. .dropTableIfExists('assets')
  295. .dropTableIfExists('assetFolders')
  296. .dropTableIfExists('comments')
  297. .dropTableIfExists('editors')
  298. .dropTableIfExists('groups')
  299. .dropTableIfExists('locales')
  300. .dropTableIfExists('navigation')
  301. .dropTableIfExists('pages')
  302. .dropTableIfExists('renderers')
  303. .dropTableIfExists('settings')
  304. .dropTableIfExists('storage')
  305. .dropTableIfExists('tags')
  306. .dropTableIfExists('userKeys')
  307. .dropTableIfExists('users')
  308. }