Skip to content
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

Deprecate TimestampArray from_vec and from_opt_vec #2919

Merged
merged 1 commit into from
Oct 24, 2022
Merged

Deprecate TimestampArray from_vec and from_opt_vec #2919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 17 additions & 14 deletions arrow-array/src/array/primitive_array.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ pub type Float64Array = PrimitiveArray<Float64Type>;
/// # use arrow_array::TimestampSecondArray;
/// use chrono::FixedOffset;
/// // Corresponds to single element array with entry 1970-05-09T14:25:11+0:00
/// let arr = TimestampSecondArray::from_vec(vec![11111111], None);
/// let arr = TimestampSecondArray::from(vec![11111111]);
/// // OR
/// let arr = TimestampSecondArray::from_opt_vec(vec![Some(11111111)], None);
/// let arr = TimestampSecondArray::from(vec![Some(11111111)]);
/// let utc_offset = FixedOffset::east(0);
///
/// assert_eq!(arr.value_as_datetime_with_tz(0, utc_offset).map(|v| v.to_string()).unwrap(), "1970-05-09 14:25:11")
Expand All @@ -131,9 +131,9 @@ pub type Float64Array = PrimitiveArray<Float64Type>;
/// # use arrow_array::TimestampSecondArray;
/// use chrono::FixedOffset;
/// // Corresponds to single element array with entry 1969-08-25T09:34:49+0:00
/// let arr = TimestampSecondArray::from_vec(vec![-11111111], None);
/// let arr = TimestampSecondArray::from(vec![-11111111]);
/// // OR
/// let arr = TimestampSecondArray::from_opt_vec(vec![Some(-11111111)], None);
/// let arr = TimestampSecondArray::from(vec![Some(-11111111)]);
/// let utc_offset = FixedOffset::east(0);
///
/// assert_eq!(arr.value_as_datetime_with_tz(0, utc_offset).map(|v| v.to_string()).unwrap(), "1969-08-25 09:34:49")
Expand All @@ -144,9 +144,9 @@ pub type Float64Array = PrimitiveArray<Float64Type>;
/// # use arrow_array::TimestampSecondArray;
/// use chrono::FixedOffset;
/// // Corresponds to single element array with entry 1970-05-10T00:25:11+10:00
/// let arr = TimestampSecondArray::from_vec(vec![11111111], Some("+10:00".to_string()));
/// let arr = TimestampSecondArray::from(vec![11111111]).with_timezone("+10:00".to_string());
/// // OR
/// let arr = TimestampSecondArray::from_opt_vec(vec![Some(11111111)], Some("+10:00".to_string()));
/// let arr = TimestampSecondArray::from(vec![Some(11111111)]).with_timezone("+10:00".to_string());
/// let sydney_offset = FixedOffset::east(10 * 60 * 60);
///
/// assert_eq!(arr.value_as_datetime_with_tz(0, sydney_offset).map(|v| v.to_string()).unwrap(), "1970-05-10 00:25:11")
Expand Down Expand Up @@ -761,6 +761,7 @@ def_numeric_from_vec!(TimestampNanosecondType);

