Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1601,16 +1601,6 @@ TableResult listTableData(
* }
* }</pre>
*
* This method supports query-related preview features via environmental variables (enabled by
* setting the {@code QUERY_PREVIEW_ENABLED} environment variable to "TRUE"). Specifically, this
* method supports:
*
* <ul>
* <li><b>Stateless queries</b>: query execution without corresponding job metadata
* </ul>
*
* The behaviour of these preview features is controlled by the bigquery service as well
*
* @throws BigQueryException upon failure
* @throws InterruptedException if the current thread gets interrupted while waiting for the query
* to complete
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,11 @@

/**
* Google BigQuery Dataset information. A dataset is a grouping mechanism that holds zero or more
* tables. Datasets are the lowest level unit of access control; you cannot control access at the
* table level.
* tables. Access controls can be configured at the dataset level as well as on individual resources
* such as tables and views.
*
* @see <a href="https://docs.cloud.google.com/bigquery/docs/control-access-to-resources-iam">
* Control access to resources with IAM</a>
* @see <a href="https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects#datasets">
* Managing Jobs, Datasets, and Projects</a>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ public List<BigQueryError> getErrorsFor(long index) {
}

/**
* Returns {@code true} if no row insertion failed, {@code false} otherwise. If {@code false}
* {@link #getInsertErrors()} returns an empty map.
* Returns {@code true} if one or more row insertions failed, {@code false} otherwise. If {@code
* false}, {@link #getInsertErrors()} returns an empty map.
*/
public boolean hasErrors() {
return !insertErrors.isEmpty();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ interface Builder {
* Sets whether BigQuery should allow extra values that are not represented in the table schema.
* If {@code true}, the extra values are ignored. If {@code false}, records with extra columns
* are treated as bad records, and if there are too many bad records, an invalid error is
* returned in the job result. By default unknown values are not allowed.
* returned in the job result. Defaults to {@code false} (unknown values are not allowed).
*/
Builder setIgnoreUnknownValues(Boolean ignoreUnknownValues);

Expand Down Expand Up @@ -193,9 +193,9 @@ interface Builder {

/**
* Returns whether BigQuery should allow extra values that are not represented in the table
* schema. If {@code true}, the extra values are ignored. If {@code true}, records with extra
* schema. If {@code true}, the extra values are ignored. If {@code false}, records with extra
* columns are treated as bad records, and if there are too many bad records, an invalid error is
* returned in the job result. By default unknown values are not allowed.
* returned in the job result. Defaults to {@code false} (unknown values are not allowed).
*/
Boolean ignoreUnknownValues();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,8 @@
* calling {@link #of(Object, StandardSQLTypeName)} with the value and a particular
* StandardSQLTypeName enum value.
*
* <p>Struct parameters are currently not supported.
* <p>Use {@link #array(Object[], StandardSQLTypeName)} for array parameters and {@link
* #struct(Map)} for struct parameters.
*/
@AutoValue
public abstract class QueryParameterValue implements Serializable {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,21 @@
import java.io.Serializable;
import javax.annotation.Nullable;

/**
* Represents a BigQuery {@code RANGE} value, which defines a contiguous range between two {@code
* DATE}, {@code DATETIME}, or {@code TIMESTAMP} bounds.
*
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/data-types#range_type">BigQuery
* Range type</a>
*/
@AutoValue
public abstract class Range implements Serializable {
private static final long serialVersionUID = 1L;

/** Returns the start value of the range. A null value represents an unbounded start. */
public FieldValue getStart() {
// The supported Range types [DATE, TIME, TIMESTAMP] are all Attribute.PRIMITIVE.
// The supported Range types [DATE, DATETIME, TIMESTAMP] are all Attribute.PRIMITIVE.
return FieldValue.of(Attribute.PRIMITIVE, getStartInner());
}

Expand All @@ -38,7 +46,7 @@ public FieldValue getStart() {

/** Returns the end value of the range. A null value represents an unbounded end. */
public FieldValue getEnd() {
// The supported Range types [DATE, TIME, TIMESTAMP] are all Attribute.PRIMITIVE.
// The supported Range types [DATE, DATETIME, TIMESTAMP] are all Attribute.PRIMITIVE.
return FieldValue.of(Attribute.PRIMITIVE, getEndInner());
}

Expand Down Expand Up @@ -96,7 +104,11 @@ public static Range of(String value) throws IllegalArgumentException {
* Creates an instance of {@code Range} from a string representation.
*
* <p>The expected string format is: "[start, end)", where start and end are string format of
* [DATE, TIME, TIMESTAMP].
* [DATE, DATETIME, TIMESTAMP].
*
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/reference/standard-sql/data-types#range_type">BigQuery
* Range type</a>
*/
public static Range of(String value, FieldElementType type) throws IllegalArgumentException {
checkNotNull(value);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,12 @@ public abstract static class Builder {
/**
* Sets the labels applied to this table.
*
* <p>Unstable, because labels are <a
* href="https://cloud.google.com/bigquery/docs/reference/rest/v2/tables">experimental</a>.
*
* <p>When used with {@link BigQuery#update(TableInfo, TableOption...)}, setting {@code labels}
* to {@code null} removes all labels; otherwise all keys that are mapped to {@code null} values
* are removed and other keys are updated to their respective values.
*
* @see <a href="https://docs.cloud.google.com/bigquery/docs/labels-intro">Introduction to
* labels</a>
*/
@BetaApi
public abstract Builder setLabels(Map<String, String> labels);
Expand Down Expand Up @@ -619,8 +619,8 @@ public BigInteger getNumRows() {
/**
* Return a map for labels applied to the table.
*
* <p>Unstable, because labels are <a
* href="https://cloud.google.com/bigquery/docs/reference/rest/v2/tables">experimental</a>.
* @see <a href="https://docs.cloud.google.com/bigquery/docs/labels-intro">Introduction to
* labels</a>
*/
@BetaApi
public Map<String, String> getLabels() {
Expand Down
Loading