-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cc4a0df
commit 181600e
Showing
2 changed files
with
98 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -85,3 +85,11 @@ SQL Functions | |
trigonometry | ||
|
||
.. grid-item-card:: | ||
|
||
**Types** | ||
^^^^^^^^^ | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
types |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
Types | ||
===== | ||
|
||
.. list-table:: | ||
:header-rows: 1 | ||
:widths: 20 60 | ||
|
||
* - Function | ||
- Description | ||
* - :ref:`CAST <cast>` | ||
- Convert a value to a different datatype. | ||
* - :ref:`TRY_CAST <try_cast>` | ||
- Convert a value to a different datatype, returning NULL if the conversion fails. | ||
|
||
|
||
.. _cast: | ||
|
||
CAST | ||
---- | ||
Convert a value to a different datatype. | ||
|
||
Note that the more compact PostgreSQL `<expr>::type` syntax is also supported. | ||
|
||
**Example:** | ||
|
||
.. code-block:: python | ||
df = pl.DataFrame( | ||
{ | ||
"foo": [20, 10, 30], | ||
"bar": ["1999-12-31", "2012-07-05", "2024-01-01"], | ||
} | ||
) | ||
df.sql(""" | ||
SELECT | ||
foo::float4, | ||
bar::date | ||
FROM self | ||
""") | ||
# shape: (3, 2) | ||
# ┌──────┬────────────┐ | ||
# │ foo ┆ bar │ | ||
# │ --- ┆ --- │ | ||
# │ f32 ┆ date │ | ||
# ╞══════╪════════════╡ | ||
# │ 20.0 ┆ 1999-12-31 │ | ||
# │ 10.0 ┆ 2012-07-05 │ | ||
# │ 30.0 ┆ 2024-01-01 │ | ||
# └──────┴────────────┘ | ||
.. _try_cast: | ||
|
||
TRY_CAST | ||
-------- | ||
Convert a value to a different datatype, returning `NULL` if the conversion fails. | ||
|
||
**Example:** | ||
|
||
.. code-block:: python | ||
df = pl.DataFrame( | ||
{ | ||
"foo": [65432, 101010, -33333], | ||
"bar": ["1999-12-31", "N/A", "2024-01-01"], | ||
} | ||
) | ||
df.sql(""" | ||
SELECT | ||
TRY_CAST(foo AS uint2), | ||
TRY_CAST(bar AS date) | ||
FROM self | ||
""") | ||
# shape: (3, 2) | ||
# ┌───────┬────────────┐ | ||
# │ foo ┆ bar │ | ||
# │ --- ┆ --- │ | ||
# │ u16 ┆ date │ | ||
# ╞═══════╪════════════╡ | ||
# │ 65432 ┆ 1999-12-31 │ | ||
# │ 10101 ┆ null │ | ||
# │ null ┆ 2024-01-01 │ | ||
# └───────┴────────────┘ | ||
Note that with a regular `CAST` this would fail with the following error: | ||
|
||
.. code-block:: | ||
InvalidOperationError: | ||
conversion from `i64` to `u16` failed in column 'foo' for 1 out of 3 values: [-33333] |