Welcome to the new DOCS.vastdata.com. We've added new menus and a version selector, plus new persona and resource pages to help customers get started. Looking for a previous article? Use the docs search.

to_hours

Prev Next

Applies to VAST Cluster 5.5.

Functions › Date and time functions › Interval constructors. Returns an interval of n hours, the same as INTERVAL n HOUR. Add it to a date or a timestamp, or subtract it, to move by that many hours.

Syntax

to_hours(n)
Argument Type Description
n BIGINT; also INTEGER, SMALLINT, or a string that holds a whole number The number of hours. It can be negative.

Returns: INTERVAL.

Same as: INTERVAL n HOUR for a constant n.

Set up the examples

The examples connect with the ADBC driver, as in VAST Query Engine (ADBC), and work in a schema called docs_sql_fn_date_time_to_hours. Set QE_ENDPOINT, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and VASTDB_BUCKET (SQL reference), and run the blocks in order in one Python session. Below each block is the output you should see.

This block connects, defines the run() and plan() helpers, and creates a table of five tasks. Each has a start time (ts), a date (d), a whole number (n, an INTEGER) and a number with a fraction (f, a DOUBLE). Row 4 has no values:

import os
import re

import adbc_driver_manager
import adbc_driver_manager.dbapi as dbapi
import adbc_driver_vastdb

BUCKET = os.environ["VASTDB_BUCKET"]
SCHEMA = f'"{BUCKET}/docs_sql_fn_date_time_to_hours"'

conn = dbapi.connect(
    driver=adbc_driver_vastdb.get_driver_path(),
    db_kwargs={
        "vast.db.endpoint": os.environ["QE_ENDPOINT"],
        "vast.db.access_key": os.environ["AWS_ACCESS_KEY_ID"],
        "vast.db.secret_key": os.environ["AWS_SECRET_ACCESS_KEY"],
    },
    autocommit=True,
)

def server_message(e):
    """The server's message in a driver error, without the request ID or the echoed statement."""
    text = re.sub(r"\[req=0x[0-9a-f]+\]: ", "", str(e))
    found = (re.search(r'message: "(.*?)", request_id', text, re.S)
             or re.search(r"description: (.*)\)", text, re.S))
    message = found.group(1) if found else text.strip().splitlines()[-1]
    message = re.sub(r"^Plan query: '.*?' failed with: ", "", message, flags=re.S)
    message = re.split(r"\\n|\n", message)[0].replace('\\"', '"')
    return message.replace(BUCKET, "<bucket>")

def run(sql):
    """Run one statement. Print the rows it returns, or the error."""
    try:
        with conn.cursor() as cur:
            cur.execute(sql)
            rows = cur.fetchall() if cur.description else []
    except (adbc_driver_manager.Error, OSError) as e:
        print(f"{type(e).__name__}: {server_message(e)}")
    else:
        print(rows)

def plan(sql):
    """Print the plan without its ~N Rows lines: the table's row count, which can still be 0 just after an insert."""
    with conn.cursor() as cur:
        cur.execute("EXPLAIN " + sql)
        steps = cur.fetchall()[0][1]
    print("\n".join(line for line in steps.splitlines() if "Rows" not in line))

TABLE = f"{SCHEMA}.tasks"
run(f"CREATE SCHEMA IF NOT EXISTS {SCHEMA}")
run(f"CREATE TABLE IF NOT EXISTS {TABLE} (id BIGINT, ts TIMESTAMP, d DATE, n INTEGER, f DOUBLE)")
run(f"INSERT INTO {TABLE} VALUES "
    "(1, TIMESTAMP '2026-02-28 23:15:00', DATE '2026-01-31', 1, 1.5), "
    "(2, TIMESTAMP '2026-03-01 08:30:45.123456', DATE '2026-03-01', -2, -0.25), "
    "(3, TIMESTAMP '2024-12-30 12:00:00', DATE '2024-12-30', 0, 0.0), "
    "(4, NULL, NULL, NULL, NULL), "
    "(5, TIMESTAMP '2024-02-29 00:00:00', DATE '2024-02-29', 12, 0.000001)")
[]
[]
[(5,)]

What it does

An INTERVAL has three parts: months, days and a time part. ADBC returns it as an Arrow month-day-nanosecond interval, which Python prints as MonthDayNano(months=..., days=..., nanoseconds=...). The parts are kept apart: they're combined only when the interval is added to a date or a timestamp.

to_hours(n) puts n × 3,600 seconds in the time part, which Python shows in nanoseconds: to_hours(2) is nanoseconds=7200000000000. TIMESTAMP '2024-02-29 00:00:00' + to_hours(1) is 2024-02-29 01:00:00, and DATE '2026-01-31' + to_hours(1) is 2026-01-31 01:00:00, a TIMESTAMP.

