How to Schedule Background Functions in Firebase

1import { onSchedule } from 'firebase-functions/v2/scheduler'
2import { logger } from 'firebase-functions'
3
4// Run every day at midnight UTC
5export const dailyCleanup = onSchedule('every day 00:00', async (event) => {
6  logger.info('Running daily cleanup', { scheduledTime: event.scheduleTime })
7
8  // Your cleanup logic here
9  await deleteExpiredSessions()
10  await archiveOldRecords()
11
12  logger.info('Daily cleanup completed')
13})

1import { onSchedule } from 'firebase-functions/v2/scheduler'
2
3// Every 5 minutes
4export const frequentCheck = onSchedule('*/5 * * * *', async () => {
5  // Runs at :00, :05, :10, :15, etc.
6})
7
8// Every hour at minute 30
9export const hourlySync = onSchedule('30 * * * *', async () => {
10  // Runs at 0:30, 1:30, 2:30, etc.
11})
12
13// Every Monday at 9:00 AM
14export const weeklyReport = onSchedule('0 9 * * 1', async () => {
15  // 1 = Monday
16})
17
18// First day of every month at 6:00 AM
19export const monthlyBilling = onSchedule('0 6 1 * *', async () => {
20  // Day 1 of each month
21})
22
23// App Engine format alternatives
24export const everyHour = onSchedule('every 1 hours', async () => {})
25export const every15Min = onSchedule('every 15 minutes', async () => {})

1import { onSchedule } from 'firebase-functions/v2/scheduler'
2
3export const morningDigest = onSchedule(
4  {
5    schedule: 'every day 08:00',
6    timeZone: 'America/New_York',
7    timeoutSeconds: 300, // 5 minutes
8    memory: '512MiB',
9    retryCount: 3
10  },
11  async (event) => {
12    // Runs at 8:00 AM Eastern Time every day
13    // Automatically handles EST/EDT transitions
14    await sendDailyDigestEmails()
15  }
16)

1import { onSchedule } from 'firebase-functions/v2/scheduler'
2import { logger } from 'firebase-functions'
3import { getFirestore, Timestamp } from 'firebase-admin/firestore'
4import { initializeApp } from 'firebase-admin/app'
5
6initializeApp()
7const db = getFirestore()
8
9export const cleanupExpiredSessions = onSchedule(
10  {
11    schedule: 'every 1 hours',
12    timeoutSeconds: 120,
13    memory: '256MiB'
14  },
15  async () => {
16    const now = Timestamp.now()
17    const expiredQuery = db
18      .collection('sessions')
19      .where('expiresAt', '<', now)
20      .limit(500) // Batch to stay within limits
21
22    const snapshot = await expiredQuery.get()
23
24    if (snapshot.empty) {
25      logger.info('No expired sessions to clean up.')
26      return
27    }
28
29    const batch = db.batch()
30    snapshot.docs.forEach((doc) => {
31      batch.delete(doc.ref)
32    })
33
34    await batch.commit()
35    logger.info(`Deleted ${snapshot.size} expired sessions.`)
36  }
37)

1# Deploy all functions
2firebase deploy --only functions
3
4# Deploy a specific function
5firebase deploy --only functions:dailyCleanup
6
7# View function logs
8firebase functions:log --only dailyCleanup
9
10# List Cloud Scheduler jobs (via gcloud)
11gcloud scheduler jobs list
12
13# Manually trigger for testing
14gcloud scheduler jobs run firebase-schedule-dailyCleanup-us-central1