Feather

Syntax

extractSchema(filePath)

Details

Get the schema of a Feature file and return a table containing the following three columns:

1. name: Column names
2. type: Data type of Arrow
3. DolphinDBType: Data type of DolphinDB

Note: If the value of a cell in column DolphinDBType is VOID, it indicates that the corresponding data type in Arrow cannot be converted.

Parameters

• filePath: A STRING scalar indicating the Feather file path.

Examples

feather::extractSchema("path/to/data.feather");
feather::extractSchema("path/to/data.compressed.feather");

Syntax

load(filePath, [columns])

Details

Load a Feather file to a DolphinDB in-memory table. Regarding data type conversion, see "Data Type Mappings".

Note:

• Since the minimum of DolphinDB integral type is a NULL character, the minimum of Arrow int8, int16, int32, and int64 cannot be imported into DolphinDB.
• The infinities and NaNs (not a number) of floating-point numbers are converted to NULL values in DolphinDB.

Parameters

• filePath: A STRING scalar indicating the Feather file path.
• columns (optional): A STRING vector indicating the name of the columns to be loaded.

Examples

table = feather::load("path/to/data.feather");
table_part = feather::load("path/to/data.feather", [ "col1_name","col2_name"]);

Syntax

save(table, filePath, [compressMethod], [compressionLevel])

Details

Parameters

• table: The table to be exported.
• filePath: A STRING scalar indicating the Feather file path.
• compression (optional): A STRING scalar indicating the following three compression methods: "uncompressed", "lz4", and "zstd" (case insensitive). The default is "lz4".
• compressionLevel (optional): An integer specifying the compression level. It is only effective when the parameter compression is set to "zstd".

Examples

feather::save(table, "path/to/save/data.feather");
feather::save(table, "path/to/save/data.feather", "lz4");
feather::save(table, "path/to/save/data.feather", "zstd", 2);

The following is the data type mappings when a Feather file is imported to DolphinDB:

The following Arrow types are not supported for conversion: binary, fixed_size_binary, half_float, timestamp(us), time64(us), interval_months, interval_day_time, decimal128, decimal, decimal256, list, struct, sparse_union, dense_union, dictionary, map, extension, fixed_size_list, large_string, large_binary, large_list, interval_month_day_nano, max_id.

The following is the data type mappings when exporting data from DolphinDB to a Feather file:

The following DolphinDB data types are not supported for conversion: MINUTE, MONTH, DATETIME, UUID, FUNCTIONDEF, HANDLE, CODE, DATASOURCE, RESOURCE, ANY, COMPRESS, ANY DICTIONARY, DATEHOUR, IPADDR, INT128, BLOB, COMPLEX, POINT, DURATION.

Note:

You may encounter some problems when reading Feather files using Python.

Scenario 1: The error Value XXXXXXXXXXXXX has non-zero nanoseconds is raised when reading the Feather file that contains data of type time64(ns) using pyarrow.feather.read_feather(). When a table is converted to a DataFrame, the time64(ns) type is converted to the datetime.time type, which does not support temporal data in nanoseconds.

Solution: It is recommended to read with function pyarrow.feather.read_table().

Scenario 2: Use pyarrow.feather.read_feather() to read Feather files that contain null integer columns will convert the integer columns to floating point types.

Solution: It is recommended to read Feather files into the pyarrow table and convert the data type by specifying types_mapper.

pa_table = feather.read_table("path/to/feather_file")
df = pa_table.to_pandas(types_mapper={pa.int64(): pd.Int64Dtype()}.get)