impl<T: ArrowTimestampType> PrimitiveArray<T> {
/// Construct a timestamp array from a vec of i64 values and an optional timezone
#[deprecated(note = "Use with_timezone_opt instead")]
pub fn from_vec(data: Vec<i64>, timezone: Option<String>) -> Self
where
Self: From<Vec<i64>>,
Expand All @@ -769,6 +770,7 @@ impl<T: ArrowTimestampType> PrimitiveArray<T> {
}

/// Construct a timestamp array from a vec of `Option<i64>` values and an optional timezone
#[deprecated(note = "Use with_timezone_opt instead")]
pub fn from_opt_vec(data: Vec<Option<i64>>, timezone: Option<String>) -> Self
where
Self: From<Vec<Option<i64>>>,
Expand Down Expand Up @@ -1150,31 +1152,31 @@ mod tests {

#[test]
fn test_timestamp_array_from_vec() {
let arr = TimestampSecondArray::from_vec(vec![1, -5], None);
let arr = TimestampSecondArray::from(vec![1, -5]);
assert_eq!(2, arr.len());
assert_eq!(0, arr.offset());
assert_eq!(0, arr.null_count());
assert_eq!(1, arr.value(0));
assert_eq!(-5, arr.value(1));
assert_eq!(&[1, -5], arr.values());

let arr = TimestampMillisecondArray::from_vec(vec![1, -5], None);
let arr = TimestampMillisecondArray::from(vec![1, -5]);
assert_eq!(2, arr.len());
assert_eq!(0, arr.offset());
assert_eq!(0, arr.null_count());
assert_eq!(1, arr.value(0));
assert_eq!(-5, arr.value(1));
assert_eq!(&[1, -5], arr.values());

let arr = TimestampMicrosecondArray::from_vec(vec![1, -5], None);
let arr = TimestampMicrosecondArray::from(vec![1, -5]);
assert_eq!(2, arr.len());
assert_eq!(0, arr.offset());
assert_eq!(0, arr.null_count());
assert_eq!(1, arr.value(0));
assert_eq!(-5, arr.value(1));
assert_eq!(&[1, -5], arr.values());

let arr = TimestampNanosecondArray::from_vec(vec![1, -5], None);
let arr = TimestampNanosecondArray::from(vec![1, -5]);
assert_eq!(2, arr.len());
assert_eq!(0, arr.offset());
assert_eq!(0, arr.null_count());
Expand Down Expand Up @@ -1309,10 +1311,11 @@ mod tests {
#[test]
fn test_timestamp_fmt_debug() {
let arr: PrimitiveArray<TimestampMillisecondType> =
TimestampMillisecondArray::from_vec(
vec![1546214400000, 1546214400000, -1546214400000],
None,
);
TimestampMillisecondArray::from(vec![
1546214400000,
1546214400000,
-1546214400000,
]);
assert_eq!(
"PrimitiveArray<Timestamp(Millisecond, None)>\n[\n 2018-12-31T00:00:00,\n 2018-12-31T00:00:00,\n 1921-01-02T00:00:00,\n]",
format!("{:?}", arr)
Expand Down
46 changes: 20 additions & 26 deletions arrow-integration-test/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1240,34 +1240,28 @@ mod tests {
None,
Some(16584393546415),
]);
let ts_secs = TimestampSecondArray::from_opt_vec(
vec![None, Some(193438817552), None],
let ts_secs = TimestampSecondArray::from(vec![None, Some(193438817552), None]);
let ts_millis = TimestampMillisecondArray::from(vec![
None,
);
let ts_millis = TimestampMillisecondArray::from_opt_vec(
vec![None, Some(38606916383008), Some(58113709376587)],
None,
);
let ts_micros =
TimestampMicrosecondArray::from_opt_vec(vec![None, None, None], None);
let ts_nanos = TimestampNanosecondArray::from_opt_vec(
vec![None, None, Some(-6473623571954960143)],
Some(38606916383008),
Some(58113709376587),
]);
let ts_micros = TimestampMicrosecondArray::from(vec![None, None, None]);
let ts_nanos =
TimestampNanosecondArray::from(vec![None, None, Some(-6473623571954960143)]);
let ts_secs_tz = TimestampSecondArray::from(vec![None, Some(193438817552), None])
.with_timezone_opt(secs_tz);
let ts_millis_tz = TimestampMillisecondArray::from(vec![
None,
);
let ts_secs_tz = TimestampSecondArray::from_opt_vec(
vec![None, Some(193438817552), None],
secs_tz,
);
let ts_millis_tz = TimestampMillisecondArray::from_opt_vec(
vec![None, Some(38606916383008), Some(58113709376587)],
millis_tz,
);
let ts_micros_tz =
TimestampMicrosecondArray::from_opt_vec(vec![None, None, None], micros_tz);
let ts_nanos_tz = TimestampNanosecondArray::from_opt_vec(
vec![None, None, Some(-6473623571954960143)],
nanos_tz,
);
Some(38606916383008),
Some(58113709376587),
])
.with_timezone_opt(millis_tz);
let ts_micros_tz = TimestampMicrosecondArray::from(vec![None, None, None])
.with_timezone_opt(micros_tz);
let ts_nanos_tz =
TimestampNanosecondArray::from(vec![None, None, Some(-6473623571954960143)])
.with_timezone_opt(nanos_tz);
let utf8s = StringArray::from(vec![Some("aa"), None, Some("bbb")]);

let value_data = Int32Array::from(vec![None, Some(2), None, None]);
Expand Down
8 changes: 4 additions & 4 deletions arrow-select/src/filter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,22 +760,22 @@ mod tests {
def_temporal_test!(
test_filter_timestamp_second,
TimestampSecondArray,
TimestampSecondArray::from_vec(vec![1, 2, 3, 4], None)
TimestampSecondArray::from(vec![1, 2, 3, 4])
);
def_temporal_test!(
test_filter_timestamp_millisecond,
TimestampMillisecondArray,
TimestampMillisecondArray::from_vec(vec![1, 2, 3, 4], None)
TimestampMillisecondArray::from(vec![1, 2, 3, 4])
);
def_temporal_test!(
test_filter_timestamp_microsecond,
TimestampMicrosecondArray,
TimestampMicrosecondArray::from_vec(vec![1, 2, 3, 4], None)
TimestampMicrosecondArray::from(vec![1, 2, 3, 4])
);
def_temporal_test!(
test_filter_timestamp_nanosecond,
TimestampNanosecondArray,
TimestampNanosecondArray::from_vec(vec![1, 2, 3, 4], None)
TimestampNanosecondArray::from(vec![1, 2, 3, 4])
);

#[test]
Expand Down
9 changes: 5 additions & 4 deletions arrow-select/src/take.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1348,10 +1348,11 @@ mod tests {
fn test_take_preserve_timezone() {
let index = Int64Array::from(vec![Some(0), None]);

let input = TimestampNanosecondArray::from_vec(
vec![1_639_715_368_000_000_000, 1_639_715_368_000_000_000],
Some("UTC".to_owned()),
);
let input = TimestampNanosecondArray::from(vec![
1_639_715_368_000_000_000,
1_639_715_368_000_000_000,
])
.with_timezone("UTC".to_string());
let result = take_impl(&input, &index, None).unwrap();
match result.data_type() {
DataType::Timestamp(TimeUnit::Nanosecond, tz) => {
Expand Down
84 changes: 46 additions & 38 deletions arrow/src/compute/kernels/cast.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3793,10 +3793,12 @@ mod tests {

#[test]
fn test_cast_timestamp_to_date32() {
let a = TimestampMillisecondArray::from_opt_vec(
vec![Some(864000000005), Some(1545696000001), None],
Some(String::from("UTC")),
);
let a = TimestampMillisecondArray::from(vec![
Some(864000000005),
Some(1545696000001),
None,
])
.with_timezone("UTC".to_string());
let array = Arc::new(a) as ArrayRef;
let b = cast(&array, &DataType::Date32).unwrap();
let c = b.as_any().downcast_ref::<Date32Array>().unwrap();
Expand All @@ -3807,10 +3809,11 @@ mod tests {

#[test]
fn test_cast_timestamp_to_date64() {
let a = TimestampMillisecondArray::from_opt_vec(
vec![Some(864000000005), Some(1545696000001), None],
let a = TimestampMillisecondArray::from(vec![
Some(864000000005),
Some(1545696000001),
None,
);
]);
let array = Arc::new(a) as ArrayRef;
let b = cast(&array, &DataType::Date64).unwrap();
let c = b.as_any().downcast_ref::<Date64Array>().unwrap();
Expand All @@ -3821,10 +3824,12 @@ mod tests {

#[test]
fn test_cast_timestamp_to_i64() {
let a = TimestampMillisecondArray::from_opt_vec(
vec![Some(864000000005), Some(1545696000001), None],
Some("UTC".to_string()),
);
let a = TimestampMillisecondArray::from(vec![
Some(864000000005),
Some(1545696000001),
None,
])
.with_timezone("UTC".to_string());
let array = Arc::new(a) as ArrayRef;
let b = cast(&array, &DataType::Int64).unwrap();
let c = b.as_any().downcast_ref::<Int64Array>().unwrap();
Expand All @@ -3837,10 +3842,12 @@ mod tests {
#[test]
#[cfg(feature = "chrono-tz")]
fn test_cast_timestamp_to_string() {
let a = TimestampMillisecondArray::from_opt_vec(
vec![Some(864000000005), Some(1545696000001), None],
Some("UTC".to_string()),
);
let a = TimestampMillisecondArray::from(vec![
Some(864000000005),
Some(1545696000001),
None,
])
.with_timezone("UTC".to_string());
let array = Arc::new(a) as ArrayRef;
dbg!(&array);
let b = cast(&array, &DataType::Utf8).unwrap();
Expand Down Expand Up @@ -3875,10 +3882,11 @@ mod tests {

#[test]
fn test_cast_between_timestamps() {
let a = TimestampMillisecondArray::from_opt_vec(
vec![Some(864000003005), Some(1545696002001), None],
let a = TimestampMillisecondArray::from(vec![
Some(864000003005),
Some(1545696002001),
None,
);
]);
let array = Arc::new(a) as ArrayRef;
let b = cast(&array, &DataType::Timestamp(TimeUnit::Second, None)).unwrap();
let c = b.as_any().downcast_ref::<TimestampSecondArray>().unwrap();
Expand Down Expand Up @@ -5474,26 +5482,26 @@ mod tests {
Arc::new(UInt64Array::from(vec![1, 2])),
Arc::new(Float32Array::from(vec![1.0, 2.0])),
Arc::new(Float64Array::from(vec![1.0, 2.0])),
Arc::new(TimestampSecondArray::from_vec(vec![1000, 2000], None)),
Arc::new(TimestampMillisecondArray::from_vec(vec![1000, 2000], None)),
Arc::new(TimestampMicrosecondArray::from_vec(vec![1000, 2000], None)),
Arc::new(TimestampNanosecondArray::from_vec(vec![1000, 2000], None)),
Arc::new(TimestampSecondArray::from_vec(
vec![1000, 2000],
Some(tz_name.clone()),
)),
Arc::new(TimestampMillisecondArray::from_vec(
vec![1000, 2000],
Some(tz_name.clone()),
)),
Arc::new(TimestampMicrosecondArray::from_vec(
vec![1000, 2000],
Some(tz_name.clone()),
)),
Arc::new(TimestampNanosecondArray::from_vec(
vec![1000, 2000],
Some(tz_name),
)),
Arc::new(TimestampSecondArray::from(vec![1000, 2000])),
Arc::new(TimestampMillisecondArray::from(vec![1000, 2000])),
Arc::new(TimestampMicrosecondArray::from(vec![1000, 2000])),
Arc::new(TimestampNanosecondArray::from(vec![1000, 2000])),
Arc::new(
TimestampSecondArray::from(vec![1000, 2000])
.with_timezone(tz_name.clone()),
),
Arc::new(
TimestampMillisecondArray::from(vec![1000, 2000])
.with_timezone(tz_name.clone()),
),
Arc::new(
TimestampMicrosecondArray::from(vec![1000, 2000])
.with_timezone(tz_name.clone()),
),
Arc::new(
TimestampNanosecondArray::from(vec![1000, 2000])
.with_timezone(tz_name.clone()),
),
Arc::new(Date32Array::from(vec![1000, 2000])),
Arc::new(Date64Array::from(vec![1000, 2000])),
Arc::new(Time32SecondArray::from(vec![1000, 2000])),
Expand Down
Loading