feat: pickTableColumns utility function and update documentation

drizzle-team · Jan 9, 2025 · 8bb827a · 8bb827a
1 parent 04c9143
commit 8bb827a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/docs/table-introspect-api.md b/docs/table-introspect-api.md
@@ -30,3 +30,17 @@ const table = pgTable('table', {
 
 const columns/*: { id: ..., name: ... } */ = getTableColumns(table);
 ```
+
+```ts
+import { pgTable, pickTableColumns } from 'drizzle-orm/pg-core';
+
+const table = pgTable('table', {
+  id: integer('id').primaryKey(),
+  name: text('name'),
+});
+
+const colums = pickTableColumns(table, {
+  id: true,
+  name: false,
+});
+```
diff --git a/drizzle-orm/src/utils.ts b/drizzle-orm/src/utils.ts
@@ -188,6 +188,16 @@ export function getTableColumns<T extends Table>(table: T): T['_']['columns'] {
 	return table[Table.Symbol.Columns];
 }
 
+export function pickTableColumns<T extends Table>(
+  table: T,
+  includedColumns: Partial<Record<keyof T['_']['columns'], true>>
+): Pick<T['_']['columns'], keyof typeof includedColumns> {
+  const allColumns = table[Table.Symbol.Columns];
+  return Object.fromEntries(
+    Object.entries(allColumns).filter(([key]) => key in includedColumns)
+  ) as any;
+}
+
 export function getViewSelectedFields<T extends View>(view: T): T['_']['selectedFields'] {
 	return view[ViewBaseConfig].selectedFields;
 }