Skip to content

[BUG-1183]: Display geo types as 'geometry' / 'geography' instead of wkb #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jiayuasu merged 5 commits into from
Sep 5, 2025
Merged

[BUG-1183]: Display geo types as 'geometry' / 'geography' instead of wkb #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b02f449
Display geometry / geography instead of wkb in header
petern48 Sep 5, 2025
15ea0e1
Fix output type in existing test
petern48 Sep 5, 2025
1f94360
Merge branch 'main' into display_geo_types + fix merge conflicts in s…
petern48 Sep 5, 2025
5218112
Update rust/sedona/src/show.rs
petern48 Sep 5, 2025
ec582bf
Fix python docstring tests
petern48 Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion python/sedonadb/python/sedonadb/context.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ def view(self, name: str) -> DataFrame:
>>> con.view("foofy").show()
┌────────────┐
│ geom │
│ wkb │
│ geometry │
╞════════════╡
│ POINT(0 1) │
└────────────┘
Expand Down
6 changes: 3 additions & 3 deletions python/sedonadb/python/sedonadb/dataframe.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def to_view(self, name: str, overwrite: bool = False):
>>> con.view("foofy").show()
┌────────────┐
│ geom │
│ wkb │
│ geometry │
╞════════════╡
│ POINT(0 1) │
└────────────┘
Expand All @@ -187,7 +187,7 @@ def collect(self) -> "DataFrame":
>>> con.sql("SELECT ST_Point(0, 1) as geom").collect().show()
┌────────────┐
│ geom │
│ wkb │
│ geometry │
╞════════════╡
│ POINT(0 1) │
└────────────┘
Expand Down Expand Up @@ -287,7 +287,7 @@ def show(
>>> con.sql("SELECT ST_Point(0, 1) as geometry").show()
┌────────────┐
│ geometry │
│ wkb │
│ geometry │
╞════════════╡
│ POINT(0 1) │
└────────────┘
Expand Down
1 change: 1 addition & 0 deletions rust/sedona/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ s2geography = ["dep:sedona-s2geography"]

[dev-dependencies]
tokio = { workspace = true, features = ["rt-multi-thread"] }
rstest = { workspace = true }

[dependencies]
abi_stable = { workspace = true }
Expand Down
95 changes: 86 additions & 9 deletions rust/sedona/src/show.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use datafusion_common::format::DEFAULT_FORMAT_OPTIONS;
use datafusion_common::{DataFusionError, ScalarValue};
use datafusion_expr::{ColumnarValue, ReturnFieldArgs, ScalarFunctionArgs, ScalarUDF};
use sedona_expr::scalar_udf::{ArgMatcher, SedonaScalarUDF};
use sedona_schema::datatypes::SedonaType;
use sedona_schema::datatypes::{Edges, SedonaType};
use std::iter::zip;
use std::sync::Arc;

Expand Down Expand Up @@ -392,13 +392,17 @@ impl DisplayColumn {
pub fn header(&self, options: &DisplayTableOptions) -> Cell {
// Don't print the type ever if it's a continuation column
let is_continuation = self.name == "…" || self.name == "...";
let display_type = match &self.sedona_type {
SedonaType::Wkb(Edges::Planar, _) | SedonaType::WkbView(Edges::Planar, _) => {
"geometry".to_string()
}
SedonaType::Wkb(Edges::Spherical, _) | SedonaType::WkbView(Edges::Spherical, _) => {
"geography".to_string()
}
_ => self.sedona_type.to_string().to_lowercase(),
};
if options.arrow_options.types_info() && !is_continuation {
Cell::new(format!(
"{}\n{}",
self.name,
self.sedona_type.to_string().to_lowercase()
))
.set_delimiter('\0')
Cell::new(format!("{}\n{}", self.name, display_type)).set_delimiter('\0')
} else {
Cell::new(self.name.clone()).set_delimiter('\0')
}
Expand Down Expand Up @@ -524,7 +528,10 @@ impl DisplayColumn {
#[cfg(test)]
mod test {

use sedona_schema::datatypes::WKB_GEOMETRY;
use rstest::rstest;
use sedona_schema::datatypes::{
WKB_GEOGRAPHY, WKB_GEOMETRY, WKB_VIEW_GEOGRAPHY, WKB_VIEW_GEOMETRY,
};
use sedona_testing::create::create_array;

use super::*;
Expand Down Expand Up @@ -683,6 +690,76 @@ mod test {
);
}

#[rstest]
#[case(WKB_GEOMETRY)]
#[case(WKB_VIEW_GEOMETRY)]
fn geometry_header(#[case] sedona_type: SedonaType) {
let cols = vec![(
"geometry",
(
sedona_type.clone(),
create_array(
&[
Some("POINT (0 1)"),
Some("POLYGON ((0 0, 1 0, 0 1, 0 0))"),
None,
],
&sedona_type,
) as ArrayRef,
),
)];

let mut options = DisplayTableOptions::new();
options.table_width = 50;
assert_eq!(
render_cols(cols.clone(), options.clone()),
vec![
"+----------------------------+",
"| geometry |",
"+----------------------------+",
"| POINT(0 1) |",
"| POLYGON((0 0,1 0,0 1,0 0)) |",
"| |",
"+----------------------------+"
]
);
}

#[rstest]
#[case(WKB_GEOGRAPHY)]
#[case(WKB_VIEW_GEOGRAPHY)]
fn geography_header(#[case] sedona_type: SedonaType) {
let cols = vec![(
"geography",
(
sedona_type.clone(),
create_array(
&[
Some("POINT (0 1)"),
Some("POLYGON ((0 0, 1 0, 0 1, 0 0))"),
None,
],
&sedona_type,
) as ArrayRef,
),
)];

let mut options = DisplayTableOptions::new();
options.table_width = 50;
assert_eq!(
render_cols(cols.clone(), options.clone()),
vec![
"+----------------------------+",
"| geography |",
"+----------------------------+",
"| POINT(0 1) |",
"| POLYGON((0 0,1 0,0 1,0 0)) |",
"| |",
"+----------------------------+"
]
);
}

#[test]
fn render_col_type() {
let mut options = DisplayTableOptions::new();
Expand All @@ -693,7 +770,7 @@ mod test {
vec![
"+------+--------------+-----------+--------------+",
"| shrt | long | numeric | geometry |",
"| utf8 | utf8 | int32 | wkb |",
"| utf8 | utf8 | int32 | geometry |",
"+------+--------------+-----------+--------------+",
"| abcd | you see, ... | 123456789 | POINT(0 1) |",
"| efgh | the eleph... | 987654321 | POLYGON((... |",
Expand Down