Documentation

DateTime Functions

Generate dates, timestamps, and time-related data

DateTime Functions

Generate realistic dates, timestamps, and time-related values.


generate_date

Generate random dates within a range.

Category: DateTime Type: Generator Data Types: date

Parameters

ParameterTypeDefaultDescription
patternstring%Y-%m-%dDate format pattern
start_datestring-30yStart date (relative)
end_datestringtodayEnd date (relative)
reference_date_columnstringnoneColumn for reference date
days_offsetinteger0Days to add/subtract

Relative Date Strings

ValueMeaning
todayCurrent date
nowCurrent datetime
-1d1 day ago
-1w1 week ago
-1m1 month ago
-1y1 year ago
+1d1 day from now
+1w1 week from now

Examples

Random date in last year:

columns:
  - name: created_date
    function: generate_date
    parameters:
      start_date: "-1y"
      end_date: "today"

Date in specific range:

columns:
  - name: historical_date
    function: generate_date
    parameters:
      start_date: "-10y"
      end_date: "-5y"

Relative to another column:

columns:
  - name: order_date
    function: generate_date
  - name: ship_date
    function: generate_date
    parameters:
      reference_date_column: order_date
      days_offset: 3

Custom format:

columns:
  - name: formatted_date
    function: generate_date
    parameters:
      pattern: "%m/%d/%Y"

Output Sample

2024-03-15
2023-11-22
2024-01-08

generate_datetime

Generate random datetime values.

Category: DateTime Type: Generator Data Types: datetime, timestamp

Parameters

ParameterTypeDefaultDescription
start_datestring-30yStart datetime
end_datestringnowEnd datetime
tzinfostringnoneTimezone info

Examples

Recent datetime:

columns:
  - name: created_at
    function: generate_datetime
    parameters:
      start_date: "-7d"
      end_date: "now"

Historical data:

columns:
  - name: transaction_time
    function: generate_datetime
    parameters:
      start_date: "-1y"
      end_date: "now"

Output Sample

2024-03-15T14:30:22
2024-02-28T09:15:45
2024-01-10T18:42:11

generate_birthdate

Generate realistic birth dates based on age constraints.

Category: DateTime Type: Generator Data Types: date

Parameters

ParameterTypeDefaultDescription
minimum_ageinteger18Minimum age in years
maximum_ageinteger90Maximum age in years

Examples

Adult employees (25-65):

columns:
  - name: date_of_birth
    function: generate_birthdate
    parameters:
      minimum_age: 25
      maximum_age: 65

Minors (0-17):

columns:
  - name: child_dob
    function: generate_birthdate
    parameters:
      minimum_age: 0
      maximum_age: 17

Seniors (65+):

columns:
  - name: senior_dob
    function: generate_birthdate
    parameters:
      minimum_age: 65
      maximum_age: 95

Output Sample

1985-06-15
1992-11-28
1978-03-04

Common Patterns

Order with Fulfillment Dates

columns:
  - name: order_date
    function: generate_date
    parameters:
      start_date: "-30d"
      end_date: "today"
  - name: ship_date
    function: generate_date
    parameters:
      reference_date_column: order_date
      days_offset: 2
  - name: delivery_date
    function: generate_date
    parameters:
      reference_date_column: ship_date
      days_offset: 5

Event with Start/End Times

columns:
  - name: event_start
    function: generate_datetime
    parameters:
      start_date: "+1d"
      end_date: "+30d"
  - name: event_end
    function: generate_datetime
    parameters:
      reference_date_column: event_start
      days_offset: 1

Contract Period

columns:
  - name: contract_start
    function: generate_date
  - name: contract_end
    function: generate_date
    parameters:
      reference_date_column: contract_start
      days_offset: 365

Date Format Patterns

Common format patterns for the pattern parameter:

PatternExampleDescription
%Y-%m-%d2024-03-15ISO date
%m/%d/%Y03/15/2024US date
%d/%m/%Y15/03/2024European date
%Y-%m-%dT%H:%M:%S2024-03-15T14:30:00ISO datetime
%B %d, %YMarch 15, 2024Long date
%Y2024Year only
%m-%Y03-2024Month-Year