File tree Expand file tree Collapse file tree 1 file changed +17
-2
lines changed
src/pydiverse/transform/_internal/pipe Expand file tree Collapse file tree 1 file changed +17
-2
lines changed Original file line number Diff line number Diff line change @@ -146,17 +146,32 @@ def export(
146
146
147
147
Parameters
148
148
----------
149
- The pydiverse.transform Table or column expression to be exported.
150
-
151
149
target
152
150
Can currently be either a `Polars` or `Pandas` object. For polars, one can
153
151
specify whether a DataFrame or LazyFrame is returned via the `lazy` kwarg.
154
152
If `lazy=True`, no actual computations are performed, they just get stored in
155
153
the LazyFrame.
156
154
155
+ schema_overrides
156
+ A dictionary of columns to backend-specific data types. This controls which data
157
+ types are used when writing to the backend. Because the data types are not
158
+ constrained by pydiverse.transform's type system, this may sometimes be
159
+ preferred over a `cast`.
160
+
157
161
Returns
158
162
-------
159
163
A polars or pandas DataFrame / LazyFrame or a series.
164
+
165
+
166
+ Note
167
+ ----
168
+ This verb can be used with a Table or column expression on the left. When applied to
169
+ a column expression, all tables containing columns in the expression tree are
170
+ gathered and the expression is exported with respect to the most recent table. This
171
+ means that there has to be one column in the expression tree, whose table is a
172
+ common ancestor of all others. If this is not the case, the export fails. Anonymous
173
+ columns (`C`-columns) can be used in the expression and are interpreted with respect
174
+ to this common ancestor table.
160
175
"""
161
176
if isinstance (data , ColExpr ):
162
177
# Find the common ancestor of all AST nodes of columns appearing in the
You can’t perform that action at this time.
0 commit comments