1 import { QueryTypes, Transaction } from 'sequelize'
2 import { Sequelize as SequelizeTypescript } from 'sequelize-typescript'
3 import { TrackerModel } from '@server/models/server/tracker'
4 import { VideoTrackerModel } from '@server/models/server/video-tracker'
5 import { UserModel } from '@server/models/user/user'
6 import { UserNotificationModel } from '@server/models/user/user-notification'
7 import { UserVideoHistoryModel } from '@server/models/user/user-video-history'
8 import { isTestInstance } from '../helpers/core-utils'
9 import { logger } from '../helpers/logger'
10 import { AbuseModel } from '../models/abuse/abuse'
11 import { AbuseMessageModel } from '../models/abuse/abuse-message'
12 import { VideoAbuseModel } from '../models/abuse/video-abuse'
13 import { VideoCommentAbuseModel } from '../models/abuse/video-comment-abuse'
14 import { AccountModel } from '../models/account/account'
15 import { AccountBlocklistModel } from '../models/account/account-blocklist'
16 import { AccountVideoRateModel } from '../models/account/account-video-rate'
17 import { ActorModel } from '../models/actor/actor'
18 import { ActorFollowModel } from '../models/actor/actor-follow'
19 import { ActorImageModel } from '../models/actor/actor-image'
20 import { ApplicationModel } from '../models/application/application'
21 import { OAuthClientModel } from '../models/oauth/oauth-client'
22 import { OAuthTokenModel } from '../models/oauth/oauth-token'
23 import { VideoRedundancyModel } from '../models/redundancy/video-redundancy'
24 import { PluginModel } from '../models/server/plugin'
25 import { ServerModel } from '../models/server/server'
26 import { ServerBlocklistModel } from '../models/server/server-blocklist'
27 import { UserNotificationSettingModel } from '../models/user/user-notification-setting'
28 import { ScheduleVideoUpdateModel } from '../models/video/schedule-video-update'
29 import { TagModel } from '../models/video/tag'
30 import { ThumbnailModel } from '../models/video/thumbnail'
31 import { VideoModel } from '../models/video/video'
32 import { VideoBlacklistModel } from '../models/video/video-blacklist'
33 import { VideoCaptionModel } from '../models/video/video-caption'
34 import { VideoChangeOwnershipModel } from '../models/video/video-change-ownership'
35 import { VideoChannelModel } from '../models/video/video-channel'
36 import { VideoCommentModel } from '../models/video/video-comment'
37 import { VideoFileModel } from '../models/video/video-file'
38 import { VideoImportModel } from '../models/video/video-import'
39 import { VideoLiveModel } from '../models/video/video-live'
40 import { VideoPlaylistModel } from '../models/video/video-playlist'
41 import { VideoPlaylistElementModel } from '../models/video/video-playlist-element'
42 import { VideoShareModel } from '../models/video/video-share'
43 import { VideoStreamingPlaylistModel } from '../models/video/video-streaming-playlist'
44 import { VideoTagModel } from '../models/video/video-tag'
45 import { VideoViewModel } from '../models/video/video-view'
46 import { CONFIG } from './config'
47 import { ActorCustomPageModel } from '@server/models/account/actor-custom-page'
49 require('pg').defaults.parseInt8 = true // Avoid BIGINT to be converted to string
51 const dbname = CONFIG.DATABASE.DBNAME
52 const username = CONFIG.DATABASE.USERNAME
53 const password = CONFIG.DATABASE.PASSWORD
54 const host = CONFIG.DATABASE.HOSTNAME
55 const port = CONFIG.DATABASE.PORT
56 const poolMax = CONFIG.DATABASE.POOL.MAX
58 let dialectOptions: any = {}
60 if (CONFIG.DATABASE.SSL) {
63 rejectUnauthorized: false
68 const sequelizeTypescript = new SequelizeTypescript({
79 benchmark: isTestInstance(),
80 isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
81 logging: (message: string, benchmark: number) => {
82 if (process.env.NODE_DB_LOG === 'false') return
84 let newMessage = 'Executed SQL request'
85 if (isTestInstance() === true && benchmark !== undefined) {
86 newMessage += ' in ' + benchmark + 'ms'
89 logger.debug(newMessage, { sql: message, tags: [ 'sql' ] })
93 function checkDatabaseConnectionOrDie () {
94 sequelizeTypescript.authenticate()
95 .then(() => logger.debug('Connection to PostgreSQL has been established successfully.'))
98 logger.error('Unable to connect to PostgreSQL database.', { err })
103 async function initDatabaseModels (silent: boolean) {
104 sequelizeTypescript.addModels([
114 AccountVideoRateModel,
118 VideoCommentAbuseModel,
121 VideoChangeOwnershipModel,
129 ScheduleVideoUpdateModel,
132 VideoRedundancyModel,
133 UserVideoHistoryModel,
135 AccountBlocklistModel,
136 ServerBlocklistModel,
137 UserNotificationModel,
138 UserNotificationSettingModel,
139 VideoStreamingPlaylistModel,
141 VideoPlaylistElementModel,
149 // Check extensions exist in the database
150 await checkPostgresExtensions()
152 // Create custom PostgreSQL functions
153 await createFunctions()
155 if (!silent) logger.info('Database %s is ready.', dbname)
158 // ---------------------------------------------------------------------------
162 checkDatabaseConnectionOrDie,
166 // ---------------------------------------------------------------------------
168 async function checkPostgresExtensions () {
170 checkPostgresExtension('pg_trgm'),
171 checkPostgresExtension('unaccent')
174 return Promise.all(promises)
177 async function checkPostgresExtension (extension: string) {
178 const query = `SELECT 1 FROM pg_available_extensions WHERE name = '${extension}' AND installed_version IS NOT NULL;`
180 type: QueryTypes.SELECT as QueryTypes.SELECT,
184 const res = await sequelizeTypescript.query<object>(query, options)
186 if (!res || res.length === 0) {
187 // Try to create the extension ourselves
189 await sequelizeTypescript.query(`CREATE EXTENSION ${extension};`, { raw: true })
192 const errorMessage = `You need to enable ${extension} extension in PostgreSQL. ` +
193 `You can do so by running 'CREATE EXTENSION ${extension};' as a PostgreSQL super user in ${CONFIG.DATABASE.DBNAME} database.`
194 throw new Error(errorMessage)
199 function createFunctions () {
200 const query = `CREATE OR REPLACE FUNCTION immutable_unaccent(text)
203 SELECT public.unaccent('public.unaccent', $1::text)
204 $func$ LANGUAGE sql IMMUTABLE;`
206 return sequelizeTypescript.query(query, { raw: true })