Skip to content

GH-551: [Java] Add TimeStamp*TZ support to ComplexCopier #1414

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

Open
henriquejsza wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH-551: [Java] Add TimeStamp*TZ support to ComplexCopier #1414

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
19 changes: 16 additions & 3 deletions vector/src/main/codegen/templates/ComplexCopier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@

<#include "/@includes/vv_imports.ftl" />

<#function is_timestamp_tz type>
<#return type?starts_with("TimeStamp") && type?ends_with("TZ")>
</#function>

/*
* This class is generated using freemarker and the ${.template_name} template.
*/
Expand Down Expand Up @@ -121,7 +125,7 @@ public static void copy(FieldReader reader, FieldWriter writer) {
<#assign fields = minor.fields!type.fields />
<#assign uncappedName = name?uncap_first/>

<#if !minor.typeParams?? || minor.class?starts_with("Decimal") >
<#if !minor.typeParams?? || minor.class?starts_with("Decimal") || is_timestamp_tz(minor.class) >

case ${name?upper_case}:
if (reader.isSet()) {
Expand Down Expand Up @@ -158,6 +162,15 @@ private static FieldWriter getStructWriterForReader(FieldReader reader, StructWr
return (FieldWriter) writer.${uncappedName}(name);
}
</#if>
<#if is_timestamp_tz(minor.class)>
case ${name?upper_case}:
if (reader.getField().getType() instanceof ArrowType.Timestamp) {
ArrowType.Timestamp type = (ArrowType.Timestamp) reader.getField().getType();
return (FieldWriter) writer.${uncappedName}(name, type.getTimezone());
} else {
return (FieldWriter) writer.${uncappedName}(name);
}
</#if>

</#list></#list>
case STRUCT:
Expand All @@ -182,7 +195,7 @@ private static FieldWriter getListWriterForReader(FieldReader reader, ListWriter
<#list vv.types as type><#list type.minor as minor><#assign name = minor.class?cap_first />
<#assign fields = minor.fields!type.fields />
<#assign uncappedName = name?uncap_first/>
<#if !minor.typeParams?? || minor.class?starts_with("Decimal") >
<#if !minor.typeParams?? || minor.class?starts_with("Decimal") || is_timestamp_tz(minor.class) >
case ${name?upper_case}:
return (FieldWriter) writer.<#if name == "Int">integer<#else>${uncappedName}</#if>();
</#if>
Expand All @@ -209,7 +222,7 @@ private static FieldWriter getMapWriterForReader(FieldReader reader, MapWriter w
<#list vv.types as type><#list type.minor as minor><#assign name = minor.class?cap_first />
<#assign fields = minor.fields!type.fields />
<#assign uncappedName = name?uncap_first/>
<#if !minor.typeParams?? || minor.class?starts_with("Decimal") >
<#if !minor.typeParams?? || minor.class?starts_with("Decimal") || is_timestamp_tz(minor.class) >

@jbonofre jbonofre Nov 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding the TZ types to the map lookup turns an UnsupportedOperationException into silently wrong data. UnionMapWriter only overrides the key/value getters for types without typeParams (plus decimal, decimal256 and fixedSizeBinary). So writer.value().timeStampNanoTZ() falls through to UnionListWriter.timeStampNanoTZ(), which returns the map writer itself. The value is then written into the map entries vector instead of the value field, and the entries vector gets promoted to a union.

Copying into MapVector.empty(...) would give the same result.

We could either:

  • drop the TZ case from getMapWriterForReader, so maps keep throwing and the list/struct support can land on its own, or
  • add TZ overrides to UnionMapWriter that route to the key/value fields of entryWriter and carry the timezone, as the struct path does?

case ${name?upper_case}:
return (FieldWriter) writer.<#if name == "Int">integer<#else>${uncappedName}</#if>();
</#if>
Expand Down
126 changes: 126 additions & 0 deletions vector/src/test/java/org/apache/arrow/vector/complex/impl/TestComplexCopier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,13 @@
*/
package org.apache.arrow.vector.complex.impl;

import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.math.BigDecimal;
import java.util.Arrays;
import java.util.UUID;
import org.apache.arrow.memory.BufferAllocator;
import org.apache.arrow.memory.RootAllocator;
Expand All @@ -36,8 +39,10 @@
import org.apache.arrow.vector.complex.writer.FieldWriter;
import org.apache.arrow.vector.extension.UuidType;
import org.apache.arrow.vector.holders.DecimalHolder;
import org.apache.arrow.vector.types.TimeUnit;
import org.apache.arrow.vector.types.Types;
import org.apache.arrow.vector.types.pojo.ArrowType;
import org.apache.arrow.vector.types.pojo.Field;
import org.apache.arrow.vector.types.pojo.FieldType;
import org.apache.arrow.vector.util.DecimalUtility;
import org.junit.jupiter.api.AfterEach;
Expand Down Expand Up @@ -954,4 +959,125 @@ public void testCopyStructVectorWithExtensionType() {
assertTrue(VectorEqualsVisitor.vectorEquals(from, to));
}
}

@Test
public void testCopyListOfTimeStampNanoTZVector() {
try (ListVector from = ListVector.empty("v", allocator);
ListVector to = ListVector.empty("v", allocator)) {
from.addOrGetVector(FieldType.nullable(new ArrowType.Timestamp(TimeUnit.NANOSECOND, "UTC")));
to.addOrGetVector(FieldType.nullable(new ArrowType.Timestamp(TimeUnit.NANOSECOND, "UTC")));

UnionListWriter listWriter = from.getWriter();
listWriter.allocate();
for (int i = 0; i < COUNT; i++) {
listWriter.setPosition(i);
listWriter.startList();
listWriter.timeStampNanoTZ().writeTimeStampNanoTZ(i * 1_000_000L);
listWriter.timeStampNanoTZ().writeTimeStampNanoTZ(i * 2_000_000L);
listWriter.endList();
}
from.setValueCount(COUNT);

// copy values
FieldReader in = from.getReader();
FieldWriter out = to.getWriter();
for (int i = 0; i < COUNT; i++) {
in.setPosition(i);
out.setPosition(i);
ComplexCopier.copy(in, out);
}
to.setValueCount(COUNT);

// validate equals
assertTrue(VectorEqualsVisitor.vectorEquals(from, to));
}
}

@Test
public void testCopyStructOfTimeStampNanoTZVector() {
try (final StructVector from = StructVector.empty("v", allocator);
final StructVector to = StructVector.empty("v", allocator)) {
from.allocateNewSafe();

NullableStructWriter structWriter = from.getWriter();
for (int i = 0; i < COUNT; i++) {
structWriter.setPosition(i);
structWriter.start();
structWriter.timeStampNanoTZ("ts", "UTC").writeTimeStampNanoTZ(i * 1_000_000L);
structWriter.end();
}
from.setValueCount(COUNT);

// copy values
FieldReader in = from.getReader();
FieldWriter out = to.getWriter();
for (int i = 0; i < COUNT; i++) {
in.setPosition(i);
out.setPosition(i);
ComplexCopier.copy(in, out);
}
to.setValueCount(COUNT);

// validate equals
assertTrue(VectorEqualsVisitor.vectorEquals(from, to));
}
}

@Test
public void testCopyMapOfTimeStampNanoTZVector() {
// Before the fix ComplexCopier.getMapWriterForReader threw
// UnsupportedOperationException for a TimeStamp*TZ map value. The map value
// child is pre-typed so the reader reports TIMESTAMPNANOTZ and the map case
// is actually exercised. vectorEquals is not asserted because the MapWriter
// scalar API has no timezone overload (unlike StructWriter), so the copied
// value child does not round-trip to the same timezone; this test locks in
// that copying the map no longer throws.
Field key = new Field("key", FieldType.notNullable(new ArrowType.Int(32, true)), null);
Field value =
new Field(
"value",
FieldType.nullable(new ArrowType.Timestamp(TimeUnit.NANOSECOND, "UTC")),
null);
Field entries =
new Field(
MapVector.DATA_VECTOR_NAME,
FieldType.notNullable(ArrowType.Struct.INSTANCE),
Arrays.asList(key, value));
Field mapField =
new Field("v", FieldType.nullable(new ArrowType.Map(false)), Arrays.asList(entries));

try (final MapVector from = (MapVector) mapField.createVector(allocator);
final MapVector to = MapVector.empty("v", allocator, false)) {

from.allocateNew();

UnionMapWriter mapWriter = from.getWriter();
for (int i = 0; i < COUNT; i++) {
mapWriter.setPosition(i);
mapWriter.startMap();
mapWriter.startEntry();
mapWriter.key().integer().writeInt(i);
mapWriter.value().timeStampNanoTZ().writeTimeStampNanoTZ(i * 1_000_000L);

@jbonofre jbonofre Nov 13, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test can't catch the problem mentioned above, because the source map is already malformed. mapWriter.value().timeStampNanoTZ() hits the same missing UnionMapWriter override, so from already has its entries promoted to a union and no value data. The comment at the top of the test blames the mismatch on timezones, but I think both sides are UTC here, the vectors differ in structure, not timezone.

Could we build the source directly on the vectors (startNewValue/endValue on the map, set key/value on the entries StructVector)? Then use a non-UTC zone and assert VectorEqualsVisitor.vectorEquals(from, to) instead of assertDoesNotThrow plus the value count. If we drop the map case instead, an assertThrows(UnsupportedOperationException.class, ...) would document that maps are not support yet 😄

mapWriter.endEntry();
mapWriter.endMap();
}

from.setValueCount(COUNT);

// copy values
FieldReader in = from.getReader();
FieldWriter out = to.getWriter();
assertDoesNotThrow(
() -> {
for (int i = 0; i < COUNT; i++) {
in.setPosition(i);
out.setPosition(i);
ComplexCopier.copy(in, out);
}
});
to.setValueCount(COUNT);

assertEquals(from.getValueCount(), to.getValueCount());
}
}
}
Loading