drizzle-team/drizzle-orm

[BUG]:

Open

#1826 opened on Jan 23, 2024

View on GitHub
 (8 comments) (9 reactions) (1 assignee)TypeScript (16,414 stars) (357 forks)batch import
good first issuehas-primprovementpriorityqb/crud

Description

What version of drizzle-orm are you using?

0.29.3

What version of drizzle-kit are you using?

n/a

Describe the Bug

Conditional helper functions such as isNull, isNotNull, exists, notExists cannot be used within a query select, without returning an unknown type.

const results = await db
    .select({
      id: table.id,
      has_title_orm: isNotNull(table.name),
      has_title_sql: sql<boolean>`${table.name} IS NOT NULL`,
    })
    .from(table);

  results[0].has_title_orm; // unknown type
  results[0].has_title_sql; // boolean type

Expected behavior

The sql wrapper used should be able to be typed for these boolean returns. I can imagine that there's a circumstance where you might not want to, given the fact these query helpers can be used in other places?

Environment & setup

Example Stackblitz: https://stackblitz.com/edit/typescript-5bbctn?file=index.ts

Contributor guide

Tech stack
typescriptnodejs
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript generics basicsfamiliarity with drizzle orm query building
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the type signatures of `isNull`, `isNotNull`, `exists`, and `notExists` in the drizzle orm source code (likely in the `sql` helper module). These conditional helpers currently return `unknown` when used in a select clause. The fix likely involves adding proper overloads or conditional return types to ensure they return `SQL<boolean>` or a similar typed wrapper. Compare with the `sql` template literal helper which correctly returns `boolean`. The issue includes a Stackblitz reproduction (https://stackblitz.com/edit/typescript 5bbctn?file=index.ts) that can be used to test potential solutions. The relevant function definitions are probably in a file like `src/sql/...` or `src/helpers/...`.