google_bigquery_api::HivePartitioningOptions Class Reference

#include <hive_partitioning_options.h>

Inheritance diagram for google_bigquery_api::HivePartitioningOptions:

Public Member Functions
	HivePartitioningOptions (const Json::Value &storage)
	HivePartitioningOptions (Json::Value *storage)
virtual	~HivePartitioningOptions ()
const StringPiece	GetTypeName () const
bool	has_mode () const
void	clear_mode ()
const StringPiece	get_mode () const
void	set_mode (const StringPiece &value)
bool	has_source_uri_prefix () const
void	clear_source_uri_prefix ()
const StringPiece	get_source_uri_prefix () const
void	set_source_uri_prefix (const StringPiece &value)

Static Public Member Functions
static HivePartitioningOptions *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

HivePartitioningOptions() [1/2]

google_bigquery_api::HivePartitioningOptions::HivePartitioningOptions ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

HivePartitioningOptions() [2/2]

google_bigquery_api::HivePartitioningOptions::HivePartitioningOptions ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~HivePartitioningOptions()

google_bigquery_api::HivePartitioningOptions::~HivePartitioningOptions ( )

virtual

Standard destructor.

Member Function Documentation

clear_mode()

void google_bigquery_api::HivePartitioningOptions::clear_mode ( )

inline

Clears the 'mode' attribute.

clear_source_uri_prefix()

void google_bigquery_api::HivePartitioningOptions::clear_source_uri_prefix ( )

inline

Clears the 'sourceUriPrefix' attribute.

get_mode()

const StringPiece google_bigquery_api::HivePartitioningOptions::get_mode ( ) const

inline

Get the value of the 'mode' attribute.

get_source_uri_prefix()

const StringPiece google_bigquery_api::HivePartitioningOptions::get_source_uri_prefix ( ) const

inline

Get the value of the 'sourceUriPrefix' attribute.

GetTypeName()

const StringPiece google_bigquery_api::HivePartitioningOptions::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_bigquery_api::HivePartitioningOptions

has_mode()

bool google_bigquery_api::HivePartitioningOptions::has_mode ( ) const

inline

Determine if the 'mode' attribute was set.

Returns

true if the 'mode' attribute was set.

has_source_uri_prefix()

bool google_bigquery_api::HivePartitioningOptions::has_source_uri_prefix ( ) const

inline

Determine if the 'sourceUriPrefix' attribute was set.

Returns

true if the 'sourceUriPrefix' attribute was set.

New()

HivePartitioningOptions * google_bigquery_api::HivePartitioningOptions::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_mode()

void google_bigquery_api::HivePartitioningOptions::set_mode ( const StringPiece &  value )

inline

Change the 'mode' attribute.

[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

Parameters

[in]

value

The new value.

set_source_uri_prefix()

void google_bigquery_api::HivePartitioningOptions::set_source_uri_prefix ( const StringPiece &  value )

inline

Change the 'sourceUriPrefix' attribute.

[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

Parameters

[in]

value

The new value.

---

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

• google/bigquery_api/hive_partitioning_options.h
• google/bigquery_api/hive_partitioning_options.cc