ai.rapids.cudf

Class ArrowIPCWriterOptions.Builder

java.lang.Object

ai.rapids.cudf.WriterOptions.WriterBuilder<ArrowIPCWriterOptions.Builder>

ai.rapids.cudf.ArrowIPCWriterOptions.Builder

Enclosing class:

ArrowIPCWriterOptions

public static class ArrowIPCWriterOptions.Builder
extends WriterOptions.WriterBuilder<ArrowIPCWriterOptions.Builder>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ArrowIPCWriterOptions	build()
ArrowIPCWriterOptions.Builder	withCallback(ArrowIPCWriterOptions.DoneOnGpu callback)
ArrowIPCWriterOptions.Builder	withColumnNames(String... columnNames) Add the name(s) for nullable column(s).
ArrowIPCWriterOptions.Builder	withMaxChunkSize(long size)
ArrowIPCWriterOptions.Builder	withNotNullableColumnNames(String... columnNames) Add the name(s) for non-nullable column(s).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withMaxChunkSize

public ArrowIPCWriterOptions.Builder withMaxChunkSize(long size)

withCallback

public ArrowIPCWriterOptions.Builder withCallback(ArrowIPCWriterOptions.DoneOnGpu callback)

withColumnNames

public ArrowIPCWriterOptions.Builder withColumnNames(String... columnNames)

Add the name(s) for nullable column(s). Please note the column names of the nested struct columns should be flattened in sequence. For examples,

   A table with an int column and a struct column:
                   ["int_col", "struct_col":{"field_1", "field_2"}]
   output:
                   ["int_col", "struct_col", "field_1", "field_2"]

   A table with an int column and a list of non-nested type column:
                   ["int_col", "list_col":[]]
   output:
                   ["int_col", "list_col"]

   A table with an int column and a list of struct column:
                   ["int_col", "list_struct_col":[{"field_1", "field_2"}]]
   output:
                   ["int_col", "list_struct_col", "field_1", "field_2"]
 

Overrides:

withColumnNames in class WriterOptions.WriterBuilder<ArrowIPCWriterOptions.Builder>

Parameters:

columnNames - The column names corresponding to the written table(s).

withNotNullableColumnNames

public ArrowIPCWriterOptions.Builder withNotNullableColumnNames(String... columnNames)

Add the name(s) for non-nullable column(s). Please note the column names of the nested struct columns should be flattened in sequence. For examples,

   A table with an int column and a struct column:
                   ["int_col", "struct_col":{"field_1", "field_2"}]
   output:
                   ["int_col", "struct_col", "field_1", "field_2"]

   A table with an int column and a list of non-nested type column:
                   ["int_col", "list_col":[]]
   output:
                   ["int_col", "list_col"]

   A table with an int column and a list of struct column:
                   ["int_col", "list_struct_col":[{"field_1", "field_2"}]]
   output:
                   ["int_col", "list_struct_col", "field_1", "field_2"]
 

Overrides:

withNotNullableColumnNames in class WriterOptions.WriterBuilder<ArrowIPCWriterOptions.Builder>

Parameters:

columnNames - The column names corresponding to the written table(s).

build

public ArrowIPCWriterOptions build()