The time part isn't turned into days: normalized_interval(to_hours(100)) turns 100 hours into 4 days and 4 hours. epoch(to_hours(1)) is 3600.0 seconds.

NULLs and edge cases

Input Result
NULL, or a NULL value (row 4) NULL
0 An empty interval: every part is 0
-1 A negative interval: one hour back
'2' (a string) The same as to_hours(2)
CAST(2 AS SMALLINT) The same as to_hours(2)
CAST(2 AS BIGINT) The same as to_hours(2)
A fraction, such as 1.5 Error: No function matches the given name and argument types 'to_hours(DECIMAL(2,1))'
2562047788 Accepted, but the result is wrong: a negative interval
2562047789 Error: Interval value 2562047789 hours out of range
A DATE, INTERVAL or BOOLEAN Error: No function matches the given name and argument types, for example 'to_hours(DATE)'

The same cases, as the cluster returns them. They use the table and helpers from Set up the examples:

run(f"SELECT id, to_hours(n) FROM {TABLE} WHERE id = 4")
run("SELECT to_hours(NULL), to_hours(0), to_hours(-1), to_hours('2'), to_hours(CAST(2 AS SMALLINT)), to_hours(CAST(2 AS BIGINT))")
run("SELECT to_hours(1.5)")
run("SELECT to_hours(2562047788)")
run("SELECT to_hours(2562047789)")
run("SELECT to_hours(DATE '2026-01-01')")
[(4, None)]
[(None, MonthDayNano(months=0, days=0, nanoseconds=0), MonthDayNano(months=0, days=0, nanoseconds=-3600000000000), MonthDayNano(months=0, days=0, nanoseconds=7200000000000), MonthDayNano(months=0, days=0, nanoseconds=7200000000000), MonthDayNano(months=0, days=0, nanoseconds=7200000000000))]
InternalError: Binder Error: No function matches the given name and argument types 'to_hours(DECIMAL(2,1))'. You might need to add explicit type casts.
[(MonthDayNano(months=0, days=0, nanoseconds=-54775808000),)]
OSError: Interval value 2562047789 hours out of range
InternalError: Binder Error: No function matches the given name and argument types 'to_hours(DATE)'. You might need to add explicit type casts.

Examples

An interval of n hours for each task:

run(f"SELECT id, n, to_hours(n) FROM {TABLE} ORDER BY id LIMIT 10")
[(1, 1, MonthDayNano(months=0, days=0, nanoseconds=3600000000000)), (2, -2, MonthDayNano(months=0, days=0, nanoseconds=-7200000000000)), (3, 0, MonthDayNano(months=0, days=0, nanoseconds=0)), (4, None, None), (5, 12, MonthDayNano(months=0, days=0, nanoseconds=43200000000000))]

Move each start time by n hours, and the last day of January by one hour:

run(f"SELECT id, ts, ts + to_hours(n) FROM {TABLE} ORDER BY id LIMIT 10")
run("SELECT DATE '2026-01-31' + to_hours(1), TIMESTAMP '2024-02-29 00:00:00' + to_hours(1), TIMESTAMP '2024-02-29 00:00:00' - to_hours(1)")
[(1, datetime.datetime(2026, 2, 28, 23, 15), datetime.datetime(2026, 3, 1, 0, 15)), (2, datetime.datetime(2026, 3, 1, 8, 30, 45, 123456), datetime.datetime(2026, 3, 1, 6, 30, 45, 123456)), (3, datetime.datetime(2024, 12, 30, 12, 0), datetime.datetime(2024, 12, 30, 12, 0)), (4, None, None), (5, datetime.datetime(2024, 2, 29, 0, 0), datetime.datetime(2024, 2, 29, 12, 0))]
[(datetime.datetime(2026, 1, 31, 1, 0), datetime.datetime(2024, 2, 29, 1, 0), datetime.datetime(2024, 2, 28, 23, 0))]

Keep only the tasks that, moved by n hours, end after midnight on 1 March 2026:

run(f"SELECT id FROM {TABLE} WHERE ts + to_hours(n) > TIMESTAMP '2026-03-01 00:00:00' ORDER BY id LIMIT 10")
[(1,), (2,)]

How it runs in VAST

The Query Engine runs on the cluster's CNodes, and a query on a table starts with a scan in VAST DataBase (VAST_SCAN). VAST DataBase can evaluate a comparison of a column with a constant, but not a function of a column, so an interval built from a column is always computed by the Query Engine:

  • In the SELECT list, the scan reads the column and the Query Engine computes to_hours() for each row it returns.
  • In WHERE, the scan sends the columns for every row, and a FILTER step in the Query Engine computes ts + to_hours(n) and keeps the rows that match. No rows are skipped in storage.

