com.google.cloud.bigquery.HivePartitioningOptions Maven / Gradle / Ivy
Show all versions of google-cloud-bigquery Show documentation
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigquery;
import com.google.common.base.MoreObjects;
import java.util.List;
import java.util.Objects;
/** HivePartitioningOptions currently supported types include: AVRO, CSV, JSON, ORC and Parquet. */
public final class HivePartitioningOptions {
private final String mode;
private final Boolean requirePartitionFilter;
private final String sourceUriPrefix;
private final List fields;
public static final class Builder {
private String mode;
private Boolean requirePartitionFilter;
private String sourceUriPrefix;
private List fields;
private Builder() {}
private Builder(HivePartitioningOptions options) {
this.mode = options.mode;
this.requirePartitionFilter = options.requirePartitionFilter;
this.sourceUriPrefix = options.sourceUriPrefix;
this.fields = options.fields;
}
/**
* [Optional] 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.
*/
public Builder setMode(String mode) {
this.mode = mode;
return this;
}
/**
* [Optional] If set to true, queries over this table require a partition filter that can be
* used for partition elimination to be specified. Note that this field should only be true when
* creating a permanent external table or querying a temporary external table. Hive-partitioned
* loads with requirePartitionFilter explicitly set to true will fail.
*/
public Builder setRequirePartitionFilter(Boolean requirePartitionFilter) {
this.requirePartitionFilter = requirePartitionFilter;
return this;
}
/**
* [Optional] 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).
*/
public Builder setSourceUriPrefix(String sourceUriPrefix) {
this.sourceUriPrefix = sourceUriPrefix;
return this;
}
/**
* [Output-only] For permanent external tables, this field is populated with the hive partition
* keys in the order they were inferred.
*
* The types of the partition keys can be deduced by checking the table schema (which will
* include the partition keys). Not every API will populate this field in the output. For
* example, Tables.Get will populate it, but Tables.List will not contain this field.
*/
public Builder setFields(List fields) {
this.fields = fields;
return this;
}
/** Creates a {@link HivePartitioningOptions} object. */
public HivePartitioningOptions build() {
return new HivePartitioningOptions(this);
}
}
private HivePartitioningOptions(Builder builder) {
this.mode = builder.mode;
this.requirePartitionFilter = builder.requirePartitionFilter;
this.sourceUriPrefix = builder.sourceUriPrefix;
this.fields = builder.fields;
}
/* Returns the mode of hive partitioning */
public String getMode() {
return mode;
}
/**
* Returns true if a partition filter (that can be used for partition elimination) is required for
* queries over this table.
*/
public Boolean getRequirePartitionFilter() {
return requirePartitionFilter;
}
/* Returns the sourceUriPrefix of hive partitioning */
public String getSourceUriPrefix() {
return sourceUriPrefix;
}
/* Returns the fields of hive partitioning */
public List getFields() {
return fields;
}
/** Returns a builder for the {@link HivePartitioningOptions} object. */
public Builder toBuilder() {
return new Builder(this);
}
/** Returns a builder for the {@link HivePartitioningOptions} object. */
public static Builder newBuilder() {
return new Builder();
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("mode", mode)
.add("requirePartitionFilter", requirePartitionFilter)
.add("sourceUriPrefix", sourceUriPrefix)
.toString();
}
@Override
public boolean equals(Object obj) {
return obj == this
|| obj != null
&& obj.getClass().equals(HivePartitioningOptions.class)
&& Objects.equals(mode, ((HivePartitioningOptions) obj).getMode())
&& Objects.equals(
requirePartitionFilter, ((HivePartitioningOptions) obj).getRequirePartitionFilter())
&& Objects.equals(sourceUriPrefix, ((HivePartitioningOptions) obj).getSourceUriPrefix())
&& Objects.equals(fields, ((HivePartitioningOptions) obj).getFields());
}
@Override
public int hashCode() {
return Objects.hash(mode, sourceUriPrefix, fields);
}
com.google.api.services.bigquery.model.HivePartitioningOptions toPb() {
com.google.api.services.bigquery.model.HivePartitioningOptions options =
new com.google.api.services.bigquery.model.HivePartitioningOptions();
options.setMode(mode);
options.setRequirePartitionFilter(requirePartitionFilter);
options.setSourceUriPrefix(sourceUriPrefix);
options.setFields(fields);
return options;
}
static HivePartitioningOptions fromPb(
com.google.api.services.bigquery.model.HivePartitioningOptions options) {
Builder builder = newBuilder();
if (options.getMode() != null) {
builder.setMode(options.getMode());
}
if (options.getRequirePartitionFilter() != null) {
builder.setRequirePartitionFilter(options.getRequirePartitionFilter());
}
if (options.getSourceUriPrefix() != null) {
builder.setSourceUriPrefix(options.getSourceUriPrefix());
}
if (options.getFields() != null) {
builder.setFields(options.getFields());
}
return builder.build();
}
}