ArrowIPCWriterOptions#

public class ArrowIPCWriterOptions extends WriterOptions#

Settings for writing Arrow IPC data.

Field Summary

DEFAULT

Method Summary

`builder()`
`getCallback()`
`getColumnNames()`
`getColumnNullability()`
`getMaxChunkSize()`

Static Fields

public static final ArrowIPCWriterOptions DEFAULT#

Methods

public long getMaxChunkSize()#

public DoneOnGpu getCallback()#

public String[] getColumnNames()#

public boolean[] getColumnNullability()#

Static Methods

public static Builder builder()#

public interface DoneOnGpu#

Method Summary

doneWithTheGpu(Table table)

A callback to indicate that the table is off of the GPU and may be closed, even if all of the data is not yet written.

Methods

public void doneWithTheGpu(Table table)#

A callback to indicate that the table is off of the GPU and may be closed, even if all of the data is not yet written.

Parameters:: table – the table that can be closed.

public static class Builder extends WriterBuilder<Builder>#

Method Summary

`build()`
`withCallback(DoneOnGpu callback)`
`withColumnNames(String... columnNames)`	Add the name(s) for nullable column(s).
`withMaxChunkSize(long size)`
`withNotNullableColumnNames(String... columnNames)`	Add the name(s) for non-nullable column(s).

Methods

public Builder withMaxChunkSize(long size)#

public Builder withCallback(DoneOnGpu callback)#

public 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"]

Parameters:: columnNames – The column names corresponding to the written table(s).

public 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"]

Parameters:: columnNames – The column names corresponding to the written table(s).

public ArrowIPCWriterOptions build()#