You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Clarify transformer is for value transforms, not legacy
- Remove "Legacy" label from transformer documentation
- Emphasize transformer is for VALUE transformations (e.g., decryption, computed fields)
- Clarify columnMapper is for COLUMN NAME transformations
- Run eslint --fix on column-mapper.ts
Copy file name to clipboardExpand all lines: website/docs/api/clients/typescript.md
+55-15Lines changed: 55 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -477,37 +477,77 @@ shape.subscribe((data) => {
477
477
})
478
478
```
479
479
480
-
**Transformer**
481
-
482
-
While the parser operates on individual fields, the transformer allows you to modify the entire record after the parser has run.
480
+
**Column Mapping**
483
481
484
-
This can be used to convert field names to camelCase or rename fields.
482
+
For transforming column names between database format (e.g., snake_case) and application format (e.g., camelCase), use the `columnMapper` option. This provides bidirectional transformation, automatically encoding column names in WHERE clauses and decoding them in query results.
While the parser operates on individual fields and columnMapper renames columns, the transformer allows you to modify the entire record for value transformations like client-side decryption of end-to-end encrypted data, computing derived fields, or other data processing.
533
+
534
+
**Note:** For column name transformations (snake_case ↔ camelCase), use `columnMapper` instead. The transformer is specifically for transforming values, not column names.
0 commit comments