The plan of the WHERE example shows the FILTER step above the scan:

plan(f"SELECT id FROM {TABLE} WHERE ts + to_hours(n) > TIMESTAMP '2026-03-01 00:00:00'")
┌───────────────────────────┐
│         PROJECTION        │
│    ────────────────────   │
│             #2            │
│                           │
└─────────────┬─────────────┘
┌─────────────┴─────────────┐
│           FILTER          │
│    ────────────────────   │
│ ((ts + to_hours(CAST(n AS │
│   BIGINT))) > '2026-03-01 │
│    00:00:00'::TIMESTAMP)  │
│                           │
└─────────────┬─────────────┘
┌─────────────┴─────────────┐
│         VAST_SCAN         │
│    ────────────────────   │
│    Function: VAST_SCAN    │
│                           │
│        Projections:       │
│             ts            │
│             n             │
│             id            │
│                           │
└───────────────────────────┘

Make it faster

  • Put the interval on the constant side. A comparison of the raw column with a constant, such as ts > TIMESTAMP '2026-01-15 00:00:00' + to_days(30) or ts > TIMESTAMP '2026-03-01 00:00:00' - INTERVAL 1 HOUR, is pushed down to VAST DataBase, so rows that don't match never leave storage. ts + INTERVAL 1 HOUR > ... needs the FILTER step. The plan of the same shape with to_hours:
plan(f"SELECT id FROM {TABLE} WHERE ts > TIMESTAMP '2026-03-01 00:00:00' - to_hours(1)")
┌───────────────────────────┐
│         VAST_SCAN         │
│    ────────────────────   │
│    Function: VAST_SCAN    │
│      Projections: id      │
│                           │
└───────────────────────────┘
  • Store the result if you filter on it often. When the number of hours comes from a column, as n does here, there's no single constant to compare with. Compute ts + to_hours(n) when you write the rows and keep it in its own TIMESTAMP column; a comparison of that column with a constant is pushed down.

Limitations and errors

  • Whole numbers only. A fraction, such as 1.5, fails with No function matches the given name and argument types 'to_hours(DECIMAL(2,1))'. Use to_seconds, which takes a DOUBLE: to_seconds(5400) is an hour and a half.
  • Very large values come back wrong. Near the top of the range, the result is a wrong, negative interval: to_hours(2562047788) returns nanoseconds=-54775808000, and to_hours(2562047789) fails with Interval value 2562047789 hours out of range. Express spans that long in days, months or years.
  • No INTERVAL columns. A table can't have an INTERVAL column: CREATE TABLE fails with INTERVAL type is not supported in table definitions. Store the number of hours in a number column and build the interval with to_hours() in the query.
run(f"CREATE TABLE {SCHEMA}.durations (id BIGINT, v INTERVAL)")
InternalError: Binder Error: INTERVAL type is not supported in table definitions. Column "v" has type: INTERVAL

Similar functions

Function or form What it builds Result
INTERVAL 1 HOUR The same interval, written as a literal to_hours(1) = INTERVAL 1 HOUR is true
INTERVAL (n) HOUR The same interval; n can be a column
to_minutes 60 seconds each; to_hours(1) is to_minutes(60) to_hours(1) = to_minutes(60) is true
to_days Days, not a time part: to_days(1) = to_hours(24) is true
date_add Adds an interval to a date or timestamp: date_add(ts, to_hours(1)) is ts + to_hours(1)
normalized_interval Rewrites an interval so that 30 days become a month and 24 hours a day
run("SELECT to_hours(1) = INTERVAL 1 HOUR, to_hours(1) = to_minutes(60)")
run(f"SELECT id, to_hours(CAST(id AS INTEGER)) = INTERVAL (id) HOUR FROM {TABLE} ORDER BY id LIMIT 10")
run("SELECT date_add(TIMESTAMP '2024-02-29 00:00:00', to_hours(1)), normalized_interval(to_hours(100))")
[(True, True)]
[(1, True), (2, True), (3, True), (4, True), (5, True)]
[(datetime.datetime(2024, 2, 29, 1, 0), MonthDayNano(months=0, days=4, nanoseconds=14400000000000))]

Clean up:

run(f"DROP TABLE IF EXISTS {SCHEMA}.durations")
run(f"DROP TABLE IF EXISTS {TABLE}")
run(f"DROP SCHEMA IF EXISTS {SCHEMA}")
conn.close()
[]
[]
[]

See also