NYT::TFormatHints Class Reference

Options that control how C++ objects represent table rows when reading or writing a table. More...

#include <client_method_options.h>

Public Member Functions
TSelf &	SkipNullValuesForTNode (bool)
	Whether to skip null values.
TSelf &	EnableStringToAllConversion (bool)
	Whether to convert string to numeric and boolean types (e.g. "42u" -> 42u, "false" -> false) when writing to schemaful table.
TSelf &	EnableAllToStringConversion (bool)
	Whether to convert numeric and boolean types to string (e.g., 3.14 -> "3.14", true -> "true") when writing to schemaful table.
TSelf &	EnableIntegralTypeConversion (bool)
	Whether to convert uint64 <-> int64 when writing to schemaful table.
TSelf &	EnableIntegralToDoubleConversion (bool)
	Whether to convert uint64 and int64 to double (e.g. 42 -> 42.0) when writing to schemaful table.
TSelf &	EnableTypeConversion (bool)
	Shortcut for enabling all type conversions.
TSelf &	ComplexTypeMode (EComplexTypeMode)
	Controls how complex types are represented in TNode or yson-strings.
TSelf &	SkiffRowHints (TSkiffRowHints)
	Allow to use any meta-information for creating skiff schema and parser for reading ISkiffRow.
void	Merge (const TFormatHints &patch)
	Apply the patch to the fields.

Detailed Description

Options that control how C++ objects represent table rows when reading or writing a table.

Member Function Documentation

ComplexTypeMode()

TSelf & NYT::TFormatHints::ComplexTypeMode

(

EComplexTypeMode

)

Controls how complex types are represented in TNode or yson-strings.

See also

https://ytsaurus.tech/docs/en/user-guide/storage/data-types#yson

EnableIntegralTypeConversion()

TSelf & NYT::TFormatHints::EnableIntegralTypeConversion

(

bool

)

Whether to convert uint64 <-> int64 when writing to schemaful table.

On overflow the corresponding error with be raised.

This options is enabled by default.

Merge()

void NYT::TFormatHints::Merge

(

const TFormatHints &

patch

)

Apply the patch to the fields.

Non-default and non-empty values replace the default and empty ones.

SkipNullValuesForTNode()

TSelf & NYT::TFormatHints::SkipNullValuesForTNode

(

bool

)

Whether to skip null values.

When set to true TNode doesn't contain null column values (e.g. corresponding keys will be missing instead of containing null value).

Only meaningful for TNode representation.

Useful for sparse tables which have many columns in schema but only few columns are set in any row.

---

The documentation for this class was generated from the following file:

• yt/cpp/mapreduce/interface/client_method_options.h