1 import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
2 import { isTestInstance } from '../helpers/core-utils'
3 import { logger } from '../helpers/logger'
5 import { AccountModel } from '../models/account/account'
6 import { AccountVideoRateModel } from '../models/account/account-video-rate'
7 import { UserModel } from '../models/account/user'
8 import { ActorModel } from '../models/activitypub/actor'
9 import { ActorFollowModel } from '../models/activitypub/actor-follow'
10 import { ApplicationModel } from '../models/application/application'
11 import { AvatarModel } from '../models/avatar/avatar'
12 import { OAuthClientModel } from '../models/oauth/oauth-client'
13 import { OAuthTokenModel } from '../models/oauth/oauth-token'
14 import { ServerModel } from '../models/server/server'
15 import { TagModel } from '../models/video/tag'
16 import { VideoModel } from '../models/video/video'
17 import { VideoAbuseModel } from '../models/video/video-abuse'
18 import { VideoBlacklistModel } from '../models/video/video-blacklist'
19 import { VideoChannelModel } from '../models/video/video-channel'
20 import { VideoCommentModel } from '../models/video/video-comment'
21 import { VideoFileModel } from '../models/video/video-file'
22 import { VideoShareModel } from '../models/video/video-share'
23 import { VideoTagModel } from '../models/video/video-tag'
24 import { CONFIG } from './constants'
25 import { ScheduleVideoUpdateModel } from '../models/video/schedule-video-update'
26 import { VideoCaptionModel } from '../models/video/video-caption'
27 import { VideoImportModel } from '../models/video/video-import'
28 import { VideoViewModel } from '../models/video/video-views'
29 import { VideoChangeOwnershipModel } from '../models/video/video-change-ownership'
30 import { VideoRedundancyModel } from '../models/redundancy/video-redundancy'
31 import { UserVideoHistoryModel } from '../models/account/user-video-history'
32 import { AccountBlocklistModel } from '../models/account/account-blocklist'
33 import { ServerBlocklistModel } from '../models/server/server-blocklist'
34 import { UserNotificationModel } from '../models/account/user-notification'
35 import { UserNotificationSettingModel } from '../models/account/user-notification-setting'
36 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
37 import { VideoPlaylistModel } from '../models/video/video-playlist'
38 import { VideoPlaylistElementModel } from '../models/video/video-playlist-element'
40 require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
42 const dbname = CONFIG.DATABASE.DBNAME
43 const username = CONFIG.DATABASE.USERNAME
44 const password = CONFIG.DATABASE.PASSWORD
45 const host = CONFIG.DATABASE.HOSTNAME
46 const port = CONFIG.DATABASE.PORT
47 const poolMax = CONFIG.DATABASE.POOL.MAX
49 const sequelizeTypescript = new SequelizeTypescript({
59 benchmark: isTestInstance(),
60 isolationLevel: SequelizeTypescript.Transaction.ISOLATION_LEVELS.SERIALIZABLE,
61 operatorsAliases: false,
62 logging: (message: string, benchmark: number) => {
63 if (process.env.NODE_DB_LOG === 'false') return
65 let newMessage = message
66 if (isTestInstance() === true && benchmark !== undefined) {
67 newMessage += ' | ' + benchmark + 'ms'
70 logger.debug(newMessage)
74 async function initDatabaseModels (silent: boolean) {
75 sequelizeTypescript.addModels([
85 AccountVideoRateModel,
88 VideoChangeOwnershipModel,
97 ScheduleVideoUpdateModel,
100 VideoRedundancyModel,
101 UserVideoHistoryModel,
102 AccountBlocklistModel,
103 ServerBlocklistModel,
104 UserNotificationModel,
105 UserNotificationSettingModel,
106 VideoStreamingPlaylistModel,
108 VideoPlaylistElementModel
111 // Check extensions exist in the database
112 await checkPostgresExtensions()
114 // Create custom PostgreSQL functions
115 await createFunctions()
117 if (!silent) logger.info('Database %s is ready.', dbname)
122 // ---------------------------------------------------------------------------
129 // ---------------------------------------------------------------------------
131 async function checkPostgresExtensions () {
133 checkPostgresExtension('pg_trgm'),
134 checkPostgresExtension('unaccent')
137 return Promise.all(promises)
140 async function checkPostgresExtension (extension: string) {
141 const query = `SELECT true AS enabled FROM pg_available_extensions WHERE name = '${extension}' AND installed_version IS NOT NULL;`
142 const [ res ] = await sequelizeTypescript.query(query, { raw: true })
144 if (!res || res.length === 0 || res[ 0 ][ 'enabled' ] !== true) {
145 // Try to create the extension ourself
147 await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
150 const errorMessage = `You need to enable ${extension} extension in PostgreSQL. ` +
151 `You can do so by running 'CREATE EXTENSION ${extension};' as a PostgreSQL super user in ${CONFIG.DATABASE.DBNAME} database.`
152 throw new Error(errorMessage)
157 async function createFunctions () {
158 const query = `CREATE OR REPLACE FUNCTION immutable_unaccent(text)
161 SELECT public.unaccent('public.unaccent', $1::text)
162 $func$ LANGUAGE sql IMMUTABLE;`
164 return sequelizeTypescript.query(query, { raw: true })