Skip to content

Commit 0919738

Browse files
Use HTML table to type mapping comment
1 parent b3f2fb5 commit 0919738

File tree

1 file changed

+34
-31
lines changed

1 file changed

+34
-31
lines changed

adapter/avro/src/main/java/org/apache/arrow/adapter/avro/ArrowToAvroUtils.java

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -118,37 +118,40 @@ public class ArrowToAvroUtils {
118118
* <p>This method currently performs following type mapping for Avro data types to corresponding
119119
* Arrow data types.
120120
*
121-
* <ul>
122-
* <li>ArrowType.Null --> NULL
123-
* <li>ArrowType.Bool --> BOOLEAN
124-
* <li>ArrowType.Int(64 bit, unsigned 32 bit) --> LONG
125-
* <li>ArrowType.Int(signed 32 bit, < 32 bit) --> INT
126-
* <li>ArrowType.FloatingPoint(double) --> DOUBLE
127-
* <li>ArrowType.FloatingPoint(single, half) --> FLOAT
128-
* <li>ArrowType.Utf8 --> STRING
129-
* <li>ArrowType.LargeUtf8 --> STRING
130-
* <li>ArrowType.Binary --> BYTES
131-
* <li>ArrowType.LargeBinary --> BYTES
132-
* <li>ArrowType.FixedSizeBinary --> FIXED
133-
* <li>ArrowType.Decimal --> decimal (FIXED)
134-
* <li>ArrowType.Date --> date (INT)
135-
* <li>ArrowType.Time (SEC | MILLI) --> time-millis (INT)
136-
* <li>ArrowType.Time (MICRO | NANO) --> time-micros (LONG)
137-
* <li>ArrowType.Timestamp (NANOSECONDS, TZ != NULL) --> time-nanos (LONG)
138-
* <li>ArrowType.Timestamp (MICROSECONDS, TZ != NULL) --> time-micros (LONG)
139-
* <li>ArrowType.Timestamp (MILLISECONDS | SECONDS, TZ != NULL) --> time-millis (LONG)
140-
* <li>ArrowType.Timestamp (NANOSECONDS, TZ == NULL) --> local-time-nanos (LONG)
141-
* <li>ArrowType.Timestamp (MICROSECONDS, TZ == NULL) --> local-time-micros (LONG)
142-
* <li>ArrowType.Timestamp (MILLISECONDS | SECONDS, TZ == NULL) --> local-time-millis (LONG)
143-
* <li>ArrowType.Duration --> duration (FIXED)
144-
* <li>ArrowType.Interval --> duration (FIXED)
145-
* <li>ArrowType.Struct --> record
146-
* <li>ArrowType.List --> array
147-
* <li>ArrowType.LargeList --> array
148-
* <li>ArrowType.FixedSizeList --> array
149-
* <li>ArrowType.Map --> map
150-
* <li>ArrowType.Union --> union
151-
* </ul>
121+
* <table>
122+
* <thead><tr><th>Arrow type</th><th>Avro encoding</th></tr></thead>
123+
* <tbody>
124+
* <tr><td>ArrowType.Null</td><td>NULL</td></tr>
125+
* <tr><td>ArrowType.Bool</td><td>BOOLEAN</td></tr>
126+
* <tr><td>ArrowType.Int(64 bit, unsigned 32 bit)</td><td>LONG</td></tr>
127+
* <tr><td>ArrowType.Int(signed 32 bit, &lt; 32 bit)</td><td>INT</td></tr>
128+
* <tr><td>ArrowType.FloatingPoint(double)</td><td>DOUBLE</td></tr>
129+
* <tr><td>ArrowType.FloatingPoint(single, half)</td><td>FLOAT</td></tr>
130+
* <tr><td>ArrowType.Utf8</td><td>STRING</td></tr>
131+
* <tr><td>ArrowType.LargeUtf8</td><td>STRING</td></tr>
132+
* <tr><td>ArrowType.Binary</td><td>BYTES</td></tr>
133+
* <tr><td>ArrowType.LargeBinary</td><td>BYTES</td></tr>
134+
* <tr><td>ArrowType.FixedSizeBinary</td><td>FIXED</td></tr>
135+
* <tr><td>ArrowType.Decimal</td><td>decimal (FIXED)</td></tr>
136+
* <tr><td>ArrowType.Date</td><td>date (INT)</td></tr>
137+
* <tr><td>ArrowType.Time (SEC | MILLI)</td><td>time-millis (INT)</td></tr>
138+
* <tr><td>ArrowType.Time (MICRO | NANO)</td><td>time-micros (LONG)</td></tr>
139+
* <tr><td>ArrowType.Timestamp (NANOSECONDS, TZ != NULL)</td><td>time-nanos (LONG)</td></tr>
140+
* <tr><td>ArrowType.Timestamp (MICROSECONDS, TZ != NULL)</td><td>time-micros (LONG)</td></tr>
141+
* <tr><td>ArrowType.Timestamp (MILLISECONDS | SECONDS, TZ != NULL)</td><td>time-millis (LONG)</td></tr>
142+
* <tr><td>ArrowType.Timestamp (NANOSECONDS, TZ == NULL)</td><td>local-time-nanos (LONG)</td></tr>
143+
* <tr><td>ArrowType.Timestamp (MICROSECONDS, TZ == NULL)</td><td>local-time-micros (LONG)</td></tr>
144+
* <tr><td>ArrowType.Timestamp (MILLISECONDS | SECONDS, TZ == NULL)</td><td>local-time-millis (LONG)</td></tr>
145+
* <tr><td>ArrowType.Duration</td><td>duration (FIXED)</td></tr>
146+
* <tr><td>ArrowType.Interval</td><td>duration (FIXED)</td></tr>
147+
* <tr><td>ArrowType.Struct</td><td>record</td></tr>
148+
* <tr><td>ArrowType.List</td><td>array</td></tr>
149+
* <tr><td>ArrowType.LargeList</td><td>array</td></tr>
150+
* <tr><td>ArrowType.FixedSizeList</td><td>array</td></tr>
151+
* <tr><td>ArrowType.Map</td><td>map</td></tr>
152+
* <tr><td>ArrowType.Union</td><td>union</td></tr>
153+
* </tbody>
154+
* </table>
152155
*
153156
* <p>Nullable fields are represented as a union of [null | base-type]. Special treatment is given
154157
* to nullability of unions - a union is considered nullable if the union field is nullable or any

0 commit comments

Comments
 (0)