formatDateTime

Function: formatDateTime()

formatDateTime(field, format, options?): SqlExpression | AliasedExpression

Formats a DateTime value using the specified format

Parameters

field

string

The field or expression to format

format

string

The date format string

options?

FormatDateTimeOptions

Optional configuration including timezone and alias

FormatDateTimeOptions

interface FormatDateTimeOptions {
  timezone?: string;  // Optional timezone parameter (e.g., 'UTC', 'America/New_York')
  alias?: string;     // Optional alias for the result
}

Returns

SqlExpression | AliasedExpression

SQL expression or aliased expression

Examples

// Basic formatting
formatDateTime('created_at', 'Y-m-d H:i:s')

// With timezone
formatDateTime('created_at', 'Y-m-d H:i:s', { timezone: 'UTC' })

// With alias
formatDateTime('created_at', 'Y-m-d H:i:s', { alias: 'formatted_date' })

// With timezone and alias
formatDateTime('created_at', 'Y-m-d H:i:s', { 
  timezone: 'America/New_York', 
  alias: 'formatted_date' 
})

// Super clean with destructuring for common options
const commonOptions = { timezone: 'UTC' };
formatDateTime('created_at', 'Y-m-d H:i:s', {
  ...commonOptions,
  alias: 'date_formatted'
})