Types (Parquet Column 1.6.0rc3 API)

java.lang.Object
- parquet.schema.Types

public class Types
extends Object

This class provides fluent builders that produce Parquet schema Types.

The most basic use is to build primitive types:

   Types.required(INT64).named("id");
   Types.optional(INT32).named("number");

The #required(PrimitiveTypeName) factory method produces a primitive type builder, and the Types.Builder.named(String) builds the PrimitiveType. Between required and named, other builder methods can be used to add type annotations or other type metadata:

   Types.required(BINARY).as(UTF8).named("username");
   Types.optional(FIXED_LEN_BYTE_ARRAY).length(20).named("sha1");

Optional types are built using #optional(PrimitiveTypeName) to get the builder.

Groups are built similarly, using requiredGroup() (or the optional version) to return a group builder. Group builders provide required and optional to add primitive types, which return primitive builders like the versions above.

   // This produces:
   // required group User {
   //   required int64 id;
   //   optional binary email (UTF8);
   // }
   Types.requiredGroup()
            .required(INT64).named("id")
            .required(BINARY).as(UTF8).named("email")
        .named("User")

When required is called on a group builder, the builder it returns will add the type to the parent group when it is built and named will return its parent group builder (instead of the type) so more fields can be added.

Sub-groups can be created using requiredGroup() to get a group builder that will create the group type, add it to the parent builder, and return the parent builder for more fields.

   // required group User {
   //   required int64 id;
   //   optional binary email (UTF8);
   //   optional group address {
   //     required binary street (UTF8);
   //     required int32 zipcode;
   //   }
   // }
   Types.requiredGroup()
            .required(INT64).named("id")
            .required(BINARY).as(UTF8).named("email")
            .optionalGroup()
                .required(BINARY).as(UTF8).named("street")
                .required(INT32).named("zipcode")
            .named("address")
        .named("User")

Message types are built using buildMessage() and function just like group builders.

   // message User {
   //   required int64 id;
   //   optional binary email (UTF8);
   //   optional group address {
   //     required binary street (UTF8);
   //     required int32 zipcode;
   //   }
   // }
   Types.buildMessage()
            .required(INT64).named("id")
            .required(BINARY).as(UTF8).named("email")
            .optionalGroup()
                .required(BINARY).as(UTF8).named("street")
                .required(INT32).named("zipcode")
            .named("address")
        .named("User")

These builders enforce consistency checks based on the specifications in the parquet-format documentation. For example, if DECIMAL is used to annotate a FIXED_LEN_BYTE_ARRAY that is not long enough for its maximum precision, these builders will throw an IllegalArgumentException:

   // throws IllegalArgumentException with message:
   // "FIXED(4) is not long enough to store 10 digits"
   Types.required(FIXED_LEN_BYTE_ARRAY).length(4)
        .as(DECIMAL).precision(10)
        .named("badDecimal");

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Types.Builder<T extends Types.Builder,P>` A base builder for `Type` objects.
`static class`	`Types.GroupBuilder<P>` A builder for `GroupType` objects.
`static class`	`Types.MessageTypeBuilder`
`static class`	`Types.PrimitiveBuilder<P>` A builder for `PrimitiveType` objects.

Constructor Summary

Constructors
Constructor and Description

Types()

Constructors
Constructor and Description
`Types()`

Method Summary

Methods
Modifier and Type	Method and Description
`static Types.GroupBuilder<GroupType>`	`buildGroup(Type.Repetition repetition)`
`static Types.MessageTypeBuilder`	`buildMessage()` Returns a builder to construct a `MessageType`.
`static Types.PrimitiveBuilder<PrimitiveType>`	`optional(PrimitiveType.PrimitiveTypeName type)` Returns a builder to construct an optional `PrimitiveType`.
`static Types.GroupBuilder<GroupType>`	`optionalGroup()` Returns a builder to construct an optional `GroupType`.
`static Types.PrimitiveBuilder<PrimitiveType>`	`primitive(PrimitiveType.PrimitiveTypeName type, Type.Repetition repetition)`
`static Types.PrimitiveBuilder<PrimitiveType>`	`repeated(PrimitiveType.PrimitiveTypeName type)` Returns a builder to construct a repeated `PrimitiveType`.
`static Types.GroupBuilder<GroupType>`	`repeatedGroup()` Returns a builder to construct a repeated `GroupType`.
`static Types.PrimitiveBuilder<PrimitiveType>`	`required(PrimitiveType.PrimitiveTypeName type)` Returns a builder to construct a required `PrimitiveType`.
`static Types.GroupBuilder<GroupType>`	`requiredGroup()` Returns a builder to construct a required `GroupType`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Types
```
public Types()
```
- Method Detail
  - buildMessage
```
public static Types.MessageTypeBuilder buildMessage()
```
    Returns a builder to construct a MessageType.
    
    Returns:
    a Types.MessageTypeBuilder
  - buildGroup
```
public static Types.GroupBuilder<GroupType> buildGroup(Type.Repetition repetition)
```
  - requiredGroup
```
public static Types.GroupBuilder<GroupType> requiredGroup()
```
    Returns a builder to construct a required GroupType.
    
    Returns:
    a Types.GroupBuilder
  - optionalGroup
```
public static Types.GroupBuilder<GroupType> optionalGroup()
```
    Returns a builder to construct an optional GroupType.
    
    Returns:
    a Types.GroupBuilder
  - repeatedGroup
```
public static Types.GroupBuilder<GroupType> repeatedGroup()
```
    Returns a builder to construct a repeated GroupType.
    
    Returns:
    a Types.GroupBuilder
  - primitive
```
public static Types.PrimitiveBuilder<PrimitiveType> primitive(PrimitiveType.PrimitiveTypeName type,
                                              Type.Repetition repetition)
```
  - required
```
public static Types.PrimitiveBuilder<PrimitiveType> required(PrimitiveType.PrimitiveTypeName type)
```
    Returns a builder to construct a required PrimitiveType.
    
    Parameters:
    type - a PrimitiveType.PrimitiveTypeName for the constructed type
    
    Returns:
    a Types.PrimitiveBuilder
  - optional
```
public static Types.PrimitiveBuilder<PrimitiveType> optional(PrimitiveType.PrimitiveTypeName type)
```
    Returns a builder to construct an optional PrimitiveType.
    
    Parameters:
    type - a PrimitiveType.PrimitiveTypeName for the constructed type
    
    Returns:
    a Types.PrimitiveBuilder
  - repeated
```
public static Types.PrimitiveBuilder<PrimitiveType> repeated(PrimitiveType.PrimitiveTypeName type)
```
    Returns a builder to construct a repeated PrimitiveType.
    
    Parameters:
    type - a PrimitiveType.PrimitiveTypeName for the constructed type
    
    Returns:
    a Types.PrimitiveBuilder

Class Types

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Types

Method Detail

buildMessage

buildGroup

requiredGroup

optionalGroup

repeatedGroup

primitive

required

optional

